# 环形队列缓冲

**Repository Path**: mathigeo/ring-queue

## Basic Information

- **Project Name**: 环形队列缓冲
- **Description**: 循环队列c语言简单实现，并用到了stm32的串口上面
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 4
- **Created**: 2022-10-23
- **Last Updated**: 2024-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ringQueue

#### 介绍
循环队列c语言简单实现，可以用来作为串口的缓冲，解决数据大批传送单片机处理不过来导致丢包的问题

#### 软件架构
软件架构说明


#### 安装教程

1.  把ringQueue.c,ringQueue.h放入工程,初始化
*定义全局,推荐在对应的.c*
```
//环形缓冲结构体
RQ uart1_que;
//环形缓冲
uint8_t uart1_buf[RING_BUF_SIZE];
```
*初始化段加入以下*

```
//初始化队列
RQ_init(&uart1_que,uart1_buf,RING_BUF_SIZE);
```
2.  在串口(或IIC,SPI等)中断里面判断队列不满的情况下入队
```
/*串口中断服务函数中*/
if(!RQ_isFull(&uart1_que))
{
    /*temp为串口接收到的数据*/
    RQ_enQueue(&uart1_que,temp);
}
```
3.  在其它的地方逐个出队处理直到队列为空
```
/*程序其它对速度要求不高的地方，比如main里面*/
while(!RQ_isEmpty(&uart1_que))
{
    temp = RQ_deQueue(&uart1_que);
    /*在这里处理...*/
}
```

#### 使用说明

1.  可以调整QING_QUEUE_SIZE从而调整队列大小
```
/**
 * @brief 队列初始化
 * @param queue 队列指针
 * @param size 数据存储区大小
 * @param base 数据存储区首地址
 * @retval None
 * @note 一定要为队列结构体分配内存
*/
void RQ_init(RQ *queue,uint8_t *base,uint32_t size);
```
2.  可以使用USE_MACRO_SPEED_UP调为1从而使程序加速(减少函数调用开销)
```
/*使用宏加速(用函数会有调用开销)*/
#define USE_INLINE_SPEED_UP  1
```
3.  数据入队之前一定要判断是否已满(满了就不能入队了)，出队之前一定要判断是否为空(空了就不能出队了)

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)