Interface ICheckpointable
Represents a system that can be checkpointed.
Namespace: Reaqtor.QueryEngine
Assembly: Reaqtor.QueryEngine.Interfaces.dll
Syntax
public interface ICheckpointableMethods
CheckpointAsync(IStateWriter, CancellationToken, IProgress<Int32>)
Saves the state of the system to a store.
Declaration
Task CheckpointAsync(IStateWriter writer, CancellationToken token = null, IProgress<int> progress = null)Parameters
| Type | Name | Description |
|---|---|---|
| IStateWriter | writer | Writer to save state to. |
| System.Threading.CancellationToken | token | Cancellation token to observe cancellation requests. |
| System.IProgress<System.Int32> | progress | Progress indicator reporting progress percentages. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |
RecoverAsync(IStateReader, CancellationToken, IProgress<Int32>)
Recovers the state of the system from a store.
Declaration
Task RecoverAsync(IStateReader reader, CancellationToken token = null, IProgress<int> progress = null)Parameters
| Type | Name | Description |
|---|---|---|
| IStateReader | reader | Reader to load state from. |
| System.Threading.CancellationToken | token | Cancellation token to observe cancellation requests. |
| System.IProgress<System.Int32> | progress | Progress indicator reporting progress percentages. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |
UnloadAsync(IProgress<Int32>)
Unloads the system.
Declaration
Task UnloadAsync(IProgress<int> progress = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IProgress<System.Int32> | progress | Progress indicator reporting progress percentages. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |