Chapter 2. API Reference
eDeleted
eInvalid
enum eNotifyAction
Values:
eNoAction = 0
eSetBits
eIncrement
eSetValueWithOverwrite
eSetValueWithoutOverwrite
enum eSleepModeStatus
Possible return values for eTaskConfirmSleepModeStatus().
Values:
eAbortSleep = 0
eStandardSleep
eNoTasksWaitingTimeout
Queue API
Header File
• components/freertos/include/freertos/queue.h
Functions
BaseType_t xQueueGenericSend(QueueHandle_t xQueue, const void *const pvItemToQueue, Tick-
Type_t xTicksToWait, const BaseType_t xCopyPosition)
It is preferred that the macros xQueueSend(), xQueueSendToFront() and xQueueSendToBack() are used in
place of calling this function directly.
Post an item on a queue. The item is queued by copy, not by reference. This function must not be called from
an interrupt service routine. See xQueueSendFromISR () for an alternative which may be used in an ISR.
Example usage:
struct AMessage
{
char ucMessageID;
char ucData[ 20 ];
} xMessage;
uint32_t ulVar = 10UL;
void vATask( void *pvParameters )
{
QueueHandle_t xQueue1, xQueue2;
struct AMessage *pxMessage;
// Create a queue capable of containing 10 uint32_t values.
xQueue1 = xQueueCreate( 10, sizeof( uint32_t ) );
// Create a queue capable of containing 10 pointers to AMessage structures.
// These should be passed by pointer as they contain a lot of data.
xQueue2 = xQueueCreate( 10, sizeof( struct AMessage * ) );
// ...
(continues on next page)
Espressif Systems 883
Submit Document Feedback
Release v4.4