vStreamBufferSetStreamBufferNotificationIndex

Collaboration diagram for vStreamBufferSetStreamBufferNotificationIndex:

stream_buffer.h

void vStreamBufferSetStreamBufferNotificationIndex ( StreamBuffer_t xStreamBuffer, UBaseType_t uxNotificationIndex );

Set the task notification index used for the supplied stream buffer. Successive calls to stream buffer APIs (like xStreamBufferSend or xStreamBufferReceive) for this stream buffer will use this new index for their task notifications.

If this function is not called, the default index (tskDEFAULT_INDEX_TO_NOTIFY) is used for task notifications. It is recommended to call this function before attempting to send or receive data from the stream buffer to avoid inconsistencies.

configUSE_STREAM_BUFFERS must be set to 1 in for FreeRTOSConfig.h for vStreamBufferSetStreamBufferNotificationIndex() to be available.

Parameters

xStreamBuffer	The handle of the stream buffer for which the task notification index is set.
uxNotificationIndex	The task notification index to set.