#include <fbxthread.h>

Class Description

This class implement a standard way to use threads across platforms.

Definition at line 29 of file fbxthread.h.

Public Types
enum	EState { eUnknown, eRunning, eDead }
enum	EPriority { eNone, eIdle, eLowest, eLow, eNormal, eHigh, eHighest, eRealTime }
Public Member Functions
	FbxThread (FbxThreadProc pProc, void *pArg, bool pSuspend=false)
	Constructor.
	FbxThread (FbxThreadProc pProc, void *pArg, EPriority pPriority, bool pSuspend=false)
	Constructor.
virtual	~FbxThread ()
	Destructor.
bool	Suspend ()
	Suspend the execution of the thread.
bool	Resume ()
	Resume the execution of the thread.
bool	Join ()
	Wait for the thread completion.
bool	Kill ()
	Do not wait for the thread completion and terminate it.
EPriority	GetPriority ()
	Retrieve the priority of the thread.
bool	SetPriority (EPriority pPriority)
	Set the thread priority.
EState	GetState ()
	Retrieve the thread current state.

Member Enumeration Documentation

Enumerator:

Definition at line 32 of file fbxthread.h.

{eUnknown, eRunning, eDead};

Enumerator:

Definition at line 33 of file fbxthread.h.

{eNone, eIdle, eLowest, eLow, eNormal, eHigh, eHighest, eRealTime};

Constructor.

Parameters:

pProc	The procedure called upon thread startup.
pArg	The arguments passed to the procedure.
pSuspend	Start the thread suspended.

Constructor.

Parameters:

pProc	The procedure called upon thread startup.
pArg	The arguments passed to the procedure.
pPriority	The thread priority to set upon creation.
pSuspend	Start the thread suspended.

virtual ~FbxThread ( ) [virtual]

Destructor.

bool Suspend ( )

Suspend the execution of the thread.

Returns:: Return true if the thread was successfully suspended, otherwise false.

Remarks:: It should be used only if you can control where the thread will be suspended in its procedure, otherwise the state of the thread and its memory is unknown, since the code will stop anywhere.

bool Resume ( )

Resume the execution of the thread.