cpp_freertos::WorkQueue Class Reference

#include <workqueue.hpp>

Classes
class	CWorkerThread

Public Member Functions
	WorkQueue (const char *const Name, uint16_t StackDepth=DEFAULT_WORK_QUEUE_STACK_SIZE, UBaseType_t Priority=DEFAULT_WORK_QUEUE_PRIORITY, UBaseType_t MaxWorkItems=DEFAULT_MAX_WORK_ITEMS)
	WorkQueue (uint16_t StackDepth=DEFAULT_WORK_QUEUE_STACK_SIZE, UBaseType_t Priority=DEFAULT_WORK_QUEUE_PRIORITY, UBaseType_t MaxWorkItems=DEFAULT_MAX_WORK_ITEMS)
	~WorkQueue ()
	~WorkQueue ()=delete
bool	QueueWork (WorkItem *work)

Private Attributes
CWorkerThread *	WorkerThread
Queue *	WorkItemQueue
BinarySemaphore *	ThreadComplete

Detailed Description

This class is the "engine" for WorkItems. Create one or more WorkQueues to accept WorkItems. WorkQueues pull WorkItems off of a FIFO queue and run them sequentially.

Definition at line 126 of file workqueue.hpp.

Constructor & Destructor Documentation

WorkQueue() [1/2]

WorkQueue::WorkQueue	(	const char *const	Name,
		uint16_t	StackDepth = DEFAULT_WORK_QUEUE_STACK_SIZE,
		UBaseType_t	Priority = DEFAULT_WORK_QUEUE_PRIORITY,
		UBaseType_t	MaxWorkItems = DEFAULT_MAX_WORK_ITEMS
	)

Constructor to create a named WorkQueue.

Exceptions

ThreadCreateException,QueueCreateException,SemaphoreCreateException

Parameters

Name	Name of the thread internal to the WorkQueue. Only useful for debugging.
StackDepth	Number of "words" allocated for the Thread stack.
Priority	FreeRTOS priority of this Thread.
MaxWorkItems	Maximum number of WorkItems this WorkQueue can hold.

Definition at line 63 of file cworkqueue.cpp.

WorkQueue() [2/2]

WorkQueue::WorkQueue	(	uint16_t	StackDepth = DEFAULT_WORK_QUEUE_STACK_SIZE,
		UBaseType_t	Priority = DEFAULT_WORK_QUEUE_PRIORITY,
		UBaseType_t	MaxWorkItems = DEFAULT_MAX_WORK_ITEMS
	)

Constructor to create an unnamed WorkQueue.

Exceptions

ThreadCreateException,QueueCreateException,SemaphoreCreateException

Parameters

StackDepth	Number of "words" allocated for the Thread stack.
Priority	FreeRTOS priority of this Thread.
MaxWorkItems	Maximum number of WorkItems this WorkQueue can hold.

Definition at line 82 of file cworkqueue.cpp.

~WorkQueue() [1/2]

WorkQueue::~WorkQueue

(

)

Our destructor.

Note

Given the multithreaded nature of this class, the dtor may block until the underlying Thread has had a chance to clean up.

Definition at line 102 of file cworkqueue.cpp.

~WorkQueue() [2/2]

cpp_freertos::WorkQueue::~WorkQueue ( )

delete

If we can't delete a task, it makes no sense to have a destructor.

Member Function Documentation

QueueWork()

bool WorkQueue::QueueWork

(

WorkItem *

work

)

Send a WorkItem off to be executed.

Parameters

work	Pointer to a WorkItem.

Returns

true if it was queued, false otherwise.

Note

This function may block if the WorkQueue is presently full.

Definition at line 137 of file cworkqueue.cpp.

Member Data Documentation

ThreadComplete

BinarySemaphore* cpp_freertos::WorkQueue::ThreadComplete

private

Semaphore to support deconstruction without race conditions.

Definition at line 240 of file workqueue.hpp.

WorkerThread

CWorkerThread* cpp_freertos::WorkQueue::WorkerThread

private

Pointer to our WorkerThread.

Definition at line 230 of file workqueue.hpp.

WorkItemQueue

Queue* cpp_freertos::WorkQueue::WorkItemQueue

private

Pointer to our work queue itself.

Definition at line 235 of file workqueue.hpp.

---

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

• workqueue.hpp
• cworkqueue.cpp