#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
/**
 * 初始化共享内存
 * @size 共享内存大小
 * 
 */
void shm_init(int size);

/**
 * 销毁共享内存
 * 整个进程退出时需要执行这个方法，该方法首先会检查是否还有其他进程在使用该共享内存，如果还有其他进程在使用就只是detach,如果没有其他进程在使用则销毁整块内存。
 */
void shm_destroy();

/**
 * 创建队列
 * @ 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);
/**
 * 是否已满
 */
int shmqueue_full(void * _shmqueue);

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

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

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

/**
 * 入队, 指定时间内入队不成功就返回
 * timespec {sec秒, nsec纳秒}
 */
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_nowait(void * _shmqueue, void *dest_ele) ;

/**
 * 出队, 指定时间内出队不成功就返回
 */
int shmqueue_pop_timeout(void * _shmqueue, void *dest_ele, void * _timeout);

#ifdef __cplusplus
}
#endif

#endif