wangzhengquan
2020-07-14 8b4ddf10e71e1c8fabd33c72b282f7da65ff682f
queue/include/shm_queue_wrapper.h
@@ -9,66 +9,102 @@
#ifdef __cplusplus
extern "C" {
#endif
/**
 * 初始化共享内存
 * @size 共享内存大小
 *
 */
void shm_init(int size);
/**
 * 销毁共享内存
 * 整个进程退出时需要执行这个方法,该方法首先会检查是否还有其他进程在使用该共享内存,如果还有其他进程在使用就只是detach,如果没有其他进程在使用则销毁整块内存。
 */
void shm_destroy();
 
//移除不包含在keys中的队列
void shm_remove_queues_exclue(void *keys, int length);
/**
 * 初始化
 * 创建队列
 * @ shmqueue 
 * @ key 标识共享队列的唯一key
 * @ key 标识共享队列的唯一标识, key是一个指针里面存储了key的值, 如果key的值为-1系统会自动分配一个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) ;
/**
 * 是否已满
 * @return 1是, 0否
 */
int shmqueue_full(void *shmqueue);
int shmqueue_full(void * _shmqueue);
/**
 * 是否为空
 * @return 1是, 0否
 */
int shmqueue_empty(void *shmqueue);
int shmqueue_empty(void * _shmqueue) ;
/**
 * 入队, 队列满时等待
 * 入队, 队列满时等待.
 * @return 1 入队成功, 0 入队失败
 */
int shmqueue_push(void *shmqueue, void *src_ele);
int shmqueue_push(void * _shmqueue, void *src, int size);
/**
 * 入队, 队列满时立即返回
 * 入队, 队列满时立即返回.
 * @return 1 入队成功, 0 入队失败
 */
int shmqueue_push_nowait(void *shmqueue, void *src_ele);
int shmqueue_push_nowait(void * _shmqueue, void *src, int size) ;
/**
 * 入队, 指定时间内入队不成功就返回
 * @sec 秒
 * @nsec 纳秒
 * @return 1 入队成功, 0 入队失败
 */
int shmqueue_push_timeout(void *shmqueue, void *src_ele, struct timespec * timeout);
int shmqueue_push_timeout(void * _shmqueue, void *src, int size,  int sec, int nsec) ;
/**
 * 出队, 队列空时等待
 * @return 1 出队成功, 0出队失败
 */
int shmqueue_pop(void *shmqueue, void *dest_ele);
int shmqueue_pop(void * _shmqueue, void **dest, int *size);
/**
 * 出队, 队列空时立即返回
 * @return 1 出队成功, 0出队失败
 */
int shmqueue_pop_nowait(void *shmqueue, void *dest_ele);
int shmqueue_pop_nowait(void * _shmqueue, void **dest, int *size) ;
/**
 * 出队, 指定时间内出队不成功就返回
 * @sec秒
 * @nsec纳秒
 * @return 1 出队成功, 0出队失败
 */
int shmqueue_pop_timeout(void *shmqueue, void *dest_ele, struct timespec * timeout);
int shmqueue_pop_timeout(void * _shmqueue, void **dest, int *size, int sec, int nsec);
/**
 * 释放出队分配的内存
 */
void shmqueue_free(void *ptr);
#ifdef __cplusplus
}