FreeRTOS
xStreamBufferBytesAvailable() is only used within FreeRTOS.
 
Symbols
loading...
Files
loading...
CodeScopeSTM32 Libraries and SamplesFreeRTOSxStreamBufferBytesAvailable()

xStreamBufferBytesAvailable() function

size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer );
Queries a stream buffer to see how much data it contains, which is equal to the number of bytes that can be read from the stream buffer before the stream buffer would be empty.

Syntax

size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;
Implemented in stream_buffer.c:494

Arguments

xStreamBuffer

The handle of the stream buffer being queried.

Return value

The number of bytes that can be read from the stream buffer before the stream buffer would be empty.

References

LocationReferrerText
stream_buffer.c:494
size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer )
stream_buffer.h:718
size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer ) PRIVILEGED_FUNCTION;
mpu_wrappers.c:1309MPU_xStreamBufferBytesAvailable()
xReturn = xStreamBufferBytesAvailable( xStreamBuffer );

Call Tree

Functions calling xStreamBufferBytesAvailable()
Functions called by xStreamBufferBytesAvailable()
all items filtered out
xStreamBufferBytesAvailable()
all items filtered out
Data read by xStreamBufferBytesAvailable()
Data written by xStreamBufferBytesAvailable()
xStreamBufferBytesAvailable()::pxStreamBuffer
xStreamBufferBytesAvailable()::xReturn
all items filtered out
xStreamBufferBytesAvailable()
xStreamBufferBytesAvailable()::xReturn
all items filtered out
Type of xStreamBufferBytesAvailable()
xStreamBufferBytesAvailable()
size_t
all items filtered out