xStreamBatchingBufferCreateStatic macro

stream_buffer.h @code{c} StreamBufferHandle_t xStreamBatchingBufferCreateStatic( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, uint8_t *pucStreamBufferStorageArea, StaticStreamBuffer_t *pxStaticStreamBuffer ); @endcode Creates a new stream batching buffer using statically allocated memory. See xStreamBatchingBufferCreate() for a version that uses dynamically allocated memory. configSUPPORT_STATIC_ALLOCATION must be set to 1 in FreeRTOSConfig.h for xStreamBatchingBufferCreateStatic() to be available. configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for xStreamBatchingBufferCreateStatic() to be available. The difference between a stream buffer and a stream batching buffer is when a task performs read on a non-empty buffer: - The task reading from a non-empty stream buffer returns immediately regardless of the amount of data in the buffer. - The task reading from a non-empty steam batching buffer blocks until the amount of data in the buffer exceeds the trigger level or the block time expires. Example use: @code{c} // Used to dimension the array used to hold the streams. The available space // will actually be one less than this, so 999. #define STORAGE_SIZE_BYTES 1000 // Defines the memory that will actually hold the streams within the stream // batching buffer. static uint8_t ucStorageBuffer[ STORAGE_SIZE_BYTES ]; // The variable used to hold the stream batching buffer structure. StaticStreamBuffer_t xStreamBufferStruct; void MyFunction( void ) { StreamBufferHandle_t xStreamBatchingBuffer; const size_t xTriggerLevel = 1; xStreamBatchingBuffer = xStreamBatchingBufferCreateStatic( sizeof( ucStorageBuffer ), xTriggerLevel, ucStorageBuffer, &xStreamBufferStruct ); // As neither the pucStreamBufferStorageArea or pxStaticStreamBuffer // parameters were NULL, xStreamBatchingBuffer will not be NULL, and can be // used to reference the created stream batching buffer in other stream // buffer API calls. // Other code that uses the stream batching buffer can go here. } @endcode