Ocean::TaskQueue Class Reference

This class implements a queue for tasks. More...

#include <TaskQueue.h>

Inheritance diagram for Ocean::TaskQueue:

Public Types
using	Task = Caller< void >
	Definition of a task as caller function.

Public Member Functions
void	pushTask (const Task &task)
	Adds a new tasks to the queue which will be invoked after all previous task have been invoked.
size_t	pendingTasks ()
	Returns the number of tasks currently in the queue (not counting an currently invoked task).
void	clear ()
	Removes all pending tasks from this queue.

Protected Types
using	Tasks = std::queue< Task >
	Definition of a queue holding tasks.
Protected Types inherited from Ocean::Thread
using	TimedJoinPair = std::pair< pthread_t, bool >
	Definition of a pair holding a thread id and a boolean state.
enum	ThreadPriority {   PRIORITY_IDLE , PRIORTY_BELOW_NORMAL , PRIORTY_NORMAL , PRIORTY_ABOVE_NORMAL ,   PRIORTY_HIGH , PRIORTY_REALTIME }
	Definition of different thread priority values. More...

Protected Member Functions
	TaskQueue ()
	Creates a new task queue object.
	~TaskQueue ()
	Destructs a task queue object.
virtual void	threadRun ()
	The thread run function.
Protected Member Functions inherited from Ocean::Singleton< TaskQueue >
	Singleton ()=default
	Default constructor.
Protected Member Functions inherited from Ocean::Thread
	Thread (const Thread &thread)=delete
	Disabled copy constructor.
void	createThread ()
	Creates the thread itself.
void	destroyThread ()
	Destroys the thread itself.
void	stopThreadExplicitly (const unsigned int timeout=5000u)
	Tries to stop the thread gracefully.
Thread &	operator= (const Thread &thread)=delete
	The disabled assign operator.
	Thread (const std::string &name=std::string())
	Creates a new thread object.
	Thread (const unsigned int randomNumberSeedValue, const std::string &name=std::string())
	Creates a new thread object.
virtual	~Thread ()
	Destructs a thread object.
bool	startThread ()
	Starts the thread.
void	stopThread ()
	Informs the thread to stop.
bool	terminateThread ()
	Terminates the thread.
bool	joinThread (const unsigned int timeout=(unsigned int)(-1))
	Waits until this thread has been stopped.
bool	shouldThreadStop () const
	Returns whether this thread should stop.
bool	isThreadInvokedToStart () const
	Returns whether this thread has been invoked to start immediately.
bool	isThreadActive () const
	Returns whether this thread is active.

Protected Attributes
Tasks	queueTasks
	The tasks if this queue.
bool	queueHadTask
	True, if at least one task has been added to this queue before.
Lock	queueLock
	The lock of this queue.

Friends
class	Singleton< TaskQueue >

Additional Inherited Members
Static Public Member Functions inherited from Ocean::Singleton< TaskQueue >
static TaskQueue &	get ()
	Returns a reference to the unique object.
Static Protected Member Functions inherited from Ocean::Thread
static void	sleep (unsigned int ms)
	Sleeps the calling thread for a given time.
static void	giveUp ()
	Gives up the remaining thread time.
static ThreadId	currentThreadId ()
	Returns the thread id of the current (calling) thread.
static ThreadPriority	threadPriority ()
	Returns the priority of the current thread.
static bool	setThreadPriority (const ThreadPriority priority)
	Sets the priority of the current thread.
template<typename TObject , typename TExpectedValue >
static bool	waitForValue (TObject &object, const TExpectedValue &expectedValue, const double timeout=-1.0)
	Waits until an object/variable has an expected value.
template<typename TObject , typename TExpectedValue >
static bool	waitForValue (TObject &object, const TExpectedValue &expectedValue, TemporaryScopedLock &temporaryScopedLock, const double timeout=-1.0)
	Waits until an object/variable has an expected value.
static int	pthread_timedjoin_np (pthread_t thread, void **retval, const struct timespec *abstime)
	Implements a thread join function with timeout value.

Detailed Description

This class implements a queue for tasks.

The queue is based on a single thread so that all tasks will be processes sequential in a normal FIFO queue order.
In contrast to the Scheduler the TaskQueue invokes a function only once.

See also

Scheduler, ThreadPool.

Member Typedef Documentation

Task

using Ocean::TaskQueue::Task = Caller<void>

Definition of a task as caller function.

Tasks

using Ocean::TaskQueue::Tasks = std::queue<Task>

protected

Definition of a queue holding tasks.

Constructor & Destructor Documentation

TaskQueue()

Ocean::TaskQueue::TaskQueue ( )

protected

Creates a new task queue object.

~TaskQueue()

Ocean::TaskQueue::~TaskQueue ( )

protected

Destructs a task queue object.

Member Function Documentation

clear()

void Ocean::TaskQueue::clear

(

)

Removes all pending tasks from this queue.

A currently invoked task will not be stopped.

pendingTasks()

size_t Ocean::TaskQueue::pendingTasks

(

)

Returns the number of tasks currently in the queue (not counting an currently invoked task).

Returns

The number of pending tasks.

pushTask()

void Ocean::TaskQueue::pushTask

(

const Task &

task

)

Adds a new tasks to the queue which will be invoked after all previous task have been invoked.

Parameters

task	The new task to add

threadRun()

virtual void Ocean::TaskQueue::threadRun ( )

protectedvirtual

The thread run function.

Implements Ocean::Thread.

Friends And Related Symbol Documentation

Singleton< TaskQueue >

friend class Singleton< TaskQueue >

friend

Field Documentation

queueHadTask

bool Ocean::TaskQueue::queueHadTask

protected

True, if at least one task has been added to this queue before.

queueLock

Lock Ocean::TaskQueue::queueLock

protected

The lock of this queue.

queueTasks

Tasks Ocean::TaskQueue::queueTasks

protected

The tasks if this queue.

---

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

• TaskQueue.h