Task Queue

Data Structures
struct	MPTaskInfo
struct	MPTask
struct	MPTaskQueueInfo
struct	MPTaskQueue

Typedefs
typedef struct MPTask	MPTask
typedef struct MPTaskInfo	MPTaskInfo
typedef struct MPTaskQueue	MPTaskQueue
typedef struct MPTaskQueueInfo	MPTaskQueueInfo
typedef uint32_t	MPTaskState
typedef uint32_t(*	MPTaskFunc) (uint32_t, uint32_t)

Enumerations
enum	MPTaskState { MP_TASK_STATE_INITIALISED = 1 << 0, MP_TASK_STATE_READY = 1 << 1, MP_TASK_STATE_RUNNING = 1 << 2, MP_TASK_STATE_FINISHED = 1 << 3 }

Functions
void	MPInitTaskQ (MPTaskQueue *queue, MPTask **queueBuffer, uint32_t queueBufferLen)
BOOL	MPTermTaskQ (MPTaskQueue *queue)
BOOL	MPGetTaskQInfo (MPTaskQueue *queue, MPTaskQueueInfo *info)
BOOL	MPStartTaskQ (MPTaskQueue *queue)
BOOL	MPStopTaskQ (MPTaskQueue *queue)
BOOL	MPResetTaskQ (MPTaskQueue *queue)
BOOL	MPEnqueTask (MPTaskQueue *queue, MPTask *task)
MPTask *	MPDequeTask (MPTaskQueue *queue)
uint32_t	MPDequeTasks (MPTaskQueue *queue, MPTask **queueBuffer, uint32_t queueBufferLen)
BOOL	MPWaitTaskQ (MPTaskQueue *queue, MPTaskQueueState mask)
BOOL	MPWaitTaskQWithTimeout (MPTaskQueue *queue, MPTaskQueueState wmask, OSTime timeout)
BOOL	MPPrintTaskQStats (MPTaskQueue *queue, uint32_t unk)
void	MPInitTask (MPTask *task, MPTaskFunc func, uint32_t userArg1, uint32_t userArg2)
BOOL	MPTermTask (MPTask *task)
BOOL	MPGetTaskInfo (MPTask *task, MPTaskInfo *info)
void *	MPGetTaskUserData (MPTask *task)
void	MPSetTaskUserData (MPTask *task, void *userData)
BOOL	MPRunTasksFromTaskQ (MPTaskQueue *queue, uint32_t count)
BOOL	MPRunTask (MPTask *task)

Detailed Description

Typedef Documentation

typedef struct MPTask MPTask

Definition at line 15 of file taskqueue.h.

typedef uint32_t(* MPTaskFunc) (uint32_t, uint32_t)

Definition at line 22 of file taskqueue.h.

typedef struct MPTaskInfo MPTaskInfo

Definition at line 16 of file taskqueue.h.

typedef struct MPTaskQueue MPTaskQueue

Definition at line 17 of file taskqueue.h.

typedef struct MPTaskQueueInfo MPTaskQueueInfo

Definition at line 18 of file taskqueue.h.

typedef uint32_t MPTaskState

Definition at line 20 of file taskqueue.h.

Enumeration Type Documentation

enum MPTaskState

Enumerator
MP_TASK_STATE_INITIALISED
MP_TASK_STATE_READY
MP_TASK_STATE_RUNNING
MP_TASK_STATE_FINISHED

Definition at line 24 of file taskqueue.h.

Function Documentation

MPTask* MPDequeTask

(

MPTaskQueue *

queue

)

uint32_t MPDequeTasks	(	MPTaskQueue *	queue,
		MPTask **	queueBuffer,
		uint32_t	queueBufferLen
	)

BOOL MPEnqueTask	(	MPTaskQueue *	queue,
		MPTask *	task
	)

BOOL MPGetTaskInfo	(	MPTask *	task,
		MPTaskInfo *	info
	)

BOOL MPGetTaskQInfo	(	MPTaskQueue *	queue,
		MPTaskQueueInfo *	info
	)

void* MPGetTaskUserData

(

MPTask *

task

)

void MPInitTask	(	MPTask *	task,
		MPTaskFunc	func,
		uint32_t	userArg1,
		uint32_t	userArg2
	)

void MPInitTaskQ	(	MPTaskQueue *	queue,
		MPTask **	queueBuffer,
		uint32_t	queueBufferLen
	)

BOOL MPPrintTaskQStats	(	MPTaskQueue *	queue,
		uint32_t	unk
	)

BOOL MPResetTaskQ

(

MPTaskQueue *

queue

)

BOOL MPRunTask

(

MPTask *

task

)

BOOL MPRunTasksFromTaskQ	(	MPTaskQueue *	queue,
		uint32_t	count
	)

void MPSetTaskUserData	(	MPTask *	task,
		void *	userData
	)

BOOL MPStartTaskQ

(

MPTaskQueue *

queue

)

BOOL MPStopTaskQ

(

MPTaskQueue *

queue

)

BOOL MPTermTask

(

MPTask *

task

)

BOOL MPTermTaskQ

(

MPTaskQueue *

queue

)

BOOL MPWaitTaskQ	(	MPTaskQueue *	queue,
		MPTaskQueueState	mask
	)

BOOL MPWaitTaskQWithTimeout	(	MPTaskQueue *	queue,
		MPTaskQueueState	wmask,
		OSTime	timeout
	)