Download FreeRTOS
 

Quality RTOS & Embedded Software

KERNEL
WHAT'S NEW
New FreeRTOS Long Term Support version released
Simplifying Authenticated Cloud Connectivity for Any Device.
Designing an energy efficient and cloud-connected IoT solution with CoAP.
Introducing FreeRTOS Kernel version 11.0.0:
FreeRTOS Roadmap and Code Contribution process.

xStreamBufferResetFromISR()
[RTOS Stream Buffer API]


stream_buffer.h

BaseType_t xStreamBufferResetFromISR( StreamBufferHandle_t xStreamBuffer );

An interrupt safe version of the xStreamBufferReset() API function.

Resets a stream buffer to its initial, empty, state. Any data that was in the stream buffer is discarded. A stream buffer can only be reset if there are no tasks blocked waiting to either send to or receive from the stream buffer.

Use xStreamBufferReset() to reset a stream buffer from a task. Use xStreamBufferResetFromISR() to reset a stream buffer from an interrupt service routine (ISR).

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 to reset.

Returns:

If the stream buffer is reset then pdPASS is returned. If there was a task blocked waiting to send to or read from the stream buffer then the stream buffer will not be reset and pdFAIL is returned.

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