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

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

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

Typedefs
typedef void *	StreamBufferHandle_t

Functions
void	vStreamBufferDelete (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

size_t	xStreamBufferBytesAvailable (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

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

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

BaseType_t	xStreamBufferIsEmpty (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

BaseType_t	xStreamBufferIsFull (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

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

BaseType_t	xStreamBufferReceiveCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION

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

BaseType_t	xStreamBufferReset (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

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

BaseType_t	xStreamBufferSendCompletedFromISR (StreamBufferHandle_t xStreamBuffer, BaseType_t *pxHigherPriorityTaskWoken) PRIVILEGED_FUNCTION

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

BaseType_t	xStreamBufferSetTriggerLevel (StreamBufferHandle_t xStreamBuffer, size_t xTriggerLevel) PRIVILEGED_FUNCTION

size_t	xStreamBufferSpacesAvailable (StreamBufferHandle_t xStreamBuffer) PRIVILEGED_FUNCTION

Macro Definition Documentation

◆ xStreamBufferCreate

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

Definition at line 133 of file stream_buffer.h.

◆ xStreamBufferCreateStatic

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

Definition at line 214 of file stream_buffer.h.

Typedef Documentation

◆ StreamBufferHandle_t

typedef void* StreamBufferHandle_t

Type by which stream buffers are referenced. For example, a call to xStreamBufferCreate() returns an StreamBufferHandle_t variable that can then be used as a parameter to xStreamBufferSend(), xStreamBufferReceive(), etc.

Definition at line 65 of file stream_buffer.h.

Function Documentation

◆ vStreamBufferDelete()

void vStreamBufferDelete ( StreamBufferHandle_t xStreamBuffer )

Definition at line 332 of file stream_buffer.c.

◆ xStreamBufferBytesAvailable()

size_t xStreamBufferBytesAvailable ( StreamBufferHandle_t xStreamBuffer )

Definition at line 472 of file stream_buffer.c.

◆ xStreamBufferGenericCreate()

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

◆ xStreamBufferGenericCreateStatic()

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

◆ xStreamBufferIsEmpty()

BaseType_t xStreamBufferIsEmpty ( StreamBufferHandle_t xStreamBuffer )

Definition at line 899 of file stream_buffer.c.

◆ xStreamBufferIsFull()

BaseType_t xStreamBufferIsFull ( StreamBufferHandle_t xStreamBuffer )

Definition at line 922 of file stream_buffer.c.

◆ xStreamBufferReceive()

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

Definition at line 688 of file stream_buffer.c.

◆ xStreamBufferReceiveCompletedFromISR()

BaseType_t xStreamBufferReceiveCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

Definition at line 987 of file stream_buffer.c.

◆ xStreamBufferReceiveFromISR()

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

Definition at line 792 of file stream_buffer.c.

◆ xStreamBufferReset()

BaseType_t xStreamBufferReset ( StreamBufferHandle_t xStreamBuffer )

Definition at line 365 of file stream_buffer.c.

◆ xStreamBufferSend()

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

Definition at line 484 of file stream_buffer.c.

◆ xStreamBufferSendCompletedFromISR()

BaseType_t xStreamBufferSendCompletedFromISR	(	StreamBufferHandle_t	xStreamBuffer,
		BaseType_t *	pxHigherPriorityTaskWoken
	)

Definition at line 957 of file stream_buffer.c.

◆ xStreamBufferSendFromISR()

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

Definition at line 585 of file stream_buffer.c.

◆ xStreamBufferSetTriggerLevel()

BaseType_t xStreamBufferSetTriggerLevel	(	StreamBufferHandle_t	xStreamBuffer,
		size_t	xTriggerLevel
	)

Definition at line 419 of file stream_buffer.c.

◆ xStreamBufferSpacesAvailable()

size_t xStreamBufferSpacesAvailable ( StreamBufferHandle_t xStreamBuffer )

Definition at line 448 of file stream_buffer.c.

Macros

Typedefs

Functions