Group that contains macros & functions to register queues. More...
Functions | |
| void | vQueueAddToRegistry (QueueHandle_t xQueue, const char *pcName) PRIVILEGED_FUNCTION |
| void | vQueueUnregisterQueue (QueueHandle_t xQueue) PRIVILEGED_FUNCTION |
| const char * | pcQueueGetName (QueueHandle_t xQueue) PRIVILEGED_FUNCTION |
Detailed Description
Group that contains macros & functions to register queues.
Function Documentation
◆ pcQueueGetName()
| const char* pcQueueGetName | ( | QueueHandle_t | xQueue | ) |
#include <queue.h>
The queue registry is provided as a means for kernel aware debuggers to locate queues, semaphores and mutexes. Call pcQueueGetName() to look up and return the name of a queue in the queue registry from the queue's handle.
- Parameters
-
xQueue The handle of the queue the name of which will be returned.
- Returns
- If the queue is in the registry then a pointer to the name of the queue is returned. If the queue is not in the registry then NULL is returned.
◆ vQueueAddToRegistry()
| void vQueueAddToRegistry | ( | QueueHandle_t | xQueue, |
| const char * | pcName | ||
| ) |
#include <queue.h>
The registry is provided as a means for kernel aware debuggers to locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add a queue, semaphore or mutex handle to the registry if you want the handle to be available to a kernel aware debugger. If you are not using a kernel aware debugger then this function can be ignored.
configQUEUE_REGISTRY_SIZE defines the maximum number of handles the registry can hold. configQUEUE_REGISTRY_SIZE must be greater than 0 within FreeRTOSConfig.h for the registry to be available. Its value does not effect the number of queues, semaphores and mutexes that can be created - just the number that the registry can hold.
- Parameters
-
xQueue The handle of the queue being added to the registry. This is the handle returned by a call to xQueueCreate(). Semaphore and mutex handles can also be passed in here. pcName The name to be associated with the handle. This is the name that the kernel aware debugger will display. The queue registry only stores a pointer to the string - so the string must be persistent (global or preferably in ROM/Flash), not on the stack.
◆ vQueueUnregisterQueue()
| void vQueueUnregisterQueue | ( | QueueHandle_t | xQueue | ) |
#include <queue.h>
The registry is provided as a means for kernel aware debuggers to locate queues, semaphores and mutexes. Call vQueueAddToRegistry() add a queue, semaphore or mutex handle to the registry if you want the handle to be available to a kernel aware debugger, and vQueueUnregisterQueue() to remove the queue, semaphore or mutex from the register. If you are not using a kernel aware debugger then this function can be ignored.
- Parameters
-
xQueue The handle of the queue being removed from the registry.
