SpicyPixel.Threading 1.0.5.34676 System.Object

A Fiber is a lightweight means of scheduling work that enables multiple units of processing to execute concurrently by co-operatively sharing execution time on a single thread. Fibers are also known as "micro-threads" and can be implemented using programming language facilities such as "coroutines".

Fibers simplify many concurrency issues generally associated with multithreading because a given fiber has complete control over when it yields execution to another fiber. A fiber does not need to manage resource locking or handle changing data in the same way as a thread does because access to a resource is never preempted by another fiber without co-operation. Fibers can improve performance in certain applications with concurrency requirements. Because many fibers can run on a thread, this can relieve pressure on precious resources in the thread pool and reduce latency. Additionally, some applications have concurrent, interdependent processes that naturally lend themselves to co-operative scheduling which can result in greater efficiency when the application manages the context switch instead of a pre-emptive scheduler. Fibers can also be a convenient way to express a state machine. The master fiber implementing the machine can test state conditions, start new fibers for state actions, yield to an action fiber until it completes, and then handle the transition out of the state and into a new state. Constructor 1.0.5.34676 A non-blocking action to execute on the fiber.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A couroutine to execute on the fiber.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A non-blocking function that returns a when complete.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A non-blocking action to execute on the fiber. Cancellation token.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A non-blocking action to execute on the fiber. State to pass to the action.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A couroutine to execute on the fiber. Cancellation token.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A non-blocking function that returns a when complete. Cancellation token.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A non-blocking function that returns a when complete. State to pass to the function.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A non-blocking action to execute on the fiber. State to pass to the action. Cancellation token.

Initializes a new instance of the class.

To be added. Constructor 1.0.5.34676 A non-blocking function that returns a when complete. State to pass to the function. Cancellation token.

Initializes a new instance of the class.

To be added. Property 1.0.5.34676 SpicyPixel.Threading.Fiber

Gets the antecedent, which is the fiber that this fiber was dependent upon for starting execution.

The antecedent. The antecedent provides access to a prior result through `GetAsResultObject()`. Property 1.0.5.34676 System.Threading.CancellationToken

Gets the cancellation token for the Fiber.

The cancellation token. The token is made available because coroutines don't have a convenient way to get at it otherwise. This way, an executing coroutine can: ``` Fiber.CurrentFiber.CancellationToken.ThrowIfCancellationRequested(); ``` Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation coroutine.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. State.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. Continuation options.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. Scheduler.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. Cancellation token.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation coroutine. Continuation options.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation coroutine. Scheduler.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation coroutine. Cancellation token.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. State. Continuation options.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. State. Scheduler.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. State. Cancellation token.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. Cancellation token. Continuation options. Scheduler.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation coroutine. Cancellation token. Continuation options. Scheduler.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Continuation action. State. Cancellation token. Continuation options. Scheduler.

Creates a continuation that executes asynchronously when the target fiber completes.

A fiber that executes when the target fiber completes. To be added. Property 1.0.5.34676 SpicyPixel.Threading.Fiber

Gets the currently executing fiber on this thread.

The currently executing fiber on this thread. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Milliseconds to delay.

Crates a Fiber that waits for a delay before completing.

To be added. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Time span to delay.

Crates a Fiber that waits for a delay before completing.

To be added. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Milliseconds to delay. Cancellation token.

Crates a Fiber that waits for a delay before completing.

To be added. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Time span to delay. Cancellation token.

Crates a Fiber that waits for a delay before completing.

To be added. To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Milliseconds to delay. Cancellation token. Scheduler.

Crates a Fiber that waits for a delay before completing.

To be added. To be added. Property 1.0.5.34676 System.Exception

Gets the exception that led to the Faulted state.

The exception. To be added. Property 1.0.5.34676 SpicyPixel.Threading.FiberFactory

Gets the default factory for creating fibers.

The factory. To be added. Property 1.0.5.34676 System.Int32

Gets the thread unique identifier for the fiber.

The identifier. To be added. Property 1.0.5.34676 System.Boolean

Gets a value indicating whether this instance is canceled.

true if this instance is canceled; otherwise, false. To be added. Property 1.0.5.34676 System.Boolean

Gets a value indicating whether this instance is completed.

true if this instance is completed; otherwise, false. "Completed" means: * FiberStatus.RanToCompletion * FiberStatus.Canceled * FiberStatus.Faulted Property 1.0.5.34676 System.Boolean

Gets a value indicating whether this instance is faulted.

true if this instance is faulted; otherwise, false. See `Fiber.Exception` for the exception causing the fault. Property 1.0.5.34676 System.String

Gets or sets the name.

The name. To be added. Property 1.0.5.34676 System.Collections.Generic.IDictionary<System.String,System.Object>

Gets user-defined properties associated with the fiber.

The properties. Similar to thread local storage, callers may associate data with a fiber. A FiberStorage<T> class could retrieve data from the this property collection on the . Schedulers may also use this storage to associate additional data needed to perform scheduling operations. Property 1.0.5.34676 System.Object

Gets or sets the result of the fiber's execution as an object.

The result of the fiber's execution as an object. To be added. Method 1.0.5.34676 System.Void

Start executing the fiber using the default scheduler on the thread.

To be added. Method 1.0.5.34676 System.Void The scheduler to start the fiber on.

Start executing the fiber using the specified scheduler.

This method is safe to call from any thread even if different than the scheduler execution thread. Property 1.0.5.34676 SpicyPixel.Threading.FiberStatus

Gets or sets the state of the fiber.

The state of the fiber (Unstarted, Running, Stopped). To be added. Method 1.0.5.34676 System.Void

Throws if canceled.

To be added. Method 1.0.5.34676 System.Void

Throws if canceled or faulted.

To be added. Method 1.0.5.34676 System.Void

Throws if faulted.

To be added. Method 1.0.5.34676 SpicyPixel.Threading.Fiber System.ParamArray Fibers to wait for completion.

Returns a fiber that waits on all fibers to complete.

A fiber that waits on all fibers to complete. `Fiber.ResultAsObject` will be `true` if all fibers complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber System.ParamArray Tasks to wait for completion.

Returns a fiber that waits on all tasks to complete.

A fiber that waits on all tasks to complete. `Fiber.ResultAsObject` will be `true` if all tasks complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout.

Returns a fiber that waits on all fibers to complete.

A fiber that waits on all fibers to complete. `Fiber.ResultAsObject` will be `true` if all fibers complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Cancellation token.

Returns a fiber that waits on all fibers to complete.

A fiber that waits on all fibers to complete. `Fiber.ResultAsObject` will be `true` if all fibers complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Timeout.

Returns a fiber that waits on all fibers to complete.

A fiber that waits on all fibers to complete. `Fiber.ResultAsObject` will be `true` if all fibers complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout.

Returns a fiber that waits on all tasks to complete.

A fiber that waits on all tasks to complete. `Fiber.ResultAsObject` will be `true` if all tasks complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Cancellation token.

Returns a fiber that waits on all tasks to complete.

A fiber that waits on all tasks to complete. `Fiber.ResultAsObject` will be `true` if all tasks complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Timeout.

Returns a fiber that waits on all tasks to complete.

A fiber that waits on all tasks to complete. `Fiber.ResultAsObject` will be `true` if all tasks complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout. Cancellation token.

Returns a fiber that waits on all fibers to complete.

A fiber that waits on all fibers to complete. `Fiber.ResultAsObject` will be `true` if all fibers complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout. Cancellation token.

Returns a fiber that waits on all tasks to complete.

A fiber that waits on all tasks to complete. `Fiber.ResultAsObject` will be `true` if all tasks complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that waits on all fibers to complete.

A fiber that waits on all fibers to complete. `Fiber.ResultAsObject` will be `true` if all fibers complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that waits on all fibers to complete.

A fiber that waits on all fibers to complete. `Fiber.ResultAsObject` will be `true` if all fibers complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that waits on all tasks to complete.

A fiber that waits on all tasks to complete. `Fiber.ResultAsObject` will be `true` if all tasks complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that waits on all tasks to complete.

A fiber that waits on all tasks to complete. `Fiber.ResultAsObject` will be `true` if all tasks complete successfully or `false` if cancelled or timeout. Method 1.0.5.34676 SpicyPixel.Threading.Fiber System.ParamArray Fibers to wait for completion.

Returns a fiber that completes when any fiber finishes.

A fiber that completes when any fiber finishes. `Fiber.ResultAsObject` will be the `Fiber` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber System.ParamArray Tasks to wait for completion.

Returns a fiber that completes when any task finishes.

A fiber that completes when any task finishes. `Fiber.ResultAsObject` will be the `Task` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout.

Returns a fiber that completes when any fiber finishes.

A fiber that completes when any fiber finishes. `Fiber.ResultAsObject` will be the `Fiber` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Cancellation token.

Returns a fiber that completes when any fiber finishes.

A fiber that completes when any fiber finishes. `Fiber.ResultAsObject` will be the `Fiber` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Timeout.

Returns a fiber that completes when any fiber finishes.

A fiber that completes when any fiber finishes. `Fiber.ResultAsObject` will be the `Fiber` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout.

Returns a fiber that completes when any task finishes.

A fiber that completes when any task finishes. `Fiber.ResultAsObject` will be the `Task` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Cancellation token.

Returns a fiber that completes when any task finishes.

A fiber that completes when any task finishes. `Fiber.ResultAsObject` will be the `Task` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Timeout.

Returns a fiber that completes when any task finishes.

A fiber that completes when any task finishes. `Fiber.ResultAsObject` will be the `Task` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout. Cancellation token.

Returns a fiber that completes when any fiber finishes.

A fiber that completes when any fiber finishes. `Fiber.ResultAsObject` will be the `Fiber` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout. Cancellation token.

Returns a fiber that completes when any task finishes.

A fiber that completes when any task finishes. `Fiber.ResultAsObject` will be the `Task` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that completes when any fiber finishes.

A fiber that completes when any fiber finishes. `Fiber.ResultAsObject` will be the `Fiber` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Fibers to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that completes when any fiber finishes.

A fiber that completes when any fiber finishes. `Fiber.ResultAsObject` will be the `Fiber` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that completes when any task finishes.

A fiber that completes when any task finishes. `Fiber.ResultAsObject` will be the `Task` that completed. Method 1.0.5.34676 SpicyPixel.Threading.Fiber Tasks to wait for completion. Milliseconds timeout. Cancellation token. Scheduler.

Returns a fiber that completes when any task finishes.

A fiber that completes when any task finishes. `Fiber.ResultAsObject` will be the `Task` that completed.