update

wangzhengquan

2020-07-14 e4ce347428a0d459c7561f7bb3e180f351c11a4f

 README.md

@@ -14,16 +14,15 @@
void test1() {
   unsigned int i = 0;
   int key = 2;
 
    // 
   size_t qsize = 16;
     shmqueue_t queue;
   shmqueue_init(&queue, key, qsize, sizeof(message_t));
   void * queue = shmqueue_init( key, qsize, sizeof(message_t));
   message_t item;
   // LockFreeQueue<struct Item> queue(16);
   for(i = 0; i < qsize; i++) {
      sprintf(item.method, "hello"); 
      item.code = i ; 
      if(shmqueue_push(&queue, (void *)&item)) {
      if(shmqueue_push(queue, (void *)&item)) {
           printf("push:%d %s\n", item.code, item.method );
      }
   }
@@ -31,101 +30,86 @@
   struct timespec timeout = {1, 0};

   i = 0;
   while((shmqueue_pop_timeout(&queue, (void *)&item, &timeout)) ) {
   while((shmqueue_pop_timeout(queue, (void *)&item, &timeout)) ) {
       printf("pop:%d %s\n", item.code, item.method );
      // cout <<  item.pic << endl;
       i++;
   }

   shmqueue_destroy(&queue);
   //销毁队列
   shmqueue_destroy(queue);
}

 
int main () {
   test1();

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

## 接口说明

```


/**
 * 初始化
 * @ shmqueue 
 * @ key 标识共享队列的唯一key
 * @ queue_size 队列大小
 * @ ele_size 队列中元素大小
 * @ queue_size 队列大小 , 这个值必须是2的指数即 1, 2, 4, 8, 16 等
 * @ ele_size 队列中元素大小, 这个值不能超过512，当然如果需要可以调整这个最大限制
 */
inline void shmqueue_init(shmqueue_t *shmqueue, int key, int queue_size, int ele_size) {
   if(ele_size > MAX_ELE_SIZE) {
      err_exit(0, "shmqueue_init 元素大小超过设计的最大大小");
   }
   SHMQueue<ele_t> *queue = new SHMQueue<ele_t>(key, queue_size);
   shmqueue->mqueue = (void *)queue;
   shmqueue->ele_size = ele_size;
}



void* shmqueue_init(int key, int queue_size, int ele_size);
/**
 * 销毁
*/
inline void shmqueue_destroy(shmqueue_t *shmqueue) {
   delete (SHMQueue<ele_t> *)shmqueue->mqueue;
}

void shmqueue_destroy(void *shmqueue);
/**
 * 队列元素的个数
 */
inline uint32_t shmqueue_size(shmqueue_t *shmqueue) {
   return ((SHMQueue<ele_t> *)(shmqueue->mqueue))->size();
}

uint32_t shmqueue_size(void *shmqueue);
/**
 * 是否已满
 */
inline int shmqueue_full(shmqueue_t *shmqueue) {
   return ((SHMQueue<ele_t> *)(shmqueue->mqueue))->full();
}
int shmqueue_full(void *shmqueue);

/**
 * 是否为空
 */
inline int shmqueue_empty(shmqueue_t *shmqueue) {
   return ((SHMQueue<ele_t> *)(shmqueue->mqueue))->empty();
}
int shmqueue_empty(void *shmqueue);

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

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

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

/**
 * 出队, 队列空时等待
 */
inline int shmqueue_pop(shmqueue_t *shmqueue, void *dest_ele)  
int shmqueue_pop(void *shmqueue, void *dest_ele);

/**
 * 出队, 队列空时立即返回
 */
inline int shmqueue_pop_nowait(shmqueue_t *shmqueue, void *dest_ele) 
int shmqueue_pop_nowait(void *shmqueue, void *dest_ele);

/**
 * 出队, 指定时间内出对不成功就返回
 * 出队, 指定时间内出队不成功就返回
 */
inline int shmqueue_pop_timeout(shmqueue_t *shmqueue, void *dest_ele, struct timespec * timeout)
int shmqueue_pop_timeout(void *shmqueue, void *dest_ele, struct timespec * timeout);

```