stream_buffer.h File Reference

#include "FreeRTOS.h"
#include <stddef.h>
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	StaticStreamBuffer_t

Typedefs
typedef StaticStreamBuffer_t *	StreamBufferHandle_t

Functions
StreamBufferHandle_t	xStreamBufferCreate (size_t xBufferSizeBytes, size_t xTriggerLevelBytes)
void	vStreamBufferDelete (StreamBufferHandle_t xStreamBuffer)
StreamBufferHandle_t	xStreamBufferCreateStatic (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, uint8_t *pucStreamBufferStorageArea, StaticStreamBuffer_t *pxStaticStreamBuffer)
size_t	xStreamBufferSend (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait)
size_t	xStreamBufferSendFromISR (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
size_t	xStreamBufferReceive (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait)
size_t	xStreamBufferReceiveFromISR (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t *pxHigherPriorityTaskWoken)
BaseType_t	xStreamBufferIsEmpty (const StreamBufferHandle_t xStreamBuffer)
BaseType_t	xStreamBufferIsFull (const StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferBytesAvailable (const StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferSpacesAvailable (const StreamBufferHandle_t xStreamBuffer)
BaseType_t	xStreamBufferSetTriggerLevel (StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevelBytes)
BaseType_t	xStreamBufferReset (StreamBufferHandle_t xStreamBuffer)

Typedef Documentation

StreamBufferHandle_t

typedef StaticStreamBuffer_t* StreamBufferHandle_t

Function Documentation

xStreamBufferCreate()

StreamBufferHandle_t xStreamBufferCreate ( size_t  xBufferSizeBytes, size_t  xTriggerLevelBytes  )

extern

vStreamBufferDelete()

void vStreamBufferDelete ( StreamBufferHandle_t  xStreamBuffer )

extern

xStreamBufferCreateStatic()

StreamBufferHandle_t xStreamBufferCreateStatic ( size_t  xBufferSizeBytes, size_t  xTriggerLevelBytes, uint8_t *  pucStreamBufferStorageArea, StaticStreamBuffer_t *  pxStaticStreamBuffer  )

extern

xStreamBufferSend()

size_t xStreamBufferSend ( StreamBufferHandle_t  xStreamBuffer, const void *  pvTxData, size_t  xDataLengthBytes, TickType_t  xTicksToWait  )

extern

xStreamBufferSendFromISR()

size_t xStreamBufferSendFromISR ( StreamBufferHandle_t  xStreamBuffer, const void *  pvTxData, size_t  xDataLengthBytes, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xStreamBufferReceive()

size_t xStreamBufferReceive ( StreamBufferHandle_t  xStreamBuffer, void *  pvRxData, size_t  xBufferLengthBytes, TickType_t  xTicksToWait  )

extern

xStreamBufferReceiveFromISR()

size_t xStreamBufferReceiveFromISR ( StreamBufferHandle_t  xStreamBuffer, void *  pvRxData, size_t  xBufferLengthBytes, BaseType_t *  pxHigherPriorityTaskWoken  )

extern

xStreamBufferIsEmpty()

BaseType_t xStreamBufferIsEmpty ( const StreamBufferHandle_t  xStreamBuffer )

extern

xStreamBufferIsFull()

BaseType_t xStreamBufferIsFull ( const StreamBufferHandle_t  xStreamBuffer )

extern

xStreamBufferBytesAvailable()

size_t xStreamBufferBytesAvailable ( const StreamBufferHandle_t  xStreamBuffer )

extern

xStreamBufferSpacesAvailable()

size_t xStreamBufferSpacesAvailable ( const StreamBufferHandle_t  xStreamBuffer )

extern

xStreamBufferSetTriggerLevel()

BaseType_t xStreamBufferSetTriggerLevel ( StreamBufferHandle_t  xStreamBuffer, size_t  xTriggerLevelBytes  )

extern

xStreamBufferReset()

BaseType_t xStreamBufferReset ( StreamBufferHandle_t  xStreamBuffer )

extern