message_buffer.h File Reference

#include "FreeRTOS.h"
#include "stream_buffer.h"
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef StreamBufferHandle_t	MessageBufferHandle_t
typedef StaticStreamBuffer_t	StaticMessageBuffer_t

Functions
MessageBufferHandle_t	xMessageBufferCreate (size_t xBufferSizeBytes)
void	vMessageBufferDelete (MessageBufferHandle_t xMessageBuffer)
MessageBufferHandle_t	xMessageBufferCreateStatic (size_t xBufferSizeBytes, uint8_t *pucMessageBufferStorageArea, StaticMessageBuffer_t *pxStaticMessageBuffer)
size_t	xMessageBufferSend (MessageBufferHandle_t xMessageBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait)
size_t	xMessageBufferSendFromISR (MessageBufferHandle_t xMessageBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
size_t	xMessageBufferReceive (MessageBufferHandle_t xMessageBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait)
size_t	xMessageBufferReceiveFromISR (MessageBufferHandle_t xMessageBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xMessageBufferIsEmpty (const MessageBufferHandle_t xMessageBuffer)
BaseType_t	xMessageBufferIsFull (const MessageBufferHandle_t xMessageBuffer)
size_t	xMessageBufferSpaceAvailable (const MessageBufferHandle_t xMessageBuffer)
size_t	xMessageBufferNextLengthBytes (MessageBufferHandle_t xMessageBuffer)
BaseType_t	xMessageBufferReset (MessageBufferHandle_t xMessageBuffer)

Typedef Documentation

MessageBufferHandle_t

typedef StreamBufferHandle_t MessageBufferHandle_t

StaticMessageBuffer_t

typedef StaticStreamBuffer_t StaticMessageBuffer_t

Function Documentation

xMessageBufferCreate()

MessageBufferHandle_t xMessageBufferCreate ( size_t  xBufferSizeBytes )

extern

vMessageBufferDelete()

void vMessageBufferDelete ( MessageBufferHandle_t  xMessageBuffer )

extern

xMessageBufferCreateStatic()

MessageBufferHandle_t xMessageBufferCreateStatic ( size_t  xBufferSizeBytes, uint8_t *  pucMessageBufferStorageArea, StaticMessageBuffer_t *  pxStaticMessageBuffer  )

extern

xMessageBufferSend()

size_t xMessageBufferSend ( MessageBufferHandle_t  xMessageBuffer, const void *  pvTxData, size_t  xDataLengthBytes, TickType_t  xTicksToWait  )

extern

xMessageBufferSendFromISR()

size_t xMessageBufferSendFromISR ( MessageBufferHandle_t  xMessageBuffer, const void *  pvTxData, size_t  xDataLengthBytes, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xMessageBufferReceive()

size_t xMessageBufferReceive ( MessageBufferHandle_t  xMessageBuffer, void *  pvRxData, size_t  xBufferLengthBytes, TickType_t  xTicksToWait  )

extern

xMessageBufferReceiveFromISR()

size_t xMessageBufferReceiveFromISR ( MessageBufferHandle_t  xMessageBuffer, void *  pvRxData, size_t  xBufferLengthBytes, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xMessageBufferIsEmpty()

BaseType_t xMessageBufferIsEmpty ( const MessageBufferHandle_t  xMessageBuffer )

extern

xMessageBufferIsFull()

BaseType_t xMessageBufferIsFull ( const MessageBufferHandle_t  xMessageBuffer )

extern

xMessageBufferSpaceAvailable()

size_t xMessageBufferSpaceAvailable ( const MessageBufferHandle_t  xMessageBuffer )

extern

xMessageBufferNextLengthBytes()

size_t xMessageBufferNextLengthBytes ( MessageBufferHandle_t  xMessageBuffer )

extern

xMessageBufferReset()

BaseType_t xMessageBufferReset ( MessageBufferHandle_t  xMessageBuffer )

extern