wangzhengquan
2020-07-13 e1e97f1f98baf82efcd5825d7c7a7b4b1b2f2e40
queue/include/shm_queue_wrapper.h
@@ -11,62 +11,67 @@
#endif
/**
 * 初始化
 * 创建队列
 * @ shmqueue 
 * @ key 标识共享队列的唯一key
 * @ queue_size 队列大小 , 这个值必须是2的指数即 1, 2, 4, 8, 16 等
 * @ ele_size 队列中元素大小, 这个值不能超过512,当然如果需要可以调整这个最大限制
 * @ key 标识共享队列的唯一key, 如果key为空会自动分配一个key,如果key不会空会检查是否有重复绑定的情况, 然后绑定key.
 * @ queue_size 队列大小
 * @ ele_size 队列中元素大小
 */
void* shmqueue_init(int key, int queue_size, int ele_size);
void* shmqueue_create( int * key, int queue_size);
/**
 * 绑定key到队列,但是并不会创建队列。如果没有对应指定key的队列提示错误并返回空值
 */
void* shmqueue_attach(int key);
/**
 * 销毁
*/
void shmqueue_destroy(void *shmqueue);
void shmqueue_drop(void * _shmqueue) ;
/**
 * 队列元素的个数
 */
uint32_t shmqueue_size(void *shmqueue);
int shmqueue_size(void * _shmqueue);
/**
 * 是否已满
 */
int shmqueue_full(void *shmqueue);
int shmqueue_full(void * _shmqueue);
/**
 * 是否为空
 */
int shmqueue_empty(void *shmqueue);
int shmqueue_empty(void * _shmqueue) ;
/**
 * 入队, 队列满时等待
 */
int shmqueue_push(void *shmqueue, void *src_ele);
int shmqueue_push(void * _shmqueue, void *src_ele, int ele_size);
/**
 * 入队, 队列满时立即返回
 */
int shmqueue_push_nowait(void *shmqueue, void *src_ele);
int shmqueue_push_nowait(void * _shmqueue, void *src_ele, int ele_size) ;
/**
 * 入队, 指定时间内入队不成功就返回
 * timespec {sec秒, nsec纳秒}
 */
int shmqueue_push_timeout(void *shmqueue, void *src_ele, struct timespec * timeout);
int shmqueue_push_timeout(void * _shmqueue, void *src_ele, int ele_size, void * _timeout);
/**
 * 出队, 队列空时等待
 */
int shmqueue_pop(void *shmqueue, void *dest_ele);
int shmqueue_pop(void * _shmqueue, void *dest_ele);
/**
 * 出队, 队列空时立即返回
 */
int shmqueue_pop_nowait(void *shmqueue, void *dest_ele);
int shmqueue_pop_nowait(void * _shmqueue, void *dest_ele) ;
/**
 * 出队, 指定时间内出队不成功就返回
 */
int shmqueue_pop_timeout(void *shmqueue, void *dest_ele, struct timespec * timeout);
int shmqueue_pop_timeout(void * _shmqueue, void *dest_ele, void * _timeout);
#ifdef __cplusplus
}