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.”

KernelinsideStream buffers

Updated Jul 2025

xStreamBufferIsEmpty()

[RTOS Stream Buffer API]

stream_buffer.h

1BaseType_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.