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

Typedefs
typedef StreamBufferHandle_t	MessageBufferHandle_t

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.

configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for vMessageBufferDelete() to be available.

Parameters

xMessageBuffer

The handle of the message buffer to be deleted.

xMessageBufferCreate

#define xMessageBufferCreate

(

xBufferSizeBytes

)

Value:

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

xMessageBufferCreateStatic

#define xMessageBufferCreateStatic	(		xBufferSizeBytes,
			pucMessageBufferStorageArea,
			pxStaticMessageBuffer )

Value:

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

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).

configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for xMessageBufferIsEmpty() to be available.

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.

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.

configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for xMessageBufferIsFull() to be available.

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.

xMessageBufferNextLengthBytes

#define xMessageBufferNextLengthBytes

(

xMessageBuffer

)

Value:

    xStreamBufferNextMessageLengthBytes( xMessageBuffer )

xMessageBufferReceive

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

Value:

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

xMessageBufferReceiveCompletedFromISR

#define xMessageBufferReceiveCompletedFromISR	(		xMessageBuffer,
			pxHigherPriorityTaskWoken )

Value:

    xStreamBufferReceiveCompletedFromISR( ( xMessageBuffer ), ( pxHigherPriorityTaskWoken ) )

xMessageBufferReceiveFromISR

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

Value:

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

xMessageBufferReset

#define xMessageBufferReset

(

xMessageBuffer

)

Value:

    xStreamBufferReset( xMessageBuffer )

xMessageBufferResetFromISR

#define xMessageBufferResetFromISR

(

xMessageBuffer

)

Value:

    xStreamBufferResetFromISR( xMessageBuffer )

xMessageBufferSend

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

Value:

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

xMessageBufferSendCompletedFromISR

#define xMessageBufferSendCompletedFromISR	(		xMessageBuffer,
			pxHigherPriorityTaskWoken )

Value:

    xStreamBufferSendCompletedFromISR( ( xMessageBuffer ), ( pxHigherPriorityTaskWoken ) )

xMessageBufferSendFromISR

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

Value:

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

xMessageBufferSpaceAvailable

#define xMessageBufferSpaceAvailable

(

xMessageBuffer

)

Value:

    xStreamBufferSpacesAvailable( xMessageBuffer )

xMessageBufferSpacesAvailable

#define xMessageBufferSpacesAvailable

(

xMessageBuffer

)

Value:

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

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.