xMessageBufferNextLengthBytes

Collaboration diagram for xMessageBufferNextLengthBytes:

message_buffer.h

size_t xMessageBufferNextLengthBytes( MessageBufferHandle_t xMessageBuffer );

Returns the length (in bytes) of the next message in a message buffer. Useful if xMessageBufferReceive() returned 0 because the size of the buffer passed into xMessageBufferReceive() was too small to hold the next message.

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

Parameters

xMessageBuffer

The handle of the message buffer being queried.

Returns

The length (in bytes) of the next message in the message buffer, or 0 if the message buffer is empty.