Interface ISequenceable

A ISequenceable object is run in a queue by a ISequencer<TSequenceable>. These objects can be run sequentially or in parallel with other ISequenceable objects.

Inherited Members
Namespace: IdleKit.Core
Assembly: cs.temp.dll.dll
Syntax
public interface ISequenceable : IProgressCompletable, IProgressable, ICompletable, IInjectable

Properties

IsCanceled

Returns true if this ISequenceable has been canceled.

Declaration
bool IsCanceled { get; }
Property Value
Type Description
Boolean

IsStarted

Returns true if this ISequenceable has been started.

Declaration
bool IsStarted { get; }
Property Value
Type Description
Boolean

Report

Returns a report that contains details on the processing of this ISequenceable.

Declaration
string Report { get; }
Property Value
Type Description
String

Methods

Cancel()

Cancels running this ISequenceable.

Declaration
void Cancel()

Cleanup()

Clears any state in this ISequenceable.

Declaration
void Cleanup()

Revert()

Rolls back any changes this ISequenceable made if possible.

Declaration
void Revert()

Start()

Starts running this ISequenceable.

Declaration
void Start()

Events

OnSequenceableCanceled

Broadcast when the ISequenceable is canceled.

Declaration
event Action<ISequenceable> OnSequenceableCanceled
Event Type
Type Description
Action<ISequenceable>

OnSequenceableCompleted

Broadcast when the ISequenceable finishes running.

Declaration
event Action<ISequenceable> OnSequenceableCompleted
Event Type
Type Description
Action<ISequenceable>

OnSequenceableException

Broadcast if an Exception occurs while running this ISequenceable.

Declaration
event Action<ISequenceable, Exception> OnSequenceableException
Event Type
Type Description
Action<ISequenceable, Exception>

OnSequenceableReverted

Broadcast when the ISequenceable is reverted.

Declaration
event Action<ISequenceable> OnSequenceableReverted
Event Type
Type Description
Action<ISequenceable>

OnSequenceableStarted

Broadcast when the ISequenceable starts running.

Declaration
event Action<ISequenceable> OnSequenceableStarted
Event Type
Type Description
Action<ISequenceable>