Quality RTOS & Embedded Software

  Real time embedded FreeRTOS RSS feed  

xStreamBufferSpacesAvailable()
[RTOS Stream Buffer API]


stream_buffer.h

size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer );

Queries a stream buffer to see how much free space it contains, which is equal to the amount of data that can be sent to the stream buffer before it is full.

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:
The number of bytes that can be written to the stream buffer before the stream buffer would be full.





Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.