Class GProgressiveTask

Namespace: Pinwheel.Griffin

Assembly: Pinwheel.Polaris.Runtime.dll

Coroutine-backed task handle returned by long-running Polaris operations. Can be yielded in a coroutine to wait for completion.

public class GProgressiveTask : CustomYieldInstruction, IEnumerator

Inheritance: object

CustomYieldInstruction

GProgressiveTask

Implements: IEnumerator

Inherited Members: CustomYieldInstruction.MoveNext()

CustomYieldInstruction.Reset()

CustomYieldInstruction.Current

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CancellationRequested: Set by the caller to request the task stop at the next safe point.

IsCancelled: True when the task was stopped mid-way by a Cancel() call.

IsCompleted: True when the task has finished, either successfully or by cancellation.

Progress: Execution progress in [0, 1].

keepWaiting: Keeps yielding while the task is still running.

Methods

Cancel(): Request cancellation. The coroutine will stop at its next check and call Abort().