final class NoSnapshotStore extends SnapshotStore
Used as default snapshot-store in case no other store was configured.
If a akka.persistence.PersistentActor calls the akka.persistence.PersistentActor#saveSnapshot method,
and at the same time does not configure a specific snapshot-store to be used *and* no default snapshot-store
is available, then the NoSnapshotStore
will be used to signal a snapshot store failure.
- Source
- NoSnapshotStore.scala
- Alphabetic
- By Inheritance
- NoSnapshotStore
- SnapshotStore
- ActorLogging
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new NoSnapshotStore()
Type Members
- final class NoSnapshotStoreException extends RuntimeException
- type Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Value Members
- implicit val context: ActorContext
Scala API: Stores the context for this actor, including self, and sender.
Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as
forward
.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
akka.actor.ActorContext is the Scala API.
getContext
returns a akka.actor.AbstractActor.ActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
- def deleteAsync(persistenceId: String, criteria: SnapshotSelectionCriteria): Future[Unit]
Plugin API: deletes all snapshots matching
criteria
.Plugin API: deletes all snapshots matching
criteria
.This call is protected with a circuit-breaker.
- persistenceId
id of the persistent actor.
- criteria
selection criteria for deleting.
- Definition Classes
- NoSnapshotStore → SnapshotStore
- def deleteAsync(metadata: SnapshotMetadata): Future[Unit]
Plugin API: deletes the snapshot identified by
metadata
.Plugin API: deletes the snapshot identified by
metadata
.This call is protected with a circuit-breaker.
- metadata
snapshot metadata.
- Definition Classes
- NoSnapshotStore → SnapshotStore
- def loadAsync(persistenceId: String, criteria: SnapshotSelectionCriteria): Future[Option[SelectedSnapshot]]
Plugin API: asynchronously loads a snapshot.
Plugin API: asynchronously loads a snapshot.
If the future
Option
isNone
then all events will be replayed, i.e. there was no snapshot. If snapshot could not be loaded theFuture
should be completed with failure. That is important because events may have been deleted and just replaying the events might not result in a valid state.This call is protected with a circuit-breaker.
- persistenceId
id of the persistent actor.
- criteria
selection criteria for loading.
- Definition Classes
- NoSnapshotStore → SnapshotStore
- def log: LoggingAdapter
- Definition Classes
- ActorLogging
- def postRestart(reason: Throwable): Unit
User overridable callback: By default it calls
preStart()
.User overridable callback: By default it calls
preStart()
.- reason
the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
- Definition Classes
- Actor
- Annotations
- @throws(classOf[Exception])
- def postStop(): Unit
User overridable callback.
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
- Definition Classes
- Actor
- Annotations
- @throws(classOf[Exception])
- def preRestart(reason: Throwable, message: Option[Any]): Unit
Scala API: User overridable callback: By default it disposes of all children and then calls
postStop()
.Scala API: User overridable callback: By default it disposes of all children and then calls
postStop()
.- reason
the Throwable that caused the restart to happen
- message
optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.
- Definition Classes
- Actor
- Annotations
- @throws(classOf[Exception])
- def preStart(): Unit
User overridable callback.
User overridable callback.
Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
- Definition Classes
- Actor
- Annotations
- @throws(classOf[Exception])
- final def receive: PartialFunction[Any, Unit]
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
- Definition Classes
- SnapshotStore → Actor
- def receivePluginInternal: actor.Actor.Receive
Plugin API Allows plugin implementers to use
f pipeTo self
and handle additional messages for implementing advanced featuresPlugin API Allows plugin implementers to use
f pipeTo self
and handle additional messages for implementing advanced features- Definition Classes
- SnapshotStore
- final val receiveSnapshotStore: actor.Actor.Receive
- Definition Classes
- SnapshotStore
- def saveAsync(metadata: SnapshotMetadata, snapshot: Any): Future[Unit]
Plugin API: asynchronously saves a snapshot.
Plugin API: asynchronously saves a snapshot.
This call is protected with a circuit-breaker.
- metadata
snapshot metadata.
- snapshot
snapshot.
- Definition Classes
- NoSnapshotStore → SnapshotStore
- implicit final val self: ActorRef
The 'self' field holds the ActorRef for this actor.
The 'self' field holds the ActorRef for this actor.
Can be used to send messages to itself:
self ! message
- Definition Classes
- Actor
- final def sender(): ActorRef
The reference sender Actor of the last received message.
The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else
deadLetters
in akka.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
- def supervisorStrategy: SupervisorStrategy
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
- Definition Classes
- Actor
- def unhandled(message: Any): Unit
User overridable callback.
User overridable callback.
Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream
- Definition Classes
- Actor