MITHREAD::WORKER Class Reference

Thread class to manage a core level threading system. Allows execution of a job. More...

#include <mi32/mithread.h>

List of all members.

Public Member Functions
	WORKER (MISTATUSMANAGER *DftManager=0, const char *DebugName=0)
	~WORKER ()
void	CancelJob ()
void	ExecuteJob (JOB &Job)
bool	IsCanceling () const

---

Detailed Description

Thread class to manage a core level threading system. Allows execution of a job.

---

Constructor & Destructor Documentation

MITHREAD::WORKER::WORKER	(	MISTATUSMANAGER *	DftManager = 0,
		const char *	DebugName = 0
	)			[explicit]

Thread ctor, the thread instance will be created and put into a wait state.

Parameters:

	DftManager	Default status manager to assign any job, unless job overrides it
	DebugName	Name to assign to the thread, only applicable to Windows debugging under Visual Studio.

MITHREAD::WORKER::~WORKER

(

)

Thread dtor This call will block if a job is running.

---

Member Function Documentation

void MITHREAD::WORKER::CancelJob

(

)

Cancel a running job in the thread. The derived class of JOB must call JOB::CheckCancel() to determine if it has been canceled.

void MITHREAD::WORKER::ExecuteJob

(

JOB &

Job

)

Execute the job passed in in the thread instance managed by this class If the JOB::STATE_DeleteWhenCompleted is set on 'Job', the job will be deleted when completed.

This call will block if another job is running.

bool MITHREAD::WORKER::IsCanceling

(

)

const

Determine if the currently running job is in the cancel state.

Returns:

'True' if the job is in the process of canceling, 'false' if no job is running or CancelJob() has not been called

---

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

• mi32/mithread.h