SpicyPixel.Threading.Unity

Extends MonoBehaviour to support .

Creates a task factory using a initialized with the MonoBehaviour.

The task factory. Behaviour.

Creates a fiber factory using a initialized with the MonoBehaviour.

The fiber factory. Behaviour.

Creates the task scheduler.

The task scheduler. Behaviour.

Creates the fiber scheduler.

The fiber scheduler. Behaviour.

Provides a default fiber task scheduler for Unity using the default .

Gets the shared fiber task scheduler instance.

The shared fiber task scheduler instance bound to the .

Provides a task factory for Unity using the default .

Gets the shared task factory instance.

The shared task factory instance bound to .

that can execute fibers (yieldable coroutines) during the update cycle of a MonoBehaviour.

Gets the shared fiber scheduler instance.

The shared fiber scheduler instance bound to the shared .

The behaviour to use for scheduling with Unity.

When tasks are queued from another thread they must be added to a queue for processing on the scheduler thread.

The cancel source for the fiber queue. Used by Dispose().

Initializes a new instance of the class.

The behaviour to use for scheduling with Unity.

Queues the fiber for execution on the scheduler.

Fibers queued from the scheduler thread will generally be executed inline whenever possible on most schedulers. The fiber to queue.

Runs on the scheduler thread and dispatches all queued fibers.

Yield instructions.

Starts a fiber using the Unity scheduler.

This wraps the fiber in a special coroutine in order to convert between the framework and Unity. Additionally it saves the Unity coroutine and associates it with the fiber so it can be used later for wait operations. Note that Unity StartCoroutine will execute inline to the first yield. The fiber to start executing.

Wraps fiber execution to translate between framework and Unity concepts.

A yield instruction that Unity will understand. The fiber to execute. If true, the method only executes a single step before breaking. This is used when switching between two fibers using . This is the number of times a fiber switch has occured. 10 switches are allowed before unwinding in case Unity doesn't do this automatically.

Returns a that represents the current .

A that represents the current .

Dispose the scheduler.

Disposing.

This static class exposes convenience coroutines specific to Unity that can be passed to a fiber or task.

Convenience coroutine to repeat an action for the specified duration at the scheduler frequency.

A The action to execute. The seconds to execute for at the scheduler frequency.

Convenience class that extends MonoBehavior to provide a Scheduler and TaskFactory for executing tasks on the behaviour instance.

Derived classes must remember to use the override keyword when providing an implementation or the task factory will not be initialized.

Gets the shared instance valid for the lifetime of the application.

The shared instance valid until Unity raises OnApplicationQuit(). This instance can be used to create a scheduler and task factory not bound to a specific MonoBehaviour.

Gets the task factory.

The task factory.

Gets the task scheduler for queuing to this MonoBehaviour.

The scheduler.

Gets the fiber factory.

The fiber factory.

Gets the fiber scheduler for queuing to this MonoBehaviour.

The fiber scheduler.

Initializes the task factory during Awake().

The task factory cannot be initialized in the constructor because it must be initialized from the coroutine execution thread which the constructor does not guarantee.

Represents a fiber instruction to be processed by a .

Specific instructions understood by a scheduler are to be derived from this abstract type.

Convenience coroutine to send a instruction to the scheduler.

A instruction for a . The seconds to wait.

Convenience coroutine to send a WaitForFixedUpdate instruction to the scheduler.

A WaitForFixedUpdate instruction for a .

Convenience coroutine to send a WaitForEndOfFrame instruction to the scheduler.

A WaitForEndOfFrame instruction for a .

Unity synchronization context.

This singleton class provides SynchronizationContext functionality for Unity and can be set by using SynchronizationContext.SetSynchronizationContext.

Gets the singleton instance.

The singleton instance.

Extends Fiber for Unity

Gets the fiber as a Unity coroutine that can be yielded against.

The fiber as Unity coroutine. Fiber.

Provides a fiber factory for Unity using the default .

Gets the shared fiber factory instance.

The shared fiber factory instance bound to .