SpicyPixel.Threading.Tasks.YieldableTask Class Reference

Yieldable task for execution on a fiber. More...

+ Inheritance diagram for SpicyPixel.Threading.Tasks.YieldableTask:
+ Collaboration diagram for SpicyPixel.Threading.Tasks.YieldableTask:

Public Member Functions

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

Detailed Description

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.

Definition at line 41 of file YieldableTask.cs.

Constructor & Destructor Documentation

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( IEnumerator  coroutine)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.

Definition at line 64 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( IEnumerator  coroutine,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
creationOptionsCreation options.

Definition at line 83 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( IEnumerator  coroutine,
CancellationToken  cancellationToken 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
cancellationTokenCancellation token.

Definition at line 102 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( IEnumerator  coroutine,
CancellationToken  cancellationToken,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
cancellationTokenCancellation token.
creationOptionsCreation options.

Definition at line 124 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( FiberInstruction  instruction)

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

Returns
The task.
Parameters
instructionThe coroutine to execute.

Definition at line 140 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( FiberInstruction  instruction,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
instructionThe coroutine to execute.
creationOptionsCreation options.

Definition at line 159 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( FiberInstruction  instruction,
CancellationToken  cancellationToken 
)

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

Returns
The task.
Parameters
instructionThe coroutine to execute.
cancellationTokenCancellation token.

Definition at line 178 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( FiberInstruction  instruction,
CancellationToken  cancellationToken,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
instructionThe instruction to execute.
cancellationTokenCancellation token.
creationOptionsCreation options.

Definition at line 200 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< FiberInstruction coroutine)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.

Definition at line 216 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< FiberInstruction coroutine,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
creationOptionsCreation options.

Definition at line 235 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< FiberInstruction coroutine,
CancellationToken  cancellationToken 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
cancellationTokenCancellation token.

Definition at line 254 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< FiberInstruction coroutine,
CancellationToken  cancellationToken,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
cancellationTokenCancellation token.
creationOptionsCreation options.

Definition at line 276 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< object, FiberInstruction coroutine,
object  state 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
stateState to pass to the function.

Definition at line 295 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< object, FiberInstruction coroutine,
object  state,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
stateState to pass to the function.
creationOptionsCreation options.

Definition at line 317 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< object, FiberInstruction coroutine,
object  state,
CancellationToken  cancellationToken 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
stateState to pass to the function.
cancellationTokenCancellation token.

Definition at line 339 of file YieldableTask.cs.

SpicyPixel.Threading.Tasks.YieldableTask.YieldableTask ( Func< object, FiberInstruction coroutine,
object  state,
CancellationToken  cancellationToken,
TaskCreationOptions  creationOptions 
)

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

Returns
The task.
Parameters
coroutineThe coroutine to execute.
stateState to pass to the function.
cancellationTokenCancellation token.
creationOptionsCreation options.

Definition at line 364 of file YieldableTask.cs.


The documentation for this class was generated from the following file: