Class SnapshotStore

Abstract snapshot store.

Inheritance

object

ActorBase

SnapshotStore

LocalSnapshotStore

MemorySnapshotStore

NoSnapshotStore

Implements

IInternalActor

Inherited Members

ActorBase.Sender

ActorBase.Self

ActorBase.Context

ActorBase.AroundReceive(Receive, object)

ActorBase.EmptyReceive

ActorBase.Unhandled(object)

ActorBase.Become(Receive)

ActorBase.BecomeStacked(Receive)

ActorBase.UnbecomeStacked()

ActorBase.SetReceiveTimeout(TimeSpan?)

ActorBase.AroundPreRestart(Exception, object)

ActorBase.AroundPreStart()

ActorBase.PreStart()

ActorBase.AroundPostRestart(Exception, object)

ActorBase.PreRestart(Exception, object)

ActorBase.PostRestart(Exception)

ActorBase.AroundPostStop()

ActorBase.PostStop()

ActorBase.SupervisorStrategy()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Persistence.Snapshot

Assembly: Akka.Persistence.dll

Syntax

public abstract class SnapshotStore : ActorBase, IInternalActor

Constructors

SnapshotStore()

Initializes a new instance of the SnapshotStore class.

Declaration

protected SnapshotStore()

Exceptions

Type	Condition
ArgumentException	This exception is thrown when the associated Persistence extension has not been used in current actor system context.

Methods

DeleteAsync(SnapshotMetadata, CancellationToken)

Plugin API: Deletes the snapshot identified by metadata.

This call is protected with a circuit-breaker

Declaration

protected abstract 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

DeleteAsync(string, SnapshotSelectionCriteria, CancellationToken)

Plugin API: Deletes all snapshots matching provided criteria.

This call is protected with a circuit-breaker

Declaration

protected abstract 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

LoadAsync(string, SnapshotSelectionCriteria, CancellationToken)

Plugin API: Asynchronously loads a snapshot.

This call is protected with a circuit-breaker

Declaration

protected abstract 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>

Receive(object)

Processor for user defined messages.

Declaration

protected override sealed bool Receive(object message)

Parameters

Type	Name	Description
object	message	The message.

Returns

Type	Description
bool	TBD

Overrides

ActorBase.Receive(object)

ReceivePluginInternal(object)

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

Declaration

protected virtual bool ReceivePluginInternal(object message)

Parameters

Type	Name	Description
object	message	TBD

Returns

Type	Description
bool	TBD

SaveAsync(SnapshotMetadata, object, CancellationToken)

Plugin API: Asynchronously saves a snapshot.

This call is protected with a circuit-breaker

Declaration

protected abstract 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

Implements

IInternalActor

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)