High Level (queued work item) thread pool. More...

#include <threadpool.h>

Inheritance diagram for PQueuedThreadPool< Work_T >:

Collaboration diagram for PQueuedThreadPool< Work_T >:

Classes
class	QueuedWorkerThread

Public Member Functions
	PQueuedThreadPool (unsigned maxWorkers=std::max(PThread::GetNumProcessors(), 10U), unsigned maxWorkUnits=0, const char *threadName=NULL, PThread::Priority priority=PThread::NormalPriority, const PTimeInterval &workerIncreaseLatency=PMaxTimeInterval, unsigned workerIncreaseLimit=0)

const PTimeInterval &	GetWorkerIncreaseLatency () const

void	SetWorkerIncreaseLatency (const PTimeInterval &time)

unsigned	GetWorkerIncreaseLimit () const

void	SetWorkerIncreaseLimit (unsigned limit)

virtual void	OnMaxWaitTime (const QueuedWorkerThread &PTRACE_PARAM(thread), const PTimeInterval &PTRACE_PARAM(latency), const string &PTRACE_PARAM(group))

Public Member Functions inherited from PThreadPool< Work_T >
	PThreadPool (unsigned maxWorkers=10, unsigned maxWorkUnits=0, const char *threadName=NULL, PThread::Priority priority=PThread::NormalPriority)

bool	AddWork (Work_T work, const char group=NULL)

bool	RemoveWork (Work_T *work)

Public Member Functions inherited from PThreadPoolBase
	~PThreadPoolBase ()

void	Shutdown ()

virtual void	ReclaimWorkers ()

unsigned	GetMaxWorkers () const

void	SetMaxWorkers (unsigned count)

unsigned	GetMaxUnits () const

void	SetMaxUnits (unsigned count)

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
virtual PThreadPoolBase::WorkerThreadBase *	CreateWorkerThread ()

Protected Member Functions inherited from PThreadPoolBase
	PThreadPoolBase (unsigned maxWorkerCount, unsigned maxWorkUnitCount, const char *threadName, PThread::Priority priority)

virtual WorkerThreadBase *	AllocateWorker ()

virtual void	StopWorker (WorkerThreadBase *worker)

virtual bool	OnWorkerStarted (WorkerThreadBase &thread)

	PDECLARE_MUTEX (m_mutex)

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PTimeInterval	m_workerIncreaseLatency

unsigned	m_workerIncreaseLimit

PTime	m_nextWorkerIncreaseTime

Protected Attributes inherited from PThreadPoolBase
WorkerList_t	m_workers

unsigned	m_maxWorkerCount

unsigned	m_maxWorkUnitCount

PString	m_threadName

PThread::Priority	m_priority

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Public Types inherited from PThreadPool< Work_T >
typedef std::map< Work_T *, InternalWork >	ExternalToInternalWorkMap_T

typedef std::map< std::string, GroupInfo >	GroupInfoMap_t

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Public Attributes inherited from PThreadPool< Work_T >
ExternalToInternalWorkMap_T	m_externalToInternalWorkMap

GroupInfoMap_t	m_groupInfoMap

Protected Types inherited from PThreadPoolBase
typedef std::vector < WorkerThreadBase * >	WorkerList_t

Detailed Description

template<class Work_T>
class PQueuedThreadPool< Work_T >

High Level (queued work item) thread pool.

Constructor & Destructor Documentation

template<class Work_T>

PQueuedThreadPool< Work_T >::PQueuedThreadPool	(	unsigned	maxWorkers = `std::max(PThread::GetNumProcessors(), 10U)`,
		unsigned	maxWorkUnits = `0`,
		const char *	threadName = `NULL`,
		PThread::Priority	priority = `PThread::NormalPriority`,
		const PTimeInterval &	workerIncreaseLatency = `PMaxTimeInterval`,
		unsigned	workerIncreaseLimit = `0`
	)

inline

Member Function Documentation

template<class Work_T>

virtual PThreadPoolBase::WorkerThreadBase* PQueuedThreadPool< Work_T >::CreateWorkerThread ( )

inlineprotectedvirtual

Implements PThreadPoolBase.

template<class Work_T>

const PTimeInterval& PQueuedThreadPool< Work_T >::GetWorkerIncreaseLatency ( ) const

inline

template<class Work_T>

unsigned PQueuedThreadPool< Work_T >::GetWorkerIncreaseLimit ( ) const

inline

template<class Work_T>

virtual void PQueuedThreadPool< Work_T >::OnMaxWaitTime	(	const QueuedWorkerThread &	PTRACE_PARAMthread,
		const PTimeInterval &	PTRACE_PARAMlatency,
		const string &	PTRACE_PARAMgroup
	)

inlinevirtual

Referenced by PQueuedThreadPool< Work_T >::QueuedWorkerThread::Work().

template<class Work_T>

void PQueuedThreadPool< Work_T >::SetWorkerIncreaseLatency ( const PTimeInterval & time )

inline

template<class Work_T>

void PQueuedThreadPool< Work_T >::SetWorkerIncreaseLimit ( unsigned limit )

inline

Member Data Documentation

template<class Work_T>

PTime PQueuedThreadPool< Work_T >::m_nextWorkerIncreaseTime

protected

Referenced by PQueuedThreadPool< Worker >::OnMaxWaitTime().

template<class Work_T>

PTimeInterval PQueuedThreadPool< Work_T >::m_workerIncreaseLatency

protected

Referenced by PQueuedThreadPool< Worker >::GetWorkerIncreaseLatency(), PQueuedThreadPool< Worker >::OnMaxWaitTime(), PQueuedThreadPool< Worker >::SetWorkerIncreaseLatency(), and PQueuedThreadPool< Work_T >::QueuedWorkerThread::Work().

template<class Work_T>

unsigned PQueuedThreadPool< Work_T >::m_workerIncreaseLimit

protected

Referenced by PQueuedThreadPool< Worker >::GetWorkerIncreaseLimit(), PQueuedThreadPool< Worker >::OnMaxWaitTime(), and PQueuedThreadPool< Worker >::SetWorkerIncreaseLimit().

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

threadpool.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Work_T> class PQueuedThreadPool< Work_T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Work_T>
class PQueuedThreadPool< Work_T >