Collaboration diagram for xStreamBufferIsEmpty:

long BaseType_t

Definition portmacro.h:59

struct StreamBufferDef_t * StreamBufferHandle_t

Definition stream_buffer.h:79

BaseType_t xStreamBufferIsEmpty(StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

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

configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for xStreamBufferIsEmpty() to be available.

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.