xStreamBufferIsEmpty()
[RTOS Stream Buffer API]

stream_buffer.h

BaseType_t xStreamBufferIsEmpty( StreamBufferHandle_t xStreamBuffer );

Queries a stream buffer to see if it is empty. A stream buffer is empty if it does not contain any data.

Stream buffer functionality is enabled by including the FreeRTOS/source/stream_buffer.c source file in the build.

Parameters:

xStreamBuffer

The handle of the stream buffer being queried.

Returns:

If the stream buffer is empty then pdTRUE is returned. Otherwise pdFALSE is returned.