Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

KernelinsideMessage buffers

Updated Jun 2025

xMessageBufferIsFull()

[RTOS Message Buffer API]

message_buffer.h

1BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer );

Queries a message buffer to see if it is full. A message buffer is full if it cannot accept any more messages, of any size, until space is made available by a message being removed from the message buffer.

Message buffer functionality is enabled by including the FreeRTOS/source/stream_buffer.c source file in the build (as message buffers use stream buffers).

Parameters:

  • xMessageBuffer

    The handle of the message buffer being queried.

Returns:

If the message buffer is full then pdTRUE is returned. Otherwise pdFALSE is returned.