# IStateMachine Methods

[Type overview](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/)

## OnRecoveryCompleted {#onrecoverycompleted-ec2ecfb4}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/methods/onrecoverycompleted-ec2ecfb4/)

[Source](https://github.com/dotnet/orleans/blob/6a0e937f544c35ffcf11b37e4c2b7de5a1580a03/src/Orleans.Durable/Journaling/IStateMachine.cs#L70)

```csharp
public virtual void OnRecoveryCompleted()
```

Notifies the state that all prior journal entries and snapshots have been applied.

## OnWriteCompleted {#onwritecompleted-5ee0375e}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/methods/onwritecompleted-5ee0375e/)

[Source](https://github.com/dotnet/orleans/blob/6a0e937f544c35ffcf11b37e4c2b7de5a1580a03/src/Orleans.Durable/Journaling/IStateMachine.cs#L112)

```csharp
public virtual void OnWriteCompleted()
```

Notifies the state that all prior journal entries and snapshots which it has written have been written to stable storage.

## PrepareWriteAsync(CancellationToken) {#preparewriteasync-system-threading-cancellationtoken-d1de03ea}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/methods/preparewriteasync-system-threading-cancellationtoken-d1de03ea/)

[Source](https://github.com/dotnet/orleans/blob/6a0e937f544c35ffcf11b37e4c2b7de5a1580a03/src/Orleans.Durable/Journaling/IStateMachine.cs#L89)

```csharp
public virtual ValueTask PrepareWriteAsync(CancellationToken cancellationToken = default(CancellationToken))
```

Establishes the persistence prerequisites for this state's pending changes.

### Parameters

- `cancellationToken` (`CancellationToken`): The token which cancels preparation when the journal owner stops.

### Returns

A completion representing readiness to capture this state.

## ReplayEntry(JournalEntry, JournalReplayContext) {#replayentry-orleans-durable-journaling-journalentry-orleans-durable-journaling-j-e75261c2}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/methods/replayentry-orleans-durable-journaling-journalentry-orleans-durable-journaling-j-e75261c2/)

```csharp
public abstract void ReplayEntry(JournalEntry entry, JournalReplayContext context)
```

Replays one entry during journal recovery.

### Parameters

- `entry` (`JournalEntry`): The entry to replay.
- `context` (`JournalReplayContext`): The replay context.

## Reset(JournalStreamWriter) {#reset-orleans-durable-journaling-journalstreamwriter-a0cda5c6}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/methods/reset-orleans-durable-journaling-journalstreamwriter-a0cda5c6/)

```csharp
public abstract void Reset(JournalStreamWriter writer)
```

Resets the state.

### Parameters

- `writer` (`JournalStreamWriter`)

## WritePendingEntries(JournalStreamWriter) {#writependingentries-orleans-durable-journaling-journalstreamwriter-0b8cb41b}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/methods/writependingentries-orleans-durable-journaling-journalstreamwriter-0b8cb41b/)

```csharp
public abstract void WritePendingEntries(JournalStreamWriter writer)
```

Writes pending state changes to the journal.

### Parameters

- `writer` (`JournalStreamWriter`): The journal stream writer.

## WriteSnapshot(JournalStreamWriter) {#writesnapshot-orleans-durable-journaling-journalstreamwriter-f5c11b06}

[Dedicated page](/orleans/docs/api/csharp/microsoft.orleans.durable/orleans.durable.journaling.istatemachine/methods/writesnapshot-orleans-durable-journaling-journalstreamwriter-f5c11b06/)

```csharp
public abstract void WriteSnapshot(JournalStreamWriter writer)
```

Writes a snapshot of the state to the provided writer.

### Parameters

- `writer` (`JournalStreamWriter`): The journal stream writer.
