IJournaledStateManager

1. Documentation
2. API reference
3. Microsoft.Orleans.Journaling
4. IJournaledStateManager

interface

Namespace: Orleans.Journaling

NuGetSourceMarkdown

Owns journal recovery and persistence for registered state machines.

public interface IJournaledStateManager : IAsyncDisposable

Remarks

The owner registers state machines and initializes the journal before using recovered state. State machine instances and their dependencies retain the lifetime assigned by their caller. Disposing this manager stops journal processing and releases its journal resources.

Properties

• PendingWriteByteCount Gets an approximate count of bytes accumulated in the in-memory journal buffer that have not yet been flushed to storage. Returns a negative value when the implementation does not support sampling pending bytes.

Methods

• DeleteStateAsync(CancellationToken) Resets this instance, removing any persistent state.
• InitializeAsync(CancellationToken) Initializes the state manager by replaying its journal.
• RegisterStateMachine(string, IStateMachine) Registers a state machine before initialization begins.
• TryGetStateMachine(string, IStateMachine?) Attempts to retrieve a registered state machine.
• WriteStateAsync(CancellationToken) Persists pending changes from the registered state machines to the journal.