Quality RTOS & Embedded Software

KERNEL

xMessageBufferIsEmpty()
[RTOS Message Buffer API]


message_buffer.h

BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer );

Queries a message buffer to see if it is empty. A message buffer is empty if it does not contain any messages.

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 being queried.
Returns:
If the message buffer is empty then pdTRUE is returned. Otherwise pdFALSE is returned.





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