uxStreamBufferGetStreamBufferNotificationIndex
[RTOS Stream Buffer API]
stream_buffer.h
UBaseType_t uxStreamBufferGetStreamBufferNotificationIndex( StreamBufferHandle_t xStreamBuffer );
Retrieves the task notification index used for the supplied stream buffer, which can be set using
vStreamBufferSetStreamBufferNotificationIndex. If the task notification index for
the stream buffer is not changed using vStreamBufferSetStreamBufferNotificationIndex
, this function returns the default value
tskDEFAULT_INDEX_TO_NOTIFY
.
Enable stream buffer functionality by including the FreeRTOS/source/stream_buffer.c
source file in the build and by setting the
configUSE_STREAM_BUFFERS
configuration constant to 1 in FreeRTOSConfig.h.
Parameters:
xStreamBuffer
The handle of the stream buffer for which the task notification index is retrieved.
Returns:
The task notification index used for the stream buffer.
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.