xQueuePeek
[队列管理]

queue.h


 BaseType_t xQueuePeek(
                             QueueHandle_t xQueue,
                             void *pvBuffer,
                             TickType_t xTicksToWait
                         );

这是一个调用 xQueueGenericReceive() 函数的宏。

从队列中接收项目，而无须从队列中删除该项目。项目由副本接收，因此必须提供适当大小的缓冲区。队列创建时，复制到缓冲区中的字节数已定义。

成功接收的项目仍在队列中，因此将由下一次调用再次返回或 xQueueReceive () 调用。

中断服务例程中不得使用此宏。

参数：

xQueue	要从中接收项目的队列的句柄。
pvBuffer	指针，指向将复制收到的项目的缓冲区。它必须至少足够大，才能容纳创建队列时定义的队列项的大小。
xTicksToWait	如果在调用时队列为空，则任务应阻塞等待项目接收的最长时间。时间已在滴答周期中定义，因此如果需要，应使用常量 portTICK_PERIOD_MS 来将其转换为实时。如果 INCLUDE_vTaskSuspend 设置为 “1” ，则将阻塞时间指定为 portMAX_DELAY 会导致任务无限期地阻塞（没有超时）。

返回：: 如果从队列中成功接收（窥视）项目，则返回 pdTRUE，否则返回 pdFALSE。

用法示例：

 struct AMessage
 {
    char ucMessageID;
    char ucData[ 20 ];
 } xMessage;

 QueueHandle_t xQueue;

 // Task to create a queue and post a value.
 void vATask( void *pvParameters )
 {
 struct AMessage *pxMessage;

    // Create a queue capable of containing 10 pointers to AMessage structures.
    // These should be passed by pointer as they contain a lot of data.
    xQueue = xQueueCreate( 10, sizeof( struct AMessage * ) );
    if( xQueue == 0 )
    {
        // Failed to create the queue.
    }

    // ...

    // Send a pointer to a struct AMessage object.  Don't block if the
    // queue is already full.
    pxMessage = & xMessage;
    xQueueSend( xQueue, ( void * ) &pxMessage, ( TickType_t ) 0 );

    // ... Rest of task code.
 }

 // Task to peek the data from the queue.
 void vADifferentTask( void *pvParameters )
 {
 struct AMessage *pxRxedMessage;

    if( xQueue != 0 )
    {
        // Peek a message on the created queue.  Block for 10 ticks if a
        // message is not immediately available.
        if( xQueuePeek( xQueue, &( pxRxedMessage ), ( TickType_t ) 10 ) )
        {
            // pcRxedMessage now points to the struct AMessage variable posted
            // by vATask, but the item still remains on the queue.
        }
    }

    // ... Rest of task code.
 }

出色的 RTOS & 嵌入式软件 下载 FreeRTOS 菜单

xQueuePeek [队列管理]

出色的 RTOS & 嵌入式软件

下载 FreeRTOS
菜单

xQueuePeek
[队列管理]