SctService::WorkerGroup< T > Class Template Reference

Control part of the observer/worker pattern. More...

#include <WorkerGroup.h>

Inheritance diagram for SctService::WorkerGroup< T >:

[legend]

Queue @{ the queue itself contains pointers to objects to be
worked on.
std::queue< DataType >	m_queue
boost::thread_group	m_thread_group
	boost thread group from which threads can be created
volatile bool	m_run
	if false, threads are to stop.
volatile bool	m_pause
	does not execute work() if true
volatile unsigned	m_sleeptime
	time to sleep if queue is empty
boost::mutex	m_queueAccess
	queueLock
boost::mutex	m_vectorAccess
	vectorLock
class	Worker
Public Types
typedef T	DataType
Public Member Functions
void	go (unsigned nWorker=1)
	Start this worker group. the number of worker threads to be started.
unsigned	queueSize () const
	get the number of objects in the queue
unsigned	nWorkers () const
	get the number of workers in the map
unsigned	busy () const
	get the number of threads which are busy.
void	stop ()
	Raise flag to stop all worker threads.
void	setPaused (bool paused=true)
void	join ()
	Call this to make sure that Worker threads continue to completion.
unsigned	paused () const
	get the number of paused threads
void	setSleepTime (unsigned msec)
	Set sleep time for all workers, if no items are on the queue.
unsigned	getSleepTime () const
	Get the sleep time.
DataType	pop ()
void	push (DataType ob)
	Push an object onto the back of the queue.
virtual	~WorkerGroup ()
	destructor
	WorkerGroup ()
	Constructor.
Protected Types
typedef std::vector< Worker * >	WorkerStore
typedef WorkerStore::iterator	Iterator
typedef WorkerStore::const_iterator	ConstIterator
Protected Member Functions
virtual void	threadMain (Worker &worker) throw ()
	The threadMain method.
virtual bool	popAndWork (Worker &worker)
	If the queue length != 0, removes an element from the queue and class work.
virtual void	waitForData ()
	Called if there is no data on the queue.
virtual void	work (DataType data)=0 throw ()
	To be overriden! Should actually do something with the data!
void	wait (int msec)
	Causes this thread to sleep for msec milliseconds.
void	addWorker (Worker &worker)
	threadMain should call this with its parameter.
Protected Attributes
Worker thread information @{
This map allows each thread to access different particular information from its own Worker.
WorkerStore	m_workers

---

Detailed Description

template<class T>
class SctService::WorkerGroup< T >

Control part of the observer/worker pattern.

Contains the queue to which objects of type T are pushed. Also useful functions to control and query the worker threads. The template class ``T'' is the data/instructions which the workers at to work on. Derive this class to implement/modify the behaviour of the worker threads. At the least, the work method needs an implementation. T must be DefaultConstructible For a simple example, see the test/MyWorkerGroup.h file

Definition at line 23 of file WorkerGroup.h.

---

Constructor & Destructor Documentation

template<class T> virtual SctService::WorkerGroup< T >::~WorkerGroup (   )  [inline, virtual]

destructor Definition at line 81 of file WorkerGroup.h.

template<class T> SctService::WorkerGroup< T >::WorkerGroup (   )  [inline]

Constructor. Definition at line 84 of file WorkerGroup.h.

---

Member Function Documentation

template<class T> void SctService::WorkerGroup< T >::addWorker (  Worker &  worker  )  [protected]

threadMain should call this with its parameter. Definition at line 187 of file WorkerGroup.h. References SctService::WorkerGroup< T >::m_vectorAccess.

template<class W> unsigned SctService::WorkerGroup< W >::busy (   )  const

get the number of threads which are busy. Note: for information only, not to be used in thread-control. Definition at line 264 of file WorkerGroup.h.

template<class T> unsigned SctService::WorkerGroup< T >::getSleepTime (   )  const [inline]

Get the sleep time. Definition at line 69 of file WorkerGroup.h. Referenced by SctService::WorkerGroup< T >::waitForData().

template<class T> void SctService::WorkerGroup< T >::go (  unsigned  nWorker = 1  )

Start this worker group. the number of worker threads to be started. Definition at line 159 of file WorkerGroup.h. References SctService::WorkerGroup< T >::m_thread_group.

template<class W> void SctService::WorkerGroup< W >::join (   )

Call this to make sure that Worker threads continue to completion. Definition at line 245 of file WorkerGroup.h. References SctService::WorkerGroup< T >::m_thread_group. Referenced by SctService::WorkerGroup< T >::stop().

template<class W> unsigned SctService::WorkerGroup< W >::nWorkers (   )  const

get the number of workers in the map Definition at line 234 of file WorkerGroup.h.

template<class W> unsigned SctService::WorkerGroup< W >::paused (   )  const

get the number of paused threads Definition at line 255 of file WorkerGroup.h.

template<class W> bool SctService::WorkerGroup< W >::popAndWork (  Worker &  worker  )  [protected, virtual]

If the queue length != 0, removes an element from the queue and class work. Returns: false if the queue length is 0. Definition at line 213 of file WorkerGroup.h. References SctService::WorkerGroup< T >::m_queueAccess, and SctService::WorkerGroup< T >::work().

Here is the call graph for this function:

template<class T> void SctService::WorkerGroup< T >::push (  DataType  ob  )

Push an object onto the back of the queue. Definition at line 193 of file WorkerGroup.h. References SctService::WorkerGroup< T >::m_queueAccess.

template<class W> unsigned SctService::WorkerGroup< W >::queueSize (   )  const

get the number of objects in the queue Note: for information only, not to be used in thread-control. Definition at line 229 of file WorkerGroup.h.

template<class W> void SctService::WorkerGroup< W >::setSleepTime (  unsigned  msec  )

Set sleep time for all workers, if no items are on the queue. Parameters: sleep  time in msec Definition at line 273 of file WorkerGroup.h. References SctService::WorkerGroup< T >::m_sleeptime.

template<class W> void SctService::WorkerGroup< W >::stop (   )

Raise flag to stop all worker threads. Definition at line 239 of file WorkerGroup.h. References SctService::WorkerGroup< T >::join(), and SctService::WorkerGroup< T >::m_run.

Here is the call graph for this function:

template<class T> void SctService::WorkerGroup< T >::threadMain (  Worker &  worker  )  throw () [protected, virtual]

The threadMain method. Can be overriden if sub-classes want to completly change the behaviour! Current implementation checks various flags for pausing, stopping etc, then calls popAndWork. If popAndWork returns false, then it calls waitForData Definition at line 167 of file WorkerGroup.h.

template<class W> void SctService::WorkerGroup< W >::wait (  int  msec  )  [protected]

Causes this thread to sleep for msec milliseconds. Definition at line 278 of file WorkerGroup.h. Referenced by SctService::WorkerGroup< T >::waitForData().

template<class W> void SctService::WorkerGroup< W >::waitForData (   )  [protected, virtual]

Called if there is no data on the queue. Calls wait in default implementation. Definition at line 286 of file WorkerGroup.h. References SctService::WorkerGroup< T >::getSleepTime(), and SctService::WorkerGroup< T >::wait().

Here is the call graph for this function:

template<class T> virtual void SctService::WorkerGroup< T >::work (  DataType  data  )  throw () [protected, pure virtual]

To be overriden! Should actually do something with the data! Referenced by SctService::WorkerGroup< T >::popAndWork().

---

Field Documentation

template<class T> volatile bool SctService::WorkerGroup< T >::m_pause [protected]

does not execute work() if true Definition at line 149 of file WorkerGroup.h.

template<class T> boost::mutex SctService::WorkerGroup< T >::m_queueAccess [protected]

queueLock Definition at line 152 of file WorkerGroup.h. Referenced by SctService::WorkerGroup< T >::popAndWork(), and SctService::WorkerGroup< T >::push().

template<class T> volatile bool SctService::WorkerGroup< T >::m_run [protected]

if false, threads are to stop. Definition at line 148 of file WorkerGroup.h. Referenced by SctService::WorkerGroup< T >::stop().

template<class T> volatile unsigned SctService::WorkerGroup< T >::m_sleeptime [protected]

time to sleep if queue is empty Definition at line 150 of file WorkerGroup.h. Referenced by SctService::WorkerGroup< T >::setSleepTime().

template<class T> boost::thread_group SctService::WorkerGroup< T >::m_thread_group [protected]

boost thread group from which threads can be created Definition at line 146 of file WorkerGroup.h. Referenced by SctService::WorkerGroup< T >::go(), and SctService::WorkerGroup< T >::join().

template<class T> boost::mutex SctService::WorkerGroup< T >::m_vectorAccess [protected]

vectorLock Definition at line 153 of file WorkerGroup.h. Referenced by SctService::WorkerGroup< T >::addWorker().

---

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

• WorkerGroup.h

---