TTE::JobManager Namespace Reference

Classes
class	JobInterface

Typedefs
typedef void *	JobId
typedef void *	JobQueueId
typedef int(*	JobMainFunc )(JobId jobId, void *arg)
typedef void(*	JobCancelFunc )(JobId jobId, void *arg)
typedef void(*	JobFinishFunc )(JobId jobId, void *arg, JobStatus finishStatus, int result)

Enumerations
enum	JobStatus {   JOB_STATUS_UNKNOWN, JOB_STATUS_CANNOT_START, JOB_STATUS_FINISHED, JOB_STATUS_CANCELLED_WITHOUT_START,   JOB_STATUS_CANCELLED }

Functions
void	WaitEmptyAll ()
JobQueueId	jobQueueCreate ()
JobQueueId	jobQueueGetDefault ()
void	jobQueueDelete (JobQueueId queueId)
void	jobQueueWaitEmpty (JobQueueId queueId=jobQueueGetDefault())
void	jobQueueCancelAllJobs (JobQueueId queueId=jobQueueGetDefault(), bool bCancelFinishedJobs=false)
void	jobQueueCancelDelete (JobQueueId *queueId, bool bCancelFinishedJobs=false)
JobId	jobEnqueue (JobQueueId queueId, const char *name, JobInterface *jobInterface)
JobId	jobEnqueue (JobQueueId queueId, const char *name, JobMainFunc mainFunc, JobCancelFunc cancelFunc=NULL, JobFinishFunc finishFunc=NULL, unsigned int argSize=0, void *arg=NULL)
JobId	jobEnqueue (const char *name, JobInterface *jobInterface)
JobId	jobEnqueue (const char *name, JobMainFunc mainFunc, JobCancelFunc cancelFunc=NULL, JobFinishFunc finishFunc=NULL, unsigned int argSize=0, void *arg=NULL)
void	jobCancel (JobId jobId, bool bCancelFinishedJob=false)
bool	jobIsCancelled (JobId jobId)

Typedef Documentation

typedef void(* TTE::JobManager::JobCancelFunc)(JobId jobId, void *arg)

typedef void(* TTE::JobManager::JobFinishFunc)(JobId jobId, void *arg, JobStatus finishStatus, int result)

typedef void* TTE::JobManager::JobId

typedef int(* TTE::JobManager::JobMainFunc)(JobId jobId, void *arg)

typedef void* TTE::JobManager::JobQueueId

Enumeration Type Documentation

enum TTE::JobManager::JobStatus

Enumerator
JOB_STATUS_UNKNOWN
JOB_STATUS_CANNOT_START
JOB_STATUS_FINISHED
JOB_STATUS_CANCELLED_WITHOUT_START
JOB_STATUS_CANCELLED

Function Documentation

void TTE::JobManager::jobCancel	(	JobId	jobId,
		bool	bCancelFinishedJob = false
	)

JobId TTE::JobManager::jobEnqueue	(	JobQueueId	queueId,
		const char *	name,
		JobInterface *	jobInterface
	)

JobId TTE::JobManager::jobEnqueue	(	JobQueueId	queueId,
		const char *	name,
		JobMainFunc	mainFunc,
		JobCancelFunc	cancelFunc = NULL,
		JobFinishFunc	finishFunc = NULL,
		unsigned int	argSize = 0,
		void *	arg = NULL
	)

JobId TTE::JobManager::jobEnqueue	(	const char *	name,
		JobInterface *	jobInterface
	)

JobId TTE::JobManager::jobEnqueue	(	const char *	name,
		JobMainFunc	mainFunc,
		JobCancelFunc	cancelFunc = NULL,
		JobFinishFunc	finishFunc = NULL,
		unsigned int	argSize = 0,
		void *	arg = NULL
	)

bool TTE::JobManager::jobIsCancelled

(

JobId

jobId

)

void TTE::JobManager::jobQueueCancelAllJobs	(	JobQueueId	queueId = jobQueueGetDefault(),
		bool	bCancelFinishedJobs = false
	)

void TTE::JobManager::jobQueueCancelDelete	(	JobQueueId *	queueId,
		bool	bCancelFinishedJobs = false
	)

JobQueueId TTE::JobManager::jobQueueCreate

(

)

void TTE::JobManager::jobQueueDelete

(

JobQueueId

queueId

)

JobQueueId TTE::JobManager::jobQueueGetDefault

(

)

void TTE::JobManager::jobQueueWaitEmpty

(

JobQueueId

queueId = jobQueueGetDefault()

)

void TTE::JobManager::WaitEmptyAll

(

)