Latest News Items: FAT file system released - Tick suppression demo'ed SAM4L MCU & RX100 MCUs - embTCP released for PIC32
FreeRTOS royalty free RTOS RSS feed  Real time embedded FreeRTOS mailing list  
Quick Start Supported MCUs Books & Kits Ecosystem Training Contact & Support



Last site update May 1 2013

Queue Management
[API]

Modules


Detailed Description


uxQueueMessagesWaiting

queue.h
unsigned portBASE_TYPE uxQueueMessagesWaiting( xQueueHandle xQueue );

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

queue.h
unsigned portBASE_TYPE uxQueueMessagesWaiting( xQueueHandle xQueue );

A version of uxQueueMessagesWaiting() that can be called from an ISR. 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.


vQueueDelete

queue.h
void vQueueDelete( xQueueHandle xQueue );

Delete a queue - freeing all the memory allocated for storing of items placed on the queue.

Parameters:
xQueue   A handle to the queue to be deleted.


xQueueReset

queue.h
portBASE_TYPE xQueueReset( xQueueHandle xQueue );

Resets a queue to its original empty state.

Parameters:
xQueue   The handle of the queue being reset
Returns:
Since FreeRTOS V7.2.0 xQueueReset() always returns pdPASS.


xQueueIsQueueEmptyFromISR

queue.h
portBASE_TYPE xQueueIsQueueEmptyFromISR( const xQueueHandle xQueue );

Queries a queue to determine if the queue is empty. This function should only be used in an ISR.

Parameters:
xQueue   The handle of the queue being queried
Returns:
pdFALSE if the queue is not empty, or any other value if the queue is empty.


xQueueIsQueueFullFromISR

queue.h
portBASE_TYPE xQueueIsQueueFullFromISR( const xQueueHandle xQueue );

Queries a queue to determine if the queue is full. This function should only be used in an ISR.

Parameters:
xQueue   The handle of the queue being queried
Returns:
pdFALSE if the queue is not full, or any other value if the queue is full.








[ Back to the top ]    [ About FreeRTOS ]    [ Sitemap ]    [ ]




Copyright (C) 2004-2010 Richard Barry. Copyright (C) 2010-2013 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd.. See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.