SpicyPixel.Threading 1.0.5.34676 SpicyPixel.Threading.FiberScheduler

This class is the system default implementation of a and is capable of scheduling and executing fibers on the current thread.

Although no fibers execute after the scheduler is shutdown, none of the fibers are transitioned to a state and therefore it's not safe for a fiber to wait on a fiber outside of its own scheduler. This is currently enforced by for now although it would be possible to support fiber waits across schedulers in the future. Constructor 1.0.5.34676

Initializes a new instance of the class.

To be added. Method 1.0.5.34676 System.Void Disposing is true when called manually, false when called by the finalizer.

Dispose the scheduler.

When the scheduler is disposed, the is set. Property 1.0.5.34676 System.Threading.WaitHandle

Gets the dispose wait handle.

The dispose wait handle. Run monitors this handle for a Dispose to know when to terminate. Property 1.0.5.34676 System.Int32

Gets the executing fiber count.

The executing fiber count. This can be used to optimize a custom run loop. Method 1.0.5.34676 System.Boolean The time marker in seconds the first sleeping fiber needs to wake up. This is based on a previously passed time value to Update(). This value may be 0 if a sleeping fiber was aborted and therefore an update should process immediately.

Gets the time of the first fiber wake up.

True if there was a sleeping fiber, false otherwise. This method is primarily useful when manually calling Update() instead of Run() to know how long the thread can sleep for. Property 1.0.5.34676 System.Boolean

True if running

Is running. To be added. Method 1.0.5.34676 System.Void The fiber to queue.

Queues the fiber for execution on the scheduler.

Fibers queued from the scheduler thread will generally be executed inline whenever possible on most schedulers. Method 1.0.5.34676 System.Void The optional fiber to start execution from. If this is null, the loop will continue to execute until cancelled. Otherwise, the loop will terminate when the fiber terminates. A cancellation token that can be used to stop execution. Updates to all fibers per second. A value of 0 (the default) will execute fibers any time they are ready to do work instead of waiting to execute on a specific frequency.

Run the blocking scheduler loop and perform the specified number of updates per second.

Not all schedulers support a blocking run loop that can be invoked by the caller. The system scheduler is designed so that a custom run loop could be implemented by a derived type. Everything used to execute Run() is available to a derived scheduler. Property 1.0.5.34676 System.Threading.ManualResetEvent

Gets the run wait handle.

The run wait handle. The run wait handle is set when not running and used to coordinate Dispose and Run. Property 1.0.5.34676 System.Threading.WaitHandle

Gets a wait handle which can be used to wait for a scheduler event to occur.

The scheduler event wait handle. Scheduler events trigger this handle to be signaled. Events occur any time a fiber is added to an execution queue, whether because it is new or because it is moving from a wait queue to an execution queue. This handle is used to sleep in Run() when there are no events to process, and a scheduler with a custom run loop may do the same. Property 1.0.5.34676 System.Int32

Gets the sleeping fiber count.

The sleeping fiber count. This can be used to optimize a custom run loop. Method 1.0.5.34676 SpicyPixel.Threading.SystemFiberScheduler

Starts a new thread, creates a scheduler, starts it running, and returns it to the calling thread.

The scheduler from the spawned thread. To be added. Method 1.0.5.34676 SpicyPixel.Threading.SystemFiberScheduler A fiber to start execution from.

Starts a new thread, creates a scheduler, starts it running, and returns it to the calling thread.

The scheduler from the spawned thread. To be added. Method 1.0.5.34676 SpicyPixel.Threading.SystemFiberScheduler A token to cancel the thread. Updates to run per second.

Starts a new thread, creates a scheduler, starts it running, and returns it to the calling thread.

The scheduler from the spawned thread. To be added. Method 1.0.5.34676 SpicyPixel.Threading.SystemFiberScheduler A fiber to start execution from. A token to cancel the thread. Updates to run per second.

Starts a new thread, creates a scheduler, starts it running, and returns it to the calling thread.

The scheduler from the spawned thread. To be added. Method 1.0.5.34676 System.Void Time in seconds since the scheduler or application began running. This value is used to determine when to wake sleeping fibers. Using float instead of TimeSpan spares the GC.

Update the scheduler which causes all queued tasks to run for a cycle.

This method is useful when updating the scheduler manually with a custom run loop instead of calling .