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 | 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

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
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
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

## Macro Definition Documentation

## xStreamBufferCreate

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

## xStreamBufferCreateStatic

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

## 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.

## Function Documentation

## vStreamBufferDelete()

void vStreamBufferDelete | ( | StreamBufferHandle_t | xStreamBuffer | ) |

Here is the call graph for this function:

## xStreamBufferBytesAvailable()

size_t xStreamBufferBytesAvailable | ( | StreamBufferHandle_t | xStreamBuffer | ) |

Here is the call graph for this function:

## xStreamBufferGenericCreate()

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

Here is the call graph for this function:

## 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 | ) |

## xStreamBufferIsFull()

BaseType_t xStreamBufferIsFull | ( | StreamBufferHandle_t | xStreamBuffer | ) |

Here is the call graph for this function:

## xStreamBufferReceive()

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

Here is the call graph for this function:

## 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
| ) |  |

Here is the call graph for this function:

## xStreamBufferReset()

BaseType_t xStreamBufferReset | ( | StreamBufferHandle_t | xStreamBuffer | ) |

Here is the call graph for this function:

## xStreamBufferSend()

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

Here is the call graph for this function:

## 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
| ) |  |

Here is the call graph for this function:

## xStreamBufferSetTriggerLevel()

BaseType_t xStreamBufferSetTriggerLevel | ( | StreamBufferHandle_t | xStreamBuffer,
|  | size_t | xTriggerLevel
| ) |  |

## xStreamBufferSpacesAvailable()

size_t xStreamBufferSpacesAvailable | ( | StreamBufferHandle_t | xStreamBuffer | ) |

Here is the caller graph for this function: