xStreamBatchingBufferCreate macro

stream_buffer.h @code{c} StreamBufferHandle_t xStreamBatchingBufferCreate( size_t xBufferSizeBytes, size_t xTriggerLevelBytes ); @endcode Creates a new stream batching buffer using dynamically allocated memory. See xStreamBatchingBufferCreateStatic() for a version that uses statically allocated memory (memory that is allocated at compile time). configSUPPORT_DYNAMIC_ALLOCATION must be set to 1 or left undefined in FreeRTOSConfig.h for xStreamBatchingBufferCreate() to be available. configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for xStreamBatchingBufferCreate() 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} void vAFunction( void ) { StreamBufferHandle_t xStreamBatchingBuffer; const size_t xStreamBufferSizeBytes = 100, xTriggerLevel = 10; // Create a stream batching buffer that can hold 100 bytes. The memory used // to hold both the stream batching buffer structure and the data in the stream // batching buffer is allocated dynamically. xStreamBatchingBuffer = xStreamBatchingBufferCreate( xStreamBufferSizeBytes, xTriggerLevel ); if( xStreamBatchingBuffer == NULL ) { // There was not enough heap memory space available to create the // stream batching buffer. } else { // The stream batching buffer was created successfully and can now be used. } } @endcode