xMessageBufferIsFull macro

Tests to see if a message buffer 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.

Syntax

Show:

Summary

Declaration

from message_buffer.h:650

#define xMessageBufferIsFull( xMessageBuffer ) \ xStreamBufferIsFull( xMessageBuffer )

Arguments

Argument

Description

xMessageBuffer

The handle of the message buffer being queried.

Return value

If the message buffer referenced by xMessageBuffer is full then pdTRUE is returned. Otherwise pdFALSE is returned.

References

Code

Location

#define xMessageBufferIsFull( xMessageBuffer ) \

message_buffer.h:650

xMessageBufferIsFull macro

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle