Components/Libraries/XF/FreeRTOS/Queue

(Difference between revisions)
Jump to: navigation, search
(Member Attibuts)
(Queue())
Line 5: Line 5:
 
= Member Attibuts =
 
= Member Attibuts =
 
== Queue() ==
 
== Queue() ==
 +
=== Description ===
 +
The constructor of the queue. It will create a free RTOS queue and initialize it for the given object size
 +
=== Parameters ===
 +
oSizeofObject : the size of the element that must be contained by the Queue
 +
 
== Queue(baseUInt oSizeofObject) ==
 
== Queue(baseUInt oSizeofObject) ==
 
== ~Queue() ==
 
== ~Queue() ==

Revision as of 13:10, 10 August 2017

Contents

Queue

The class Queue is a C++ interface that manage a FreeRTOS queue.

Member Attibuts

Queue()

Description

The constructor of the queue. It will create a free RTOS queue and initialize it for the given object size

Parameters

oSizeofObject : the size of the element that must be contained by the Queue

Queue(baseUInt oSizeofObject)

~Queue()

bool initQueue(baseUInt oSizeofObject)

bool push(void* opEl, timeSize oTimeToWait)

bool pushCopy(void* opEl, TickType_t oTimeToWait)

bool pushFromISR(void* opEl)

bool pushCopyFromISR(void* opEl)

void* pop(timeSize oTimeToWait)

void* popFromISR()

void* peek(timeSize oTimeToWait)

void* peekFromISR()

bool overWrite(void* opEl)

bool overWriteCopy(void* opEl)

bool overWriteFromISR(void* opEl)

bool overWriteCopyFromISR(void* opEl)

bool isEmpty()

bool isFull()

QUEUE_LENGHT_SIZE itemsInQueue()

QUEUE_LENGHT_SIZE freeSpaceInQueue()

void reset()

bool isCreated()

Member Functions Description

Personal tools
Namespaces
Variants
Actions
Navigation
Browse
Toolbox