Class CheckpointableExtensions
Extension methods for the ICheckpointable interface.
Inheritance
Namespace: Reaqtor.QueryEngine
Assembly: Reaqtor.QueryEngine.dll
Syntax
public static class CheckpointableExtensions : ObjectMethods
CheckpointAsync(ICheckpointable, IStateWriter)
Saves the state of the system to a store.
Declaration
public static Task CheckpointAsync(this ICheckpointable this, IStateWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| ICheckpointable | this | System whose state will be saved. |
| IStateWriter | writer | Writer to save state to. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |
CheckpointAsync(ICheckpointable, IStateWriter, IProgress<Int32>)
Saves the state of the system to a store.
Declaration
public static Task CheckpointAsync(this ICheckpointable this, IStateWriter writer, IProgress<int> progress)Parameters
| Type | Name | Description |
|---|---|---|
| ICheckpointable | this | System whose state will be saved. |
| IStateWriter | writer | Writer to save state to. |
| 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. |
CheckpointAsync(ICheckpointable, IStateWriter, CancellationToken)
Saves the state of the system to a store.
Declaration
public static Task CheckpointAsync(this ICheckpointable this, IStateWriter writer, CancellationToken token)Parameters
| Type | Name | Description |
|---|---|---|
| ICheckpointable | this | System whose state will be saved. |
| IStateWriter | writer | Writer to save state to. |
| System.Threading.CancellationToken | token | Cancellation token to observe cancellation requests. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |
RecoverAsync(ICheckpointable, IStateReader)
Recovers the state of the system from a store.
Declaration
public static Task RecoverAsync(this ICheckpointable this, IStateReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| ICheckpointable | this | System whose state will be loaded. |
| IStateReader | reader | Reader to load state from. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |
RecoverAsync(ICheckpointable, IStateReader, IProgress<Int32>)
Recovers the state of the system from a store.
Declaration
public static Task RecoverAsync(this ICheckpointable this, IStateReader reader, IProgress<int> progress)Parameters
| Type | Name | Description |
|---|---|---|
| ICheckpointable | this | System whose state will be loaded. |
| IStateReader | reader | Reader to load state from. |
| 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(ICheckpointable, IStateReader, CancellationToken)
Recovers the state of the system from a store.
Declaration
public static Task RecoverAsync(this ICheckpointable this, IStateReader reader, CancellationToken token)Parameters
| Type | Name | Description |
|---|---|---|
| ICheckpointable | this | System whose state will be loaded. |
| IStateReader | reader | Reader to load state from. |
| System.Threading.CancellationToken | token | Cancellation token to observe cancellation requests. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |
UnloadAsync(ICheckpointable)
Unloads the system.
Declaration
public static Task UnloadAsync(this ICheckpointable this)Parameters
| Type | Name | Description |
|---|---|---|
| ICheckpointable | this | System that will be unloaded. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task to observe the eventual completion of the operation. |