File stream_buffer.h

FileList > FreeRTOS > include > stream_buffer.h

Go to the source code of this file.

Public Types

Type	Name
typedef struct StreamBufferDef_t *	StreamBufferHandle_t

Public Functions

Type	Name
void	vStreamBufferDelete (StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferBytesAvailable (StreamBufferHandle_t xStreamBuffer)
StreamBufferHandle_t	xStreamBufferGenericCreate (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer)
StreamBufferHandle_t	xStreamBufferGenericCreateStatic (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xIsMessageBuffer, uint8_t *const pucStreamBufferStorageArea, StaticStreamBuffer_t *const pxStaticStreamBuffer)
BaseType_t	xStreamBufferIsEmpty (StreamBufferHandle_t xStreamBuffer)
BaseType_t	xStreamBufferIsFull (StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferNextMessageLengthBytes (StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferReceive (StreamBufferHandle_t xStreamBuffer, void * pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait)
BaseType_t	xStreamBufferReceiveCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t * pxHigherPriorityTaskWoken)
size_t	xStreamBufferReceiveFromISR (StreamBufferHandle_t xStreamBuffer, void * pvRxData, size_t xBufferLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken)
BaseType_t	xStreamBufferReset (StreamBufferHandle_t xStreamBuffer)
size_t	xStreamBufferSend (StreamBufferHandle_t xStreamBuffer, const void * pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait)
BaseType_t	xStreamBufferSendCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t * pxHigherPriorityTaskWoken)
size_t	xStreamBufferSendFromISR (StreamBufferHandle_t xStreamBuffer, const void * pvTxData, size_t xDataLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken)
BaseType_t	xStreamBufferSetTriggerLevel (StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel)
size_t	xStreamBufferSpacesAvailable (StreamBufferHandle_t xStreamBuffer)

Macros

Type	Name
define	xStreamBufferCreate (xBufferSizeBytes, xTriggerLevelBytes) xStreamBufferGenericCreate( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE )
define	xStreamBufferCreateStatic (xBufferSizeBytes, xTriggerLevelBytes, pucStreamBufferStorageArea, pxStaticStreamBuffer) xStreamBufferGenericCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE, pucStreamBufferStorageArea, pxStaticStreamBuffer )

Public Types Documentation

typedef StreamBufferHandle_t

typedef struct StreamBufferDef_t* StreamBufferHandle_t;

Public Functions Documentation

function vStreamBufferDelete

void vStreamBufferDelete (
    StreamBufferHandle_t xStreamBuffer
) 

function xStreamBufferBytesAvailable

size_t xStreamBufferBytesAvailable (
    StreamBufferHandle_t xStreamBuffer
) 

function xStreamBufferGenericCreate

StreamBufferHandle_t xStreamBufferGenericCreate (
    size_t xBufferSizeBytes,
    size_t xTriggerLevelBytes,
    BaseType_t xIsMessageBuffer
) 

function xStreamBufferGenericCreateStatic

StreamBufferHandle_t xStreamBufferGenericCreateStatic (
    size_t xBufferSizeBytes,
    size_t xTriggerLevelBytes,
    BaseType_t xIsMessageBuffer,
    uint8_t *const pucStreamBufferStorageArea,
    StaticStreamBuffer_t *const pxStaticStreamBuffer
) 

function xStreamBufferIsEmpty

BaseType_t xStreamBufferIsEmpty (
    StreamBufferHandle_t xStreamBuffer
) 

function xStreamBufferIsFull

BaseType_t xStreamBufferIsFull (
    StreamBufferHandle_t xStreamBuffer
) 

function xStreamBufferNextMessageLengthBytes

size_t xStreamBufferNextMessageLengthBytes (
    StreamBufferHandle_t xStreamBuffer
) 

function xStreamBufferReceive

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

function xStreamBufferReceiveCompletedFromISR

BaseType_t xStreamBufferReceiveCompletedFromISR (
    StreamBufferHandle_t xStreamBuffer,
    BaseType_t * pxHigherPriorityTaskWoken
) 

function xStreamBufferReceiveFromISR

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

function xStreamBufferReset

BaseType_t xStreamBufferReset (
    StreamBufferHandle_t xStreamBuffer
) 

function xStreamBufferSend

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

function xStreamBufferSendCompletedFromISR

BaseType_t xStreamBufferSendCompletedFromISR (
    StreamBufferHandle_t xStreamBuffer,
    BaseType_t * pxHigherPriorityTaskWoken
) 

function xStreamBufferSendFromISR

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

function xStreamBufferSetTriggerLevel

BaseType_t xStreamBufferSetTriggerLevel (
    StreamBufferHandle_t xStreamBuffer,
    size_t xTriggerLevel
) 

function xStreamBufferSpacesAvailable

size_t xStreamBufferSpacesAvailable (
    StreamBufferHandle_t xStreamBuffer
) 

Macro Definition Documentation

define xStreamBufferCreate

#define xStreamBufferCreate (
    xBufferSizeBytes,
    xTriggerLevelBytes
) xStreamBufferGenericCreate( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE )

define xStreamBufferCreateStatic

#define xStreamBufferCreateStatic (
    xBufferSizeBytes,
    xTriggerLevelBytes,
    pucStreamBufferStorageArea,
    pxStaticStreamBuffer
) xStreamBufferGenericCreateStatic( xBufferSizeBytes, xTriggerLevelBytes, pdFALSE, pucStreamBufferStorageArea, pxStaticStreamBuffer )

---

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