Detailed Description

template<typename ResultType = void>
class CYITask< ResultType >

This class defines a task that can be executed. After execution, the task returns a value of type ResultType, which is assigned to an associated CYIFuture object (if it exists).

A future object can be associated with a task in one of two ways. Either a reference to the future is passed to the task upon construction, or the SetFuture function is used to associate a future with the task. A task can only be associated with a single future object, and a future object can only be associated with a single task object. Deleting either the task object or the future object is thread-safe, and will result in the associated object being cancelled (if possible).

If a task has an associated future, the result of the task's execution is assigned to the future object after the task is executed. This will result in the Completed signal of the future object being triggered, and in the waking of any thread that may be blocked on Wait(), Get() or Take() function calls from the future object.

Tasks can be created without an associated future object. In that case, the result of the execution of the task is immediately discarded.

Note: If a task is created with a Future reference and that Future object already has an associated task, the task will be created without an associated Future object and a warning will be logged.

Warning: Task executors (e.g. Thread Pools) typically take ownership of tasks that are enqueued into them. For this reason, users should not retain a pointer to the task as that pointer may become invalid without prior notice.

All public functions, with the exception of the destructor, are thread-safe.

Template Parameters

ResultType the type of the execution result of this task.

See also: CYITaskBase; CYIFuture<ResultType>; CYIThreadPool

#include <thread/YiTask.h>

Inheritance diagram for CYITask< ResultType >:

[legend]

Public Member Functions
	CYITask ()

	CYITask (CYIFuture< ResultType > &rFuture)

	CYITask (std::unique_ptr< CYIFuture< ResultType >> pFuture)

virtual	~CYITask ()

bool	SetFuture (CYIFuture< ResultType > &rFuture)

bool	SetFuture (std::unique_ptr< CYIFuture< ResultType >> rFuture)

Public Member Functions inherited from CYITaskBase
virtual	~CYITaskBase ()

virtual bool	TakeOwnershipOfFuture (std::unique_ptr< CYIAbstractFuture > pFuture)

TASK_STATE	GetState () const

bool	IsFutureOwner () const

bool	MarkPendingExecution ()

void	RequestCancellation ()

bool	Execute ()