#ifndef __SHM_QUEUE_WRAPPER_H__
#define __SHM_QUEUE_WRAPPER_H__

#include "usg_common.h"
#include "usg_typedef.h"
#include "shm_queue.h"
#include "shm_allocator.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * 初始化
 * @ shmqueue 
 * @ key 标识共享队列的唯一key
 * @ queue_size 队列大小 , 这个值必须是2的指数即 1, 2, 4, 8, 16 等
 * @ ele_size 队列中元素大小, 这个值不能超过512，当然如果需要可以调整这个最大限制
 */
void* shmqueue_init(int key, int queue_size, int ele_size);
/**
 * 销毁
*/
void shmqueue_destroy(void *shmqueue);
/**
 * 队列元素的个数
 */
uint32_t shmqueue_size(void *shmqueue);
/**
 * 是否已满
 */
int shmqueue_full(void *shmqueue);

/**
 * 是否为空
 */
int shmqueue_empty(void *shmqueue);

/**
 * 入队, 队列满时等待
 */
int shmqueue_push(void *shmqueue, void *src_ele);

/**
 * 入队, 队列满时立即返回
 */
int shmqueue_push_nowait(void *shmqueue, void *src_ele);

/**
 * 入队, 指定时间内入队不成功就返回
 */
int shmqueue_push_timeout(void *shmqueue, void *src_ele, struct timespec * timeout);

/**
 * 出队, 队列空时等待
 */
int shmqueue_pop(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);



#ifdef __cplusplus
}
#endif

#endif