Class SnapshotStore
Abstract snapshot store.
Implements
Inherited Members
Namespace: Akka.Persistence.Snapshot
Assembly: Akka.Persistence.dll
Syntax
public abstract class SnapshotStore : ActorBase, IInternalActor
Constructors
| Edit this page View SourceSnapshotStore()
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
| Edit this page View SourceDeleteAsync(SnapshotMetadata)
Plugin API: Deletes the snapshot identified by metadata
.
This call is protected with a circuit-breaker
Declaration
protected abstract Task DeleteAsync(SnapshotMetadata metadata)
Parameters
Type | Name | Description |
---|---|---|
SnapshotMetadata | metadata | Snapshot metadata. |
Returns
Type | Description |
---|---|
Task | TBD |
DeleteAsync(string, SnapshotSelectionCriteria)
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)
Parameters
Type | Name | Description |
---|---|---|
string | persistenceId | Id of the persistent actor. |
SnapshotSelectionCriteria | criteria | Selection criteria for deleting. |
Returns
Type | Description |
---|---|
Task | TBD |
LoadAsync(string, SnapshotSelectionCriteria)
Plugin API: Asynchronously loads a snapshot.
This call is protected with a circuit-breaker
Declaration
protected abstract Task<SelectedSnapshot> LoadAsync(string persistenceId, SnapshotSelectionCriteria criteria)
Parameters
Type | Name | Description |
---|---|---|
string | persistenceId | Id of the persistent actor. |
SnapshotSelectionCriteria | criteria | Selection criteria for loading. |
Returns
Type | Description |
---|---|
Task<SelectedSnapshot> | TBD |
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
| Edit this page View SourceReceivePluginInternal(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)
Plugin API: Asynchronously saves a snapshot.
This call is protected with a circuit-breaker
Declaration
protected abstract Task SaveAsync(SnapshotMetadata metadata, object snapshot)
Parameters
Type | Name | Description |
---|---|---|
SnapshotMetadata | metadata | Snapshot metadata. |
object | snapshot | Snapshot. |
Returns
Type | Description |
---|---|
Task | TBD |