Macros
#define	xMessageBufferCreate(xBufferSizeBytes)

#define	xMessageBufferCreateStatic(xBufferSizeBytes, pucMessageBufferStorageArea, pxStaticMessageBuffer)

#define	xMessageBufferSend(xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait)

#define	xMessageBufferSendFromISR(xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken)

#define	xMessageBufferReceive(xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait)

#define	xMessageBufferReceiveFromISR(xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken)

#define	vMessageBufferDelete(xMessageBuffer)

#define	xMessageBufferIsFull(xMessageBuffer)

#define	xMessageBufferIsEmpty(xMessageBuffer)

#define	xMessageBufferReset(xMessageBuffer)

#define	xMessageBufferSpaceAvailable(xMessageBuffer)

#define	xMessageBufferSpacesAvailable(xMessageBuffer)

#define	xMessageBufferNextLengthBytes(xMessageBuffer)

#define	xMessageBufferSendCompletedFromISR(xMessageBuffer, pxHigherPriorityTaskWoken)

#define	xMessageBufferReceiveCompletedFromISR(xMessageBuffer, pxHigherPriorityTaskWoken)

Typedefs
typedef void *	MessageBufferHandle_t

Macro Definition Documentation

#define vMessageBufferDelete ( xMessageBuffer )

message_buffer.h

void vMessageBufferDelete( MessageBufferHandle_t xMessageBuffer );

Deletes a message buffer that was previously created using a call to xMessageBufferCreate() or xMessageBufferCreateStatic(). If the message buffer was created using dynamic memory (that is, by xMessageBufferCreate()), then the allocated memory is freed.

A message buffer handle must not be used after the message buffer has been deleted.

Parameters

xMessageBuffer The handle of the message buffer to be deleted.

#define xMessageBufferCreate ( xBufferSizeBytes )

#define xMessageBufferCreateStatic	(	xBufferSizeBytes,
		pucMessageBufferStorageArea,
		pxStaticMessageBuffer
	)

#define xMessageBufferIsEmpty ( xMessageBuffer )

message_buffer.h

BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer ) );

Tests to see if a message buffer is empty (does not contain any messages).

Parameters

xMessageBuffer The handle of the message buffer being queried.

Returns: If the message buffer referenced by xMessageBuffer is empty then pdTRUE is returned. Otherwise pdFALSE is returned.

#define xMessageBufferIsFull ( xMessageBuffer )

message_buffer.h

BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer ) );

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.

Parameters

xMessageBuffer The handle of the message buffer being queried.

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

#define xMessageBufferNextLengthBytes ( xMessageBuffer )

#define xMessageBufferReceive	(	xMessageBuffer,
		pvRxData,
		xBufferLengthBytes,
		xTicksToWait
	)

#define xMessageBufferReceiveCompletedFromISR	(	xMessageBuffer,
		pxHigherPriorityTaskWoken
	)

#define xMessageBufferReceiveFromISR	(	xMessageBuffer,
		pvRxData,
		xBufferLengthBytes,
		pxHigherPriorityTaskWoken
	)

#define xMessageBufferReset ( xMessageBuffer )

#define xMessageBufferSend	(	xMessageBuffer,
		pvTxData,
		xDataLengthBytes,
		xTicksToWait
	)

#define xMessageBufferSendCompletedFromISR	(	xMessageBuffer,
		pxHigherPriorityTaskWoken
	)

#define xMessageBufferSendFromISR	(	xMessageBuffer,
		pvTxData,
		xDataLengthBytes,
		pxHigherPriorityTaskWoken
	)

#define xMessageBufferSpaceAvailable ( xMessageBuffer )

#define xMessageBufferSpacesAvailable ( xMessageBuffer )

Typedef Documentation

typedef void* MessageBufferHandle_t

Type by which message buffers are referenced. For example, a call to xMessageBufferCreate() returns an MessageBufferHandle_t variable that can then be used as a parameter to xMessageBufferSend(), xMessageBufferReceive(), etc.

Macros

Typedefs

Macro Definition Documentation

Typedef Documentation