message_buffer.h
BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer );
Queries a message buffer to see if it is full.
A message buffer is full if it cannot accept any more messages, of any size,
until space is made available by a message being removed from the message buffer.
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 full then pdTRUE is returned. Otherwise
pdFALSE is returned.
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.
