Collaboration diagram for xStreamBufferIsFull:

long BaseType_t

Definition portmacro.h:59

struct StreamBufferDef_t * StreamBufferHandle_t

Definition stream_buffer.h:79

BaseType_t xStreamBufferIsFull(StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

Queries a stream buffer to see if it is full. A stream buffer is full if it does not have any free space, and therefore cannot accept any more data.

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

Parameters

xStreamBuffer The handle of the stream buffer being queried.

Returns: If the stream buffer is full then pdTRUE is returned. Otherwise pdFALSE is returned.