CBaseThreadManager< CTaskClass > Class Template Reference

The base thread manager. More...

#include <BaseThreadManager.h>

Inheritance diagram for CBaseThreadManager< CTaskClass >:

Public Member Functions
	CBaseThreadManager ()
	Constructor. More...
virtual	~CBaseThreadManager ()
	Destructor. More...
void	Insert (CTaskClass *)
	Insert a task. More...
void	Spawn ()
	Spawn threads. More...
void	Wait ()
	Wait for threads to finish all tasks. More...
void	ForceExit ()
	Force all threads to terminate. More...
void	Process ()
	Process results of all tasks. More...
const size_t	GetNumThreads () const
	Get number of threads. More...

Protected Member Functions
virtual void	ProcessTask (CTaskClass *)
	Process the result of a task. More...

Protected Attributes
std::vector< std::thread >	m_vThread
	Thread list.
size_t	m_nNumThreads = 0
	Number of threads in use.

Additional Inherited Members
Static Protected Attributes inherited from CCommon< CTaskClass >
static CThreadSafeQueue< CTaskClass * >	m_qRequest
	Request queue.
static CThreadSafeQueue< CTaskClass * >	m_qResult
	Result queue.
static bool	m_bForceExit = false
	Force exit flag.

Detailed Description

template<class CTaskClass>
class CBaseThreadManager< CTaskClass >

The thread manager takes care of the health and feeding of the threads. You should derive your thread manager from this class with the template CTaskClass being your task descriptor class derived from CBaseTask. Your thread manager should implement a constructor for any task-related initialization and it should override function ProcessTask() with the processing required for your task.

Template Parameters

CTaskClass

Task descriptor.

Constructor & Destructor Documentation

CBaseThreadManager()

template<class CTaskClass >

CBaseThreadManager< CTaskClass >::CBaseThreadManager

Default constructor.

Template Parameters

CTaskClass

Task descriptor.

~CBaseThreadManager()

template<class CTaskClass >

CBaseThreadManager< CTaskClass >::~CBaseThreadManager

virtual

The destructor deletes any remaining tasks in the request and result queues. Both queues should be empty at this point, but this is for safety.

Template Parameters

CTaskClass

Task descriptor.

Member Function Documentation

ForceExit()

template<class CTaskClass >

void CBaseThreadManager< CTaskClass >::ForceExit

Force all threads to terminate and wait until they do.

Template Parameters

CTaskClass

Task descriptor.

GetNumThreads()

template<class CTaskClass >

const size_t CBaseThreadManager< CTaskClass >::GetNumThreads

Reader function for the number of threads used by this application. Assumes that m_nNumThreads contains this value.

Returns

Number of threads used.

Insert()

template<class CTaskClass >

void CBaseThreadManager< CTaskClass >::Insert

(

CTaskClass *

p

)

Insert a task descriptor into the request queue.

Template Parameters

CTaskClass

Task descriptor.

Parameters

p	Pointer to a task.

Process()

template<class CTaskClass >

void CBaseThreadManager< CTaskClass >::Process

Process and delete all completed task descriptors from the result queue.

Template Parameters

CTaskClass

Task descriptor.

ProcessTask()

template<class CTaskClass >

void CBaseThreadManager< CTaskClass >::ProcessTask ( CTaskClass *  pTask )

protectedvirtual

Process the results of a task. This function is a stub which you should override in your derived thread manager class.

Template Parameters

CTaskClass

Task descriptor.

Parameters

pTask

Pointer to a task descriptor.

Spawn()

template<class CTaskClass >

void CBaseThreadManager< CTaskClass >::Spawn

Spawn one less than the maximum number of concurrent threads provided by the hardware (leaving one for the main thread).

Template Parameters

CTaskClass

Task descriptor.

Wait()

template<class CTaskClass >

void CBaseThreadManager< CTaskClass >::Wait

Wait for all threads to terminate (that is, execute a join) then return.

Template Parameters

CTaskClass

Task descriptor.