C# Class SpicyPixel.Threading.Tasks.YieldableTask

Yieldable task for execution on a fiber.

Regular non-blocking tasks can also be scheduled on a FiberTaskScheduler, but yieldable tasks have the distinct ability to yield execution.

Inheritance: Task

Show file Open project: spicypixel/concurrency-kit-cs Class Usage Examples

Private Properties

Property	Type	Description
InternalAction	void

Public Methods

Method	Description
YieldableTask ( FiberInstruction instruction ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( FiberInstruction instruction, CancellationToken cancellationToken ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( FiberInstruction instruction, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( FiberInstruction instruction, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( Func coroutine ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( Func coroutine, CancellationToken cancellationToken ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( Func coroutine, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( Func coroutine, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( FiberInstruction>.Func coroutine, object state ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( FiberInstruction>.Func coroutine, object state, CancellationToken cancellationToken ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( FiberInstruction>.Func coroutine, object state, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( FiberInstruction>.Func coroutine, object state, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( IEnumerator coroutine ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( IEnumerator coroutine, CancellationToken cancellationToken ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( IEnumerator coroutine, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.
YieldableTask ( IEnumerator coroutine, TaskCreationOptions creationOptions ) : System	Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

Private Methods

Method	Description
InternalAction ( ) : void

Method Details

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction instruction ) : System
instruction	FiberInstruction	/// The coroutine to execute. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction instruction, CancellationToken cancellationToken ) : System
instruction	FiberInstruction	/// The coroutine to execute. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction instruction, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System
instruction	FiberInstruction	/// The instruction to execute. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction instruction, TaskCreationOptions creationOptions ) : System
instruction	FiberInstruction	/// The coroutine to execute. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( Func coroutine ) : System
coroutine	Func	/// The coroutine to execute. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( Func coroutine, CancellationToken cancellationToken ) : System
coroutine	Func	/// The coroutine to execute. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( Func coroutine, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System
coroutine	Func	/// The coroutine to execute. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( Func coroutine, TaskCreationOptions creationOptions ) : System
coroutine	Func	/// The coroutine to execute. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction>.Func coroutine, object state ) : System
coroutine	FiberInstruction>.Func	/// The coroutine to execute. ///
state	object	/// State to pass to the function. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction>.Func coroutine, object state, CancellationToken cancellationToken ) : System
coroutine	FiberInstruction>.Func	/// The coroutine to execute. ///
state	object	/// State to pass to the function. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction>.Func coroutine, object state, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System
coroutine	FiberInstruction>.Func	/// The coroutine to execute. ///
state	object	/// State to pass to the function. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( FiberInstruction>.Func coroutine, object state, TaskCreationOptions creationOptions ) : System
coroutine	FiberInstruction>.Func	/// The coroutine to execute. ///
state	object	/// State to pass to the function. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( IEnumerator coroutine ) : System
coroutine	IEnumerator	/// The coroutine to execute. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( IEnumerator coroutine, CancellationToken cancellationToken ) : System
coroutine	IEnumerator	/// The coroutine to execute. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( IEnumerator coroutine, CancellationToken cancellationToken, TaskCreationOptions creationOptions ) : System
coroutine	IEnumerator	/// The coroutine to execute. ///
cancellationToken	System.Threading.CancellationToken	/// Cancellation token. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System

YieldableTask() public method

Initializes a new instance of the SpicyPixel.Threading.Tasks.YieldableTask class.

public YieldableTask ( IEnumerator coroutine, TaskCreationOptions creationOptions ) : System
coroutine	IEnumerator	/// The coroutine to execute. ///
creationOptions	TaskCreationOptions	/// Creation options. ///
return	System