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.

xMessageBufferResetFromISR()
[RTOS Message Buffer API]


message_buffer.h

BaseType_t xMessageBufferResetFromISR( MessageBufferHandle_t xMessageBuffer );

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

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

Use xMessageBufferReset() to reset a message buffer from a task. Use xMessageBufferResetFromISR() to reset a message buffer from an interrupt service routine (ISR).

Message buffer functionality is enabled by including the FreeRTOS/source/stream_buffer.c source file in the build (as message buffers use stream buffers).

Parameters:

xMessageBuffer
The handle of the message buffer to reset.

Returns:

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

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