xStreamBufferReset()
[ RTOS 流缓冲区 API ]

stream_buffer.h

BaseType_t xStreamBufferReset( StreamBufferHandle_t xStreamBuffer );

将流缓冲区重置为其初始空状态。 任何在流缓冲区的数据 都将被丢弃。 只有当没有任务被阻塞以等待向流缓冲区发送或从流缓冲区接收时， 流缓冲区才能被重置 。

通过将 FreeRTOS/source/stream_buffer.c 源文件纳入构建中， 即可启用流缓冲区功能。

参数：

xStreamBuffer

正在重置的流缓冲区的句柄。

返回：

如果流缓冲区重置，则返回 pdPASS。 如果有 一个任务被阻塞，等待向流缓冲区发送或从流缓冲区读取， 那么流缓冲区将不会被重置，并返回 pdFAIL。