Group that contains queue utility functions. More...
Collaboration diagram for Queue Utility Functions:
Functions | |
| UBaseType_t | uxQueueMessagesWaiting (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION |
| UBaseType_t | uxQueueSpacesAvailable (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION |
| BaseType_t | xQueueIsQueueEmptyFromISR (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION |
| BaseType_t | xQueueIsQueueFullFromISR (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION |
| UBaseType_t | uxQueueMessagesWaitingFromISR (const QueueHandle_t xQueue) PRIVILEGED_FUNCTION |
Detailed Description
Group that contains queue utility functions.
Function Documentation
◆ uxQueueMessagesWaiting()
| UBaseType_t uxQueueMessagesWaiting | ( | const QueueHandle_t | xQueue | ) |
#include <queue.h>
Return the number of messages stored in a queue.
- Parameters
-
xQueue A handle to the queue being queried.
- Returns
- The number of messages available in the queue.
◆ uxQueueMessagesWaitingFromISR()
| UBaseType_t uxQueueMessagesWaitingFromISR | ( | const QueueHandle_t | xQueue | ) |
#include <queue.h>
Return the number of messages stored in a queue. Safe to query from an ISR.
- Parameters
-
xQueue A handle to the queue being queried.
- Returns
- The number of messages available in the queue.
◆ uxQueueSpacesAvailable()
| UBaseType_t uxQueueSpacesAvailable | ( | const QueueHandle_t | xQueue | ) |
#include <queue.h>
Return the number of free spaces available in a queue. This is equal to the number of items that can be sent to the queue before the queue becomes full if no items are removed.
- Parameters
-
xQueue A handle to the queue being queried.
- Returns
- The number of spaces available in the queue.
◆ xQueueIsQueueEmptyFromISR()
| BaseType_t xQueueIsQueueEmptyFromISR | ( | const QueueHandle_t | xQueue | ) |
#include <queue.h>
Return whether the queue is empty. Save to query from an ISR.
- Parameters
-
xQueue A handle to the queue being queried.
- Returns
- pdTRUE if the queue is empty.
◆ xQueueIsQueueFullFromISR()
| BaseType_t xQueueIsQueueFullFromISR | ( | const QueueHandle_t | xQueue | ) |
#include <queue.h>
Return whether the queue is full. Save to query from an ISR.
- Parameters
-
xQueue A handle to the queue being queried.
- Returns
- pdTRUE if the queue is full.
