update

wangzhengquan

2020-07-09 91f003aac4c95f4d2a2fc0782c9bea9d484b6919

 README.md

@@ -1,4 +1,131 @@
## cppShmqueue
## 实例

Cpp版本的共享内存队列库
```
#include "shm_queue_wrapper.h"
#include "mm.h"

typedef struct message_t
{
   char method[20];
   int code;
	
} message_t;

void test1() {
   unsigned int i = 0;
   int key = 2;
 
   size_t qsize = 16;
     shmqueue_t queue;
   shmqueue_init(&queue, 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)) {
           printf("push:%d %s\n", item.code, item.method );
      }
   }
	 
   struct timespec timeout = {1, 0};

   i = 0;
   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);
}

 
int main () {
   test1();

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

```

/**
 * 初始化
 * @ shmqueue 
 * @ key 标识共享队列的唯一key
 * @ queue_size 队列大小
 * @ ele_size 队列中元素大小
 */
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;
}



/**
 * 销毁
*/
inline void shmqueue_destroy(shmqueue_t *shmqueue) {
   delete (SHMQueue<ele_t> *)shmqueue->mqueue;
}

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

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

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

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

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

/**
 * 入队, 指定时间内入对不成功就返回
 */
inline int shmqueue_push_timeout(shmqueue_t *shmqueue, void *src_ele, struct timespec * timeout) 
/**
 * 出队, 队列空时等待
 */
inline int shmqueue_pop(shmqueue_t *shmqueue, void *dest_ele)  

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

```