message_buffer.h File Reference

#include "stream_buffer.h"

Include dependency graph for message_buffer.h:

Go to the source code of this file.

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)
	message_buffer.h
#define	xMessageBufferIsFull(xMessageBuffer)
	message_buffer.h
#define	xMessageBufferIsEmpty(xMessageBuffer)
	message_buffer.h
#define	xMessageBufferReset(xMessageBuffer)
#define	xMessageBufferSpaceAvailable(xMessageBuffer)
#define	xMessageBufferSpacesAvailable(xMessageBuffer)
#define	xMessageBufferNextLengthBytes(xMessageBuffer)
#define	xMessageBufferSendCompletedFromISR(xMessageBuffer, pxHigherPriorityTaskWoken)
#define	xMessageBufferReceiveCompletedFromISR(xMessageBuffer, pxHigherPriorityTaskWoken)

Typedefs
typedef StreamBufferHandle_t	MessageBufferHandle_t
	Type by which message buffers are referenced.

Macro Definition Documentation

vMessageBufferDelete

#define vMessageBufferDelete

(

xMessageBuffer

)

Value:

    vStreamBufferDelete( 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.

Definition at line 693 of file message_buffer.h.

xMessageBufferCreate

#define xMessageBufferCreate

(

xBufferSizeBytes

)

Value:

    xStreamBufferGenericCreate( ( xBufferSizeBytes ), ( size_t ) 0, pdTRUE, NULL, NULL )

Definition at line 158 of file message_buffer.h.

xMessageBufferCreateStatic

#define xMessageBufferCreateStatic	(		xBufferSizeBytes,
			pucMessageBufferStorageArea,
			pxStaticMessageBuffer )

Value:

    xStreamBufferGenericCreateStatic( ( xBufferSizeBytes ), 0, pdTRUE, ( pucMessageBufferStorageArea ), ( pxStaticMessageBuffer ), NULL, NULL )

Definition at line 240 of file message_buffer.h.

xMessageBufferIsEmpty

#define xMessageBufferIsEmpty

(

xMessageBuffer

)

Value:

    xStreamBufferIsEmpty( 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.

Definition at line 728 of file message_buffer.h.

xMessageBufferIsFull

#define xMessageBufferIsFull

(

xMessageBuffer

)

Value:

    xStreamBufferIsFull( 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.

Definition at line 711 of file message_buffer.h.

xMessageBufferNextLengthBytes

#define xMessageBufferNextLengthBytes

(

xMessageBuffer

)

Value:

    xStreamBufferNextMessageLengthBytes( xMessageBuffer ) PRIVILEGED_FUNCTION;

Definition at line 797 of file message_buffer.h.

xMessageBufferReceive

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

Value:

    xStreamBufferReceive( ( xMessageBuffer ), ( pvRxData ), ( xBufferLengthBytes ), ( xTicksToWait ) )

Definition at line 570 of file message_buffer.h.

xMessageBufferReceiveCompletedFromISR

#define xMessageBufferReceiveCompletedFromISR	(		xMessageBuffer,
			pxHigherPriorityTaskWoken )

Value:

    xStreamBufferReceiveCompletedFromISR( ( xMessageBuffer ), ( pxHigherPriorityTaskWoken ) )

Definition at line 878 of file message_buffer.h.

xMessageBufferReceiveFromISR

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

Value:

    xStreamBufferReceiveFromISR( ( xMessageBuffer ), ( pvRxData ), ( xBufferLengthBytes ), ( pxHigherPriorityTaskWoken ) )

Definition at line 672 of file message_buffer.h.

xMessageBufferReset

#define xMessageBufferReset

(

xMessageBuffer

)

Value:

    xStreamBufferReset( xMessageBuffer )

Definition at line 752 of file message_buffer.h.

xMessageBufferSend

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

Value:

    xStreamBufferSend( ( xMessageBuffer ), ( pvTxData ), ( xDataLengthBytes ), ( xTicksToWait ) )

Definition at line 376 of file message_buffer.h.

xMessageBufferSendCompletedFromISR

#define xMessageBufferSendCompletedFromISR	(		xMessageBuffer,
			pxHigherPriorityTaskWoken )

Value:

    xStreamBufferSendCompletedFromISR( ( xMessageBuffer ), ( pxHigherPriorityTaskWoken ) )

Definition at line 837 of file message_buffer.h.

xMessageBufferSendFromISR

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

Value:

    xStreamBufferSendFromISR( ( xMessageBuffer ), ( pvTxData ), ( xDataLengthBytes ), ( pxHigherPriorityTaskWoken ) )

Definition at line 481 of file message_buffer.h.

xMessageBufferSpaceAvailable

#define xMessageBufferSpaceAvailable

(

xMessageBuffer

)

Value:

    xStreamBufferSpacesAvailable( xMessageBuffer )

Definition at line 775 of file message_buffer.h.

xMessageBufferSpacesAvailable

#define xMessageBufferSpacesAvailable

(

xMessageBuffer

)

Value:

    xStreamBufferSpacesAvailable( xMessageBuffer ) /* Corrects typo in original macro name. */

Definition at line 777 of file message_buffer.h.

Typedef Documentation

MessageBufferHandle_t

typedef StreamBufferHandle_t 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. Message buffer is essentially built as a stream buffer hence its handle is also set to same type as a stream buffer handle.

Definition at line 86 of file message_buffer.h.