Skip to content

File message_buffer.h

FileList > FreeRTOS > include > message_buffer.h

Go to the source code of this file.

  • #include "stream_buffer.h"

Public Types

Type Name
typedef void * MessageBufferHandle_t

Macros

Type Name
define vMessageBufferDelete (xMessageBuffer) vStreamBufferDelete( ( StreamBufferHandle_t ) xMessageBuffer )
define xMessageBufferCreate (xBufferSizeBytes) ( MessageBufferHandle_t ) xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE )
define xMessageBufferCreateStatic (xBufferSizeBytes, pucMessageBufferStorageArea, pxStaticMessageBuffer) ( MessageBufferHandle_t ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer )
define xMessageBufferIsEmpty (xMessageBuffer) xStreamBufferIsEmpty( ( StreamBufferHandle_t ) xMessageBuffer )
define xMessageBufferIsFull (xMessageBuffer) xStreamBufferIsFull( ( StreamBufferHandle_t ) xMessageBuffer )
define xMessageBufferNextLengthBytes (xMessageBuffer) xStreamBufferNextMessageLengthBytes( ( StreamBufferHandle_t ) xMessageBuffer ) PRIVILEGED_FUNCTION;
define xMessageBufferReceive (xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait) xStreamBufferReceive( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, xTicksToWait )
define xMessageBufferReceiveCompletedFromISR (xMessageBuffer, pxHigherPriorityTaskWoken) xStreamBufferReceiveCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )
define xMessageBufferReceiveFromISR (xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken) xStreamBufferReceiveFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvRxData, xBufferLengthBytes, pxHigherPriorityTaskWoken )
define xMessageBufferReset (xMessageBuffer) xStreamBufferReset( ( StreamBufferHandle_t ) xMessageBuffer )
define xMessageBufferSend (xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait) xStreamBufferSend( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, xTicksToWait )
define xMessageBufferSendCompletedFromISR (xMessageBuffer, pxHigherPriorityTaskWoken) xStreamBufferSendCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )
define xMessageBufferSendFromISR (xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken) xStreamBufferSendFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pvTxData, xDataLengthBytes, pxHigherPriorityTaskWoken )
define xMessageBufferSpaceAvailable (xMessageBuffer) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer )
define xMessageBufferSpacesAvailable (xMessageBuffer) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer ) /* Corrects typo in original macro name. */

Public Types Documentation

typedef MessageBufferHandle_t

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.

Macro Definition Documentation

define vMessageBufferDelete

#define vMessageBufferDelete (
    xMessageBuffer
) vStreamBufferDelete( ( StreamBufferHandle_t ) xMessageBuffer )

message_buffer.h

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

#define xMessageBufferCreate (
    xBufferSizeBytes
) ( MessageBufferHandle_t ) xStreamBufferGenericCreate( xBufferSizeBytes, ( size_t ) 0, pdTRUE )

define xMessageBufferCreateStatic

#define xMessageBufferCreateStatic (
    xBufferSizeBytes,
    pucMessageBufferStorageArea,
    pxStaticMessageBuffer
) ( MessageBufferHandle_t ) xStreamBufferGenericCreateStatic( xBufferSizeBytes, 0, pdTRUE, pucMessageBufferStorageArea, pxStaticMessageBuffer )

define xMessageBufferIsEmpty

#define xMessageBufferIsEmpty (
    xMessageBuffer
) xStreamBufferIsEmpty( ( StreamBufferHandle_t ) xMessageBuffer )

message_buffer.h

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

#define xMessageBufferIsFull (
    xMessageBuffer
) xStreamBufferIsFull( ( StreamBufferHandle_t ) xMessageBuffer )

message_buffer.h

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

#define xMessageBufferNextLengthBytes (
    xMessageBuffer
) xStreamBufferNextMessageLengthBytes( ( StreamBufferHandle_t ) xMessageBuffer ) PRIVILEGED_FUNCTION;

define xMessageBufferReceive

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

define xMessageBufferReceiveCompletedFromISR

#define xMessageBufferReceiveCompletedFromISR (
    xMessageBuffer,
    pxHigherPriorityTaskWoken
) xStreamBufferReceiveCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )

define xMessageBufferReceiveFromISR

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

define xMessageBufferReset

#define xMessageBufferReset (
    xMessageBuffer
) xStreamBufferReset( ( StreamBufferHandle_t ) xMessageBuffer )

define xMessageBufferSend

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

define xMessageBufferSendCompletedFromISR

#define xMessageBufferSendCompletedFromISR (
    xMessageBuffer,
    pxHigherPriorityTaskWoken
) xStreamBufferSendCompletedFromISR( ( StreamBufferHandle_t ) xMessageBuffer, pxHigherPriorityTaskWoken )

define xMessageBufferSendFromISR

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

define xMessageBufferSpaceAvailable

#define xMessageBufferSpaceAvailable (
    xMessageBuffer
) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer )

define xMessageBufferSpacesAvailable

#define xMessageBufferSpacesAvailable (
    xMessageBuffer
) xStreamBufferSpacesAvailable( ( StreamBufferHandle_t ) xMessageBuffer ) /* Corrects typo in original macro name. */

The documentation for this class was generated from the following file fw/rbcx-coprocessor/lib/FreeRTOS/include/message_buffer.h