Quality RTOS & Embedded Software

 Real time embedded FreeRTOS RSS feed 
Real time embedded FreeRTOS mailing list 
Quick Start Supported MCUs Books & Kits Trace Tools Ecosystem TCP & FAT Training




Queue Management
[API]

Modules


Detailed Description


uxQueueMessagesWaiting

queue.h
UBaseType_t uxQueueMessagesWaiting( QueueHandle_t 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
UBaseType_t uxQueueMessagesWaiting( QueueHandle_t 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.


uxQueueSpacesAvailable

queue.h
UBaseType_t uxQueueSpacesAvailable( QueueHandle_t xQueue );

Return the number of free spaces in a queue.

Parameters:
xQueue   A handle to the queue being queried.
Returns:
The number of free spaces available in the queue.


vQueueDelete

queue.h
void vQueueDelete( QueueHandle_t 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
BaseType_t xQueueReset( QueueHandle_t 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
BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t 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
BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t 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-2016 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.

Latest News:

FreeRTOS V9.0.0 is now available for download.


Free TCP/IP and file system demos for the RTOS


Sponsored Links

Win a TrueSTUDIO Pro license!
FreeRTOS aware, profiling & more!
⇓⇓⇓⇓


FreeRTOS Partners

ARM Connected RTOS partner for all ARM microcontroller cores

Renesas Electronics Gold Alliance RTOS Partner.jpg

Microchip Premier RTOS Partner

RTOS partner of NXP for all NXP ARM microcontrollers

Atmel RTOS partner supporting ARM Cortex-M3 and AVR32 microcontrollers

STMicro RTOS partner supporting ARM7, ARM Cortex-M3, ARM Cortex-M4 and ARM Cortex-M0

Xilinx Microblaze and Zynq partner

Silicon Labs low power RTOS partner

Altera RTOS partner for Nios II and Cortex-A9 SoC

Freescale Alliance RTOS Member supporting ARM and ColdFire microcontrollers

Infineon ARM Cortex-M microcontrollers

Texas Instruments MCU Developer Network RTOS partner for ARM and MSP430 microcontrollers

Cypress RTOS partner supporting ARM Cortex-M3

Fujitsu RTOS partner supporting ARM Cortex-M3 and FM3

Microsemi (previously Actel) RTOS partner supporting ARM Cortex-M3

Atollic Partner

IAR Partner

Keil ARM Partner

Embedded Artists