cpp_freertos::BinaryQueue Class Reference

#include <queue.hpp>

Inheritance diagram for cpp_freertos::BinaryQueue:

Public Member Functions
	BinaryQueue (UBaseType_t itemSize)
virtual bool	Enqueue (void *item)
virtual bool	EnqueueFromISR (void *item, BaseType_t *pxHigherPriorityTaskWoken)
Public Member Functions inherited from cpp_freertos::Queue
	Queue (UBaseType_t maxItems, UBaseType_t itemSize)
virtual	~Queue ()
bool	Dequeue (void *item, TickType_t Timeout=portMAX_DELAY)
bool	DequeueFromISR (void *item, BaseType_t *pxHigherPriorityTaskWoken)
virtual bool	Enqueue (const void *item)
virtual bool	Enqueue (const void *item, TickType_t Timeout)
virtual bool	EnqueueFromISR (const void *item, BaseType_t *pxHigherPriorityTaskWoken)
void	Flush ()
bool	IsEmpty ()
bool	IsFull ()
UBaseType_t	NumItems ()
UBaseType_t	NumSpacesLeft ()
bool	Peek (void *item, TickType_t Timeout=portMAX_DELAY)
bool	PeekFromISR (void *item)

Additional Inherited Members
Protected Attributes inherited from cpp_freertos::Queue
QueueHandle_t	handle

Detailed Description

Binary queue with overwrite. This queue can only hold one item. If sucessive Enqueue operations are called, that item is overwritten with whatever the last item was.

Note

It is expected that an application will instantiate this class or one of the derived classes and use that. It is not expected that a user or application will derive from these classes.

Constructor & Destructor Documentation

BinaryQueue()

BinaryQueue::BinaryQueue ( UBaseType_t  itemSize )

explicit

Our constructor.

Exceptions

QueueCreateException

Parameters

itemSize

Size of an item in a queue.

Note

FreeRTOS queues use a memcpy / fixed size scheme for queues.

Member Function Documentation

Enqueue()

bool BinaryQueue::Enqueue ( void *  item )

virtual

Add an item to the queue.

Parameters

item	The item you are adding.

Returns

true always, because of overwrite.

EnqueueFromISR()

bool BinaryQueue::EnqueueFromISR ( void *  item, BaseType_t *  pxHigherPriorityTaskWoken  )

virtual

Add an item to the queue in ISR context.

Parameters

item	The item you are adding.
pxHigherPriorityTaskWoken	Did this operation result in a rescheduling event.

Returns

true always, because of overwrite.

---

The documentation for this class was generated from the following files:

• src/queue.hpp
• src/freertos-addon/c++/cqueue.cpp