stream_buffer.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	sbTYPE_STREAM_BUFFER   ( ( BaseType_t ) 0 )
#define	sbTYPE_MESSAGE_BUFFER   ( ( BaseType_t ) 1 )
#define	sbTYPE_STREAM_BATCHING_BUFFER   ( ( BaseType_t ) 2 )
#define	xStreamBufferCreate(xBufferSizeBytes, xTriggerLevelBytes)
#define	xStreamBufferCreateStatic(xBufferSizeBytes, xTriggerLevelBytes, pucStreamBufferStorageArea, pxStaticStreamBuffer)
#define	xStreamBatchingBufferCreate(xBufferSizeBytes, xTriggerLevelBytes)
#define	xStreamBatchingBufferCreateStatic(xBufferSizeBytes, xTriggerLevelBytes, pucStreamBufferStorageArea, pxStaticStreamBuffer)

Typedefs
typedef struct StreamBufferDef_t *	StreamBufferHandle_t
typedef void(*	StreamBufferCallbackFunction_t) (StreamBufferHandle_t xStreamBuffer, BaseType_t xIsInsideISR, BaseType_t *const pxHigherPriorityTaskWoken)

Functions
size_t	xStreamBufferSend (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
size_t	xStreamBufferSendFromISR (StreamBufferHandle_t xStreamBuffer, const void *pvTxData, size_t xDataLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
size_t	xStreamBufferReceive (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, TickType_t xTicksToWait) PRIVILEGED_FUNCTION
size_t	xStreamBufferReceiveFromISR (StreamBufferHandle_t xStreamBuffer, void *pvRxData, size_t xBufferLengthBytes, BaseType_t *const pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
void	vStreamBufferDelete (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
BaseType_t	xStreamBufferIsFull (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
BaseType_t	xStreamBufferIsEmpty (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
BaseType_t	xStreamBufferReset (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
BaseType_t	xStreamBufferResetFromISR (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
size_t	xStreamBufferSpacesAvailable (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
size_t	xStreamBufferBytesAvailable (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
BaseType_t	xStreamBufferSetTriggerLevel (StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel) PRIVILEGED_FUNCTION
BaseType_t	xStreamBufferSendCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
BaseType_t	xStreamBufferReceiveCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION
UBaseType_t	uxStreamBufferGetStreamBufferNotificationIndex (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION
void	vStreamBufferSetStreamBufferNotificationIndex (StreamBufferHandle_t xStreamBuffer, UBaseType_t uxNotificationIndex) PRIVILEGED_FUNCTION
StreamBufferHandle_t	xStreamBufferGenericCreate (size_t xBufferSizeBytes, size_t xTriggerLevelBytes, BaseType_t xStreamBufferType, StreamBufferCallbackFunction_t pxSendCompletedCallback, StreamBufferCallbackFunction_t pxReceiveCompletedCallback) PRIVILEGED_FUNCTION
size_t	xStreamBufferNextMessageLengthBytes (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

Macro Definition Documentation

sbTYPE_MESSAGE_BUFFER

#define sbTYPE_MESSAGE_BUFFER   ( ( BaseType_t ) 1 )

sbTYPE_STREAM_BATCHING_BUFFER

#define sbTYPE_STREAM_BATCHING_BUFFER   ( ( BaseType_t ) 2 )

sbTYPE_STREAM_BUFFER

#define sbTYPE_STREAM_BUFFER   ( ( BaseType_t ) 0 )

Type of stream buffer. For internal use only.

xStreamBatchingBufferCreate

#define xStreamBatchingBufferCreate	(		xBufferSizeBytes,
			xTriggerLevelBytes )

Value:

    xStreamBufferGenericCreate( ( xBufferSizeBytes ), ( xTriggerLevelBytes ), sbTYPE_STREAM_BATCHING_BUFFER, NULL, NULL )

xStreamBatchingBufferCreateStatic

#define xStreamBatchingBufferCreateStatic	(		xBufferSizeBytes,
			xTriggerLevelBytes,
			pucStreamBufferStorageArea,
			pxStaticStreamBuffer )

Value:

    xStreamBufferGenericCreateStatic( ( xBufferSizeBytes ), ( xTriggerLevelBytes ), sbTYPE_STREAM_BATCHING_BUFFER, ( pucStreamBufferStorageArea ), ( pxStaticStreamBuffer ), NULL, NULL )

xStreamBufferCreate

#define xStreamBufferCreate	(		xBufferSizeBytes,
			xTriggerLevelBytes )

Value:

    xStreamBufferGenericCreate( ( xBufferSizeBytes ), ( xTriggerLevelBytes ), sbTYPE_STREAM_BUFFER, NULL, NULL )

xStreamBufferCreateStatic

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

Value:

    xStreamBufferGenericCreateStatic( ( xBufferSizeBytes ), ( xTriggerLevelBytes ), sbTYPE_STREAM_BUFFER, ( pucStreamBufferStorageArea ), ( pxStaticStreamBuffer ), NULL, NULL )

Typedef Documentation

StreamBufferCallbackFunction_t

typedef void(* StreamBufferCallbackFunction_t) (StreamBufferHandle_t xStreamBuffer, BaseType_t xIsInsideISR, BaseType_t *const pxHigherPriorityTaskWoken)

Type used as a stream buffer's optional callback.

StreamBufferHandle_t

typedef struct StreamBufferDef_t* StreamBufferHandle_t

Function Documentation

uxStreamBufferGetStreamBufferNotificationIndex()

UBaseType_t uxStreamBufferGetStreamBufferNotificationIndex

(

StreamBufferHandle_t

xStreamBuffer

)

vStreamBufferDelete()

void vStreamBufferDelete

(

StreamBufferHandle_t

xStreamBuffer

)

vStreamBufferSetStreamBufferNotificationIndex()

void vStreamBufferSetStreamBufferNotificationIndex	(	StreamBufferHandle_t	xStreamBuffer,
		UBaseType_t	uxNotificationIndex )

xStreamBufferBytesAvailable()

size_t xStreamBufferBytesAvailable

(

StreamBufferHandle_t

xStreamBuffer

)

xStreamBufferGenericCreate()

StreamBufferHandle_t xStreamBufferGenericCreate	(	size_t	xBufferSizeBytes,
		size_t	xTriggerLevelBytes,
		BaseType_t	xStreamBufferType,
		StreamBufferCallbackFunction_t	pxSendCompletedCallback,
		StreamBufferCallbackFunction_t	pxReceiveCompletedCallback )

xStreamBufferIsEmpty()

BaseType_t xStreamBufferIsEmpty

(

StreamBufferHandle_t

xStreamBuffer

)

xStreamBufferIsFull()

BaseType_t xStreamBufferIsFull

(

StreamBufferHandle_t

xStreamBuffer

)

xStreamBufferNextMessageLengthBytes()

size_t xStreamBufferNextMessageLengthBytes

(

StreamBufferHandle_t

xStreamBuffer

)

xStreamBufferReceive()

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

xStreamBufferReceiveCompletedFromISR()

BaseType_t xStreamBufferReceiveCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken )

xStreamBufferReceiveFromISR()

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

xStreamBufferReset()

BaseType_t xStreamBufferReset

(

StreamBufferHandle_t

xStreamBuffer

)

xStreamBufferResetFromISR()

BaseType_t xStreamBufferResetFromISR

(

StreamBufferHandle_t

xStreamBuffer

)

xStreamBufferSend()

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

xStreamBufferSendCompletedFromISR()

BaseType_t xStreamBufferSendCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken )

xStreamBufferSendFromISR()

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

xStreamBufferSetTriggerLevel()

BaseType_t xStreamBufferSetTriggerLevel	(	StreamBufferHandle_t	xStreamBuffer,
		size_t	xTriggerLevel )

xStreamBufferSpacesAvailable()

size_t xStreamBufferSpacesAvailable

(

StreamBufferHandle_t

xStreamBuffer

)