Quality RTOS & Embedded Software

KERNEL
WHAT'S NEW
Featured FreeRTOS IoT Integrations:
Extended Maintenance Plan (EMP):
Delta Over-the-Air Updates:
December 2021 Releases:
FreeRTOS LTS libraries:

xStreamBufferBytesAvailable()
[RTOS Stream Buffer API]


stream_buffer.h

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.

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 read from the stream buffer before the stream buffer would be empty.





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