Class TestSnapshotStore

In-memory persistence snapshot store implementation which behavior could be controlled by interceptors.

Inheritance
object
ActorBase
SnapshotStore
MemorySnapshotStore
TestSnapshotStore
Implements
Inherited Members
Namespace: Akka.Persistence.TestKit
Assembly: Akka.Persistence.TestKit.dll
Syntax
public class TestSnapshotStore : MemorySnapshotStore, IInternalActor

Methods

| Edit this page View Source

DeleteAsync(SnapshotMetadata, CancellationToken)

Plugin API: Deletes the snapshot identified by metadata.

This call is protected with a circuit-breaker

Declaration
protected override Task DeleteAsync(SnapshotMetadata metadata, CancellationToken cancellationToken)
Parameters
Type Name Description
SnapshotMetadata metadata

Snapshot metadata.
CancellationToken cancellationToken

CancellationToken used to signal cancelled snapshot operation
Returns
Type Description
Task
Overrides
| Edit this page View Source

DeleteAsync(string, SnapshotSelectionCriteria, CancellationToken)

Plugin API: Deletes all snapshots matching provided criteria.

This call is protected with a circuit-breaker

Declaration
protected override Task DeleteAsync(string persistenceId, SnapshotSelectionCriteria criteria, CancellationToken cancellationToken)
Parameters
Type Name Description
string persistenceId

Id of the persistent actor.
SnapshotSelectionCriteria criteria

Selection criteria for deleting.
CancellationToken cancellationToken

CancellationToken used to signal cancelled snapshot operation
Returns
Type Description
Task
Overrides
| Edit this page View Source

FromRef(IActorRef)

Create proxy object from snapshot store actor reference which can alter behavior of snapshot store.

Declaration
public static ITestSnapshotStore FromRef(IActorRef actor)
Parameters
Type Name Description
IActorRef actor

Journal actor reference.
Returns
Type Description
ITestSnapshotStore

Proxy object to control TestSnapshotStore.
Remarks

Snapshot store actor must be of TestSnapshotStore type.

| Edit this page View Source

LoadAsync(string, SnapshotSelectionCriteria, CancellationToken)

Plugin API: Asynchronously loads a snapshot.

This call is protected with a circuit-breaker

Declaration
protected override Task<SelectedSnapshot> LoadAsync(string persistenceId, SnapshotSelectionCriteria criteria, CancellationToken cancellationToken)
Parameters
Type Name Description
string persistenceId

Id of the persistent actor.
SnapshotSelectionCriteria criteria

Selection criteria for loading.
CancellationToken cancellationToken

CancellationToken used to signal cancelled snapshot operation
Returns
Type Description
Task<SelectedSnapshot>
Overrides
| Edit this page View Source

ReceivePluginInternal(object)

Plugin API: Allows plugin implementers to use f.PipeTo(Self) and handle additional messages for implementing advanced features

Declaration
protected override bool ReceivePluginInternal(object message)
Parameters
Type Name Description
object message

TBD
Returns
Type Description
bool

TBD
Overrides
| Edit this page View Source

SaveAsync(SnapshotMetadata, object, CancellationToken)

Plugin API: Asynchronously saves a snapshot.

This call is protected with a circuit-breaker

Declaration
protected override Task SaveAsync(SnapshotMetadata metadata, object snapshot, CancellationToken cancellationToken)
Parameters
Type Name Description
SnapshotMetadata metadata

Snapshot metadata.
object snapshot

Snapshot.
CancellationToken cancellationToken

CancellationToken used to signal cancelled snapshot operation
Returns
Type Description
Task
Overrides

Implements

Extension Methods