pekko-persistence-mongodb
API
Generated with
pekko-persistence-mongodb/pekko.contrib.persistence.mongodb/MongoSnapshots

MongoSnapshots

pekko.contrib.persistence.mongodb.MongoSnapshots
class MongoSnapshots(config: Config) extends SnapshotStore

Attributes

Graph
Supertypes
trait SnapshotStore
trait ActorLogging
trait Actor
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited types

type Receive = Receive

Attributes

Inherited from:
Actor

Value members

Concrete methods

override def deleteAsync(metadata: SnapshotMetadata): Future[Unit]

Plugin API: deletes the snapshot identified by metadata.

Plugin API: deletes the snapshot identified by metadata.

Value parameters

metadata

snapshot metadata.

Attributes

Definition Classes
SnapshotStore
override def deleteAsync(persistenceId: String, criteria: SnapshotSelectionCriteria): Future[Unit]

Plugin API: deletes all snapshots matching criteria.

Plugin API: deletes all snapshots matching criteria.

Value parameters

criteria

selection criteria for deleting.

persistenceId

id of the persistent actor.

Attributes

Definition Classes
SnapshotStore
override def loadAsync(processorId: String, criteria: SnapshotSelectionCriteria): Future[Option[SelectedSnapshot]]

Plugin API: asynchronously loads a snapshot.

Plugin API: asynchronously loads a snapshot.

Value parameters

criteria

selection criteria for loading.

processorId

processor id.

Attributes

Definition Classes
SnapshotStore
override def receivePluginInternal: Receive

Plugin API Allows plugin implementers to use f pipeTo self and handle additional messages for implementing advanced features

Plugin API Allows plugin implementers to use f pipeTo self and handle additional messages for implementing advanced features

Attributes

Definition Classes
SnapshotStore
override def saveAsync(metadata: SnapshotMetadata, snapshot: Any): Future[Unit]

Plugin API: asynchronously saves a snapshot.

Plugin API: asynchronously saves a snapshot.

Value parameters

metadata

snapshot metadata.

snapshot

snapshot.

Attributes

Definition Classes
SnapshotStore

Inherited methods

def log: LoggingAdapter

Attributes

Inherited from:
ActorLogging
def postRestart(reason: Throwable): Unit

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
def postStop(): Unit

User overridable callback.

User overridable callback.

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

Attributes

Inherited from:
Actor
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().'''

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
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
final def receive: Receive

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:
SnapshotStore
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
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.

Attributes

Inherited from:
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 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

Inherited fields

final val receiveSnapshotStore: Receive

Attributes

Inherited from:
SnapshotStore

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
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
Generated with