fix from 3.1 first commit

fujuntang

2021-08-11 68d23225a38a35f1325eb39fa4ed5a005d5de473

 README.md

@@ -1,121 +1,12 @@
<<<<<<< HEAD
## 实例

```
#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;
   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)) {
           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;
}
#  编译
 
```
 ./build.sh release
```

## 接口说明

#  生成API文档
 
```


/**
 * 初始化
 * @ 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);

```
=======
## softbus

shm的通讯库
>>>>>>> dd08a8134dea74ac30213c1b8580bff34ee7095b

 ./build.sh doc
```