Snapshotter

org.apache.pekko.persistence.Snapshotter
trait Snapshotter extends Actor

Snapshot API on top of the internal snapshot protocol.

Attributes

Source
Snapshotter.scala
Graph
Supertypes
trait Actor
class Object
trait Matchable
class Any

Members list

Type members

Inherited types

type Receive = Receive

Attributes

Inherited from:
Actor
Source
Actor.scala

Value members

Abstract methods

Sequence number to use when taking a snapshot.

Sequence number to use when taking a snapshot.

Attributes

Source
Snapshotter.scala

Snapshotter id.

Snapshotter id.

Attributes

Source
Snapshotter.scala

Concrete methods

def deleteSnapshot(sequenceNr: Long): Unit

Deletes the snapshot identified by sequenceNr.

Deletes the snapshot identified by sequenceNr.

The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.

Attributes

Source
Snapshotter.scala

Deletes all snapshots matching criteria.

Deletes all snapshots matching criteria.

The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.

Attributes

Source
Snapshotter.scala
def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

Attributes

Source
Snapshotter.scala
def saveSnapshot(snapshot: Any): Unit

Saves a snapshot of this snapshotter's state.

Saves a snapshot of this snapshotter's state.

The PersistentActor will be notified about the success or failure of this via an SaveSnapshotSuccess or SaveSnapshotFailure message.

Attributes

Source
Snapshotter.scala

Inherited methods

User overridable callback: By default it calls preStart().

User overridable callback: By default it calls preStart().

Value parameters

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.

Attributes

Inherited from:
Actor
Source
Actor.scala
def postStop(): Unit

User overridable callback.

User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

Attributes

Inherited from:
Actor
Source
Actor.scala

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().'''

Value parameters

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.

reason

the Throwable that caused the restart to happen

Attributes

Inherited from:
Actor
Source
Actor.scala
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.

Attributes

Inherited from:
Actor
Source
Actor.scala

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.

Attributes

Inherited from:
Actor
Source
Actor.scala
final def sender(): ActorRef

The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in pekko.actor.ActorSystem.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

Attributes

Inherited from:
Actor
Source
Actor.scala

User overridable definition the strategy to use for supervising child actors.

User overridable definition the strategy to use for supervising child actors.

Attributes

Inherited from:
Actor
Source
Actor.scala
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 pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream

Attributes

Inherited from:
Actor
Source
Actor.scala

Implicits

Inherited implicits

implicit val context: ActorContext

Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

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!

pekko.actor.ActorContext is the Scala API. getContext returns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

Attributes

Inherited from:
Actor
Source
Actor.scala
final implicit 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

Attributes

Inherited from:
Actor
Source
Actor.scala