#ifndef __SHM_QUEUE_WRAPPER_H__
#define __SHM_QUEUE_WRAPPER_H__

#include "usg_common.h"
#include "usg_typedef.h"


#ifdef __cplusplus
extern "C" {
#endif

 

/**
 * @depracate 已废弃不用
 * 移除不包含在keys中的队列
 */
void shm_remove_queues_exclude(void *keys, int length);
/**
 * 创建队列
 * @ shmqueue 
 * @ key 标识共享队列的唯一标识, key是一个指针里面存储了key的值， 如果key的值为-1系统会自动分配一个key值并把该key的值赋给key指针。如果key的值不会空会检查是否有重复绑定的情况, 有重复就报错没有就创建队列并绑定key.
 * @ queue_size 队列大小
 */
void* shmqueue_create( int * key, int queue_size);

/**
 * 绑定key到队列，但是并不会创建队列。如果没有对应指定key的队列提示错误并退出
 */
void* shmqueue_attach(int key) ;

/**
 * 销毁
*/
void shmqueue_drop(void * _shmqueue);

/**
 * 队列元素的个数
 */
int shmqueue_size(void * _shmqueue) ;

/**
 * 是否已满
 * @return 1是， 0否
 */
int shmqueue_full(void * _shmqueue);

/**
 * 是否为空
 * @return 1是， 0否
 */
int shmqueue_empty(void * _shmqueue) ;

/**
 * 入队, 队列满时等待.
 * @return 1 入队成功, 0 入队失败
 */
int shmqueue_push(void * _shmqueue, void *src, int size);

/**
 * 入队, 立刻返回
 * @return 1 入队成功, 0 入队失败
 */
int shmqueue_push_nowait(void * _shmqueue, void *src, int size) ;

/**
 * 入队, 指定时间内入队不成功就返回
 * @sec 秒
 * @nsec 纳秒
 * @return 1 入队成功, 0 入队失败
 */
int shmqueue_push_timeout(void * _shmqueue, void *src, int size,  int sec, int nsec) ;

/**
 * 出队, 队列空时等待
 * @return 1 出队成功， 0出队失败
 */
int shmqueue_pop(void * _shmqueue, void **dest, int *size);

/**
 * 出队, 立刻返回
 * @return 1 出队成功， 0出队失败
 */
int shmqueue_pop_nowait(void * _shmqueue, void **dest, int *size) ;

/**
 * 出队, 指定时间内出队不成功就返回
 * @sec秒
 * @nsec纳秒
 * @return 1 出队成功， 0出队失败
 */
int shmqueue_pop_timeout(void * _shmqueue, void **dest, int *size, int sec, int nsec);

/**
 * 释放出队分配的内存
 */
void shmqueue_free(void *ptr);

#ifdef __cplusplus
}
#endif

#endif