Quality RTOS & Embedded Software

  Real time embedded FreeRTOS RSS feed  

xQueueAddToSet()
[Queue Set API]

queue.h
 BaseType_t xQueueAddToSet
                      (
                          QueueSetMemberHandle_t xQueueOrSemaphore,
                          QueueSetHandle_t xQueueSet
                      );

configUSE_QUEUE_SETS must be set to 1 in FreeRTOSConfig.h for the xQueueAddToSet() API function to be available.

Adds an RTOS queue or semaphore to a queue set that was previously created by a call to xQueueCreateSet().

A receive (in the case of a queue) or take (in the case of a semaphore) operation must not be performed on a member of a queue set unless a call to xQueueSelectFromSet() has first returned a handle to that set member.

Parameters:
xQueueOrSemaphore   The handle of the queue or semaphore being added to the queue set (cast to an QueueSetMemberHandle_t type).
xQueueSet   The handle of the queue set to which the queue or semaphore is being added.
Returns:
If the queue or semaphore was successfully added to the queue set then pdPASS is returned. If the queue could not be successfully added to the queue set because it is already a member of a different queue set then pdFAIL is returned.
Example usage:

See the example on the xQueueCreateSet() documentation page.




Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.