Task State Queries

Macros
#define	btaskState(task)   _btaskState(BasicTask(task))
#define	taskState(task)   _btaskState(BasicTask(task))
#define	btaskIsRunning(task)   _btaskIsRunning(BasicTask(task))
#define	taskIsRunning(task)   _btaskIsRunning(BasicTask(task))
#define	btaskIsPending(task)   _btaskIsPending(BasicTask(task))
#define	taskIsPending(task)   _btaskIsPending(BasicTask(task))
#define	btaskIsIdle(task)   _btaskIsIdle(BasicTask(task))
#define	taskIsIdle(task)   _btaskIsIdle(BasicTask(task))
#define	btaskIsComplete(task)   _btaskIsComplete(BasicTask(task))
#define	taskIsComplete(task)   _btaskIsComplete(BasicTask(task))
#define	btaskSucceeded(task)   _btaskSucceeded(BasicTask(task))
#define	taskSucceeded(task)   _btaskSucceeded(BasicTask(task))
#define	btaskFailed(task)   _btaskFailed(BasicTask(task))
#define	taskFailed(task)   _btaskFailed(BasicTask(task))
#define	btaskCancelled(task)   _btaskCancelled(BasicTask(task))
#define	taskCancelled(task)   _btaskCancelled(BasicTask(task))
#define	taskCancel(task)   btaskCancel(task)
#define	taskWait(task, timeout)   ftaskWait(task, timeout)

Detailed Description

Macro Definition Documentation

btaskCancelled

#define btaskCancelled

(

task

)

_btaskCancelled(BasicTask(task))

bool btaskCancelled(BasicTask *task)

Check if a task has been cancelled. Cancelled flag is independent of state and can be set on running or pending tasks.

Parameters

task	Task to query

Returns

true if TASK_Cancelled flag is set

Definition at line 334 of file taskqueue.h.

btaskFailed

#define btaskFailed

(

task

)

_btaskFailed(BasicTask(task))

bool btaskFailed(BasicTask *task)

Check if a task failed.

Parameters

task	Task to query

Returns

true if task is in TASK_Failed state

Definition at line 316 of file taskqueue.h.

btaskIsComplete

#define btaskIsComplete

(

task

)

_btaskIsComplete(BasicTask(task))

bool btaskIsComplete(BasicTask *task)

Check if a task has completed (either succeeded or failed).

Parameters

task	Task to query

Returns

true if task is in a final state (TASK_Succeeded or TASK_Failed)

Definition at line 282 of file taskqueue.h.

btaskIsIdle

#define btaskIsIdle

(

task

)

_btaskIsIdle(BasicTask(task))

bool btaskIsIdle(BasicTask *task)

Check if a task is idle (created, waiting, deferred, or scheduled but not running).

Parameters

task	Task to query

Returns

true if task has never run or is not currently running

Definition at line 264 of file taskqueue.h.

btaskIsPending

#define btaskIsPending

(

task

)

_btaskIsPending(BasicTask(task))

bool btaskIsPending(BasicTask *task)

Check if a task is pending (waiting, deferred, or scheduled).

Parameters

task	Task to query

Returns

true if task has not yet run and has not completed

Definition at line 245 of file taskqueue.h.

btaskIsRunning

#define btaskIsRunning

(

task

)

_btaskIsRunning(BasicTask(task))

bool btaskIsRunning(BasicTask *task)

Check if a task is currently running on a worker.

Parameters

task	Task to query

Returns

true if task is in TASK_Running state

Definition at line 227 of file taskqueue.h.

btaskState

#define btaskState

(

task

)

_btaskState(BasicTask(task))

uint32 btaskState(BasicTask *task)

Get the current state of a task.

Parameters

task	Task to query (any type derived from BasicTask)

Returns

Task state (one of TASK_Created, TASK_Waiting, TASK_Running, etc.)

Definition at line 210 of file taskqueue.h.

btaskSucceeded

#define btaskSucceeded

(

task

)

_btaskSucceeded(BasicTask(task))

bool btaskSucceeded(BasicTask *task)

Check if a task completed successfully.

Parameters

task	Task to query

Returns

true if task is in TASK_Succeeded state

Definition at line 299 of file taskqueue.h.

taskCancel

#define taskCancel

(

task

)

btaskCancel(task)

bool taskCancel(Task *task)

Request cancellation of a task. The task will be marked cancelled and may be stopped if possible.

Parameters

task	Task to cancel

Returns

true if cancellation was successful

Definition at line 349 of file taskqueue.h.

taskCancelled

#define taskCancelled

(

task

)

_btaskCancelled(BasicTask(task))

bool taskCancelled(Task *task)

Check if a task has been cancelled. Cancelled flag is independent of state and can be set on running or pending tasks.

Parameters

task	Task to query

Returns

true if TASK_Cancelled flag is set

Definition at line 341 of file taskqueue.h.

taskFailed

#define taskFailed

(

task

)

_btaskFailed(BasicTask(task))

bool taskFailed(Task *task)

Check if a task failed.

Parameters

task	Task to query

Returns

true if task is in TASK_Failed state

Definition at line 322 of file taskqueue.h.

taskIsComplete

#define taskIsComplete

(

task

)

_btaskIsComplete(BasicTask(task))

bool taskIsComplete(Task *task)

Check if a task has completed (either succeeded or failed).

Parameters

task	Task to query

Returns

true if task is in a final state (TASK_Succeeded or TASK_Failed)

Definition at line 288 of file taskqueue.h.

taskIsIdle

#define taskIsIdle

(

task

)

_btaskIsIdle(BasicTask(task))

bool taskIsIdle(Task *task)

Check if a task is idle (created, waiting, deferred, or scheduled but not running).

Parameters

task	Task to query

Returns

true if task has never run or is not currently running

Definition at line 270 of file taskqueue.h.

taskIsPending

#define taskIsPending

(

task

)

_btaskIsPending(BasicTask(task))

bool taskIsPending(Task *task)

Check if a task is pending (waiting, deferred, or scheduled).

Parameters

task	Task to query

Returns

true if task has not yet run and has not completed

Definition at line 251 of file taskqueue.h.

taskIsRunning

#define taskIsRunning

(

task

)

_btaskIsRunning(BasicTask(task))

bool taskIsRunning(Task *task)

Check if a task is currently running on a worker.

Parameters

task	Task to query

Returns

true if task is in TASK_Running state

Definition at line 233 of file taskqueue.h.

taskState

#define taskState

(

task

)

_btaskState(BasicTask(task))

uint32 taskState(Task *task)

Get the current state of a task.

Parameters

task	Task to query

Returns

Task state (one of TASK_Created, TASK_Waiting, TASK_Running, etc.)

Definition at line 216 of file taskqueue.h.

taskSucceeded

#define taskSucceeded

(

task

)

_btaskSucceeded(BasicTask(task))

bool taskSucceeded(Task *task)

Check if a task completed successfully.

Parameters

task	Task to query

Returns

true if task is in TASK_Succeeded state

Definition at line 305 of file taskqueue.h.

taskWait

#define taskWait	(		task,
			timeout
	)		ftaskWait(task, timeout)

bool taskWait(Task *task, int64 timeout)

Wait for a task to complete with optional timeout.

Parameters

task	Task to wait for
timeout	Maximum time to wait, or 0 to wait indefinitely

Returns

true if task completed within timeout

Definition at line 357 of file taskqueue.h.