AtLeastOnceDeliveryLike
Attributes
- See also
- Source
- AtLeastOnceDelivery.scala
- Graph
-
- Supertypes
-
trait PersistenceRecoverytrait PersistenceIdentitytrait PersistenceStashtrait Stashtrait UnrestrictedStashtrait Snapshottertrait Actorclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Members list
Type members
Inherited types
Attributes
- Inherited from:
- Actor
- Source
- Actor.scala
Value members
Concrete methods
Call this method when a message has been confirmed by the destination, or to abort re-sending.
Call this method when a message has been confirmed by the destination, or to abort re-sending.
Attributes
- Returns
-
truethe first time thedeliveryIdis confirmed, i.e.falsefor duplicate confirm - See also
-
#deliver
- Source
- AtLeastOnceDelivery.scala
Full state of the AtLeastOnceDelivery. It can be saved with PersistentActor#saveSnapshot. During recovery the snapshot received in SnapshotOffer should be set with setDeliverySnapshot.
Full state of the AtLeastOnceDelivery. It can be saved with PersistentActor#saveSnapshot. During recovery the snapshot received in SnapshotOffer should be set with setDeliverySnapshot.
The AtLeastOnceDeliverySnapshot contains the full delivery state, including unconfirmed messages. If you need a custom snapshot for other parts of the actor state you must also include the AtLeastOnceDeliverySnapshot. It is serialized using protobuf with the ordinary Akka serialization mechanism. It is easiest to include the bytes of the AtLeastOnceDeliverySnapshot as a blob in your custom snapshot.
Attributes
- Source
- AtLeastOnceDelivery.scala
Maximum number of unconfirmed messages that this actor is allowed to hold in memory. If this number is exceed #deliver will not accept more messages and it will throw AtLeastOnceDelivery.MaxUnconfirmedMessagesExceededException.
Maximum number of unconfirmed messages that this actor is allowed to hold in memory. If this number is exceed #deliver will not accept more messages and it will throw AtLeastOnceDelivery.MaxUnconfirmedMessagesExceededException.
The default value can be configured with the pekko.persistence.at-least-once-delivery.max-unconfirmed-messages configuration key. This method can be overridden by implementation classes to return non-default values.
Attributes
- Source
- AtLeastOnceDelivery.scala
Number of messages that have not been confirmed yet.
Interval between redelivery attempts.
Interval between redelivery attempts.
The default value can be configured with the pekko.persistence.at-least-once-delivery.redeliver-interval configuration key. This method can be overridden by implementation classes to return non-default values.
Attributes
- Source
- AtLeastOnceDelivery.scala
Maximum number of unconfirmed messages that will be sent at each redelivery burst (burst frequency is half of the redelivery interval). If there's a lot of unconfirmed messages (e.g. if the destination is not available for a long time), this helps to prevent an overwhelming amount of messages to be sent at once.
Maximum number of unconfirmed messages that will be sent at each redelivery burst (burst frequency is half of the redelivery interval). If there's a lot of unconfirmed messages (e.g. if the destination is not available for a long time), this helps to prevent an overwhelming amount of messages to be sent at once.
The default value can be configured with the pekko.persistence.at-least-once-delivery.redelivery-burst-limit configuration key. This method can be overridden by implementation classes to return non-default values.
Attributes
- Source
- AtLeastOnceDelivery.scala
If snapshot from getDeliverySnapshot was saved it will be received during recovery in a SnapshotOffer message and should be set with this method.
If snapshot from getDeliverySnapshot was saved it will be received during recovery in a SnapshotOffer message and should be set with this method.
Attributes
- Source
- AtLeastOnceDelivery.scala
After this number of delivery attempts an AtLeastOnceDelivery.UnconfirmedWarning message will be sent to self. The count is reset after a restart.
After this number of delivery attempts an AtLeastOnceDelivery.UnconfirmedWarning message will be sent to self. The count is reset after a restart.
The default value can be configured with the pekko.persistence.at-least-once-delivery.warn-after-number-of-unconfirmed-attempts configuration key. This method can be overridden by implementation classes to return non-default values.
Attributes
- Source
- AtLeastOnceDelivery.scala
Inherited methods
Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.
Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.
If the delete is successful a pekko.persistence.DeleteMessagesSuccess will be sent to the actor. If the delete fails a pekko.persistence.DeleteMessagesFailure will be sent to the actor.
The given toSequenceNr must be less than or equal to Eventsourced#lastSequenceNr, otherwise pekko.persistence.DeleteMessagesFailure is sent to the actor without performing the delete. All persistent messages may be deleted without specifying the actual sequence number by using Long.MaxValue as the toSequenceNr.
Value parameters
- toSequenceNr
-
upper sequence number (inclusive) bound of persistent messages to be deleted.
Attributes
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
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
- Inherited from:
- Snapshotter
- 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
- Inherited from:
- Snapshotter
- Source
- Snapshotter.scala
The returned pekko.persistence.StashOverflowStrategy object determines how to handle the message failed to stash when the internal Stash capacity exceeded.
The returned pekko.persistence.StashOverflowStrategy object determines how to handle the message failed to stash when the internal Stash capacity exceeded.
Attributes
- Inherited from:
- PersistenceStash
- Source
- Persistence.scala
Configuration id of the journal plugin servicing this persistent actor. When empty, looks in pekko.persistence.journal.plugin to find configuration entry path. When configured, uses journalPluginId as absolute path to the journal configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.
Configuration id of the journal plugin servicing this persistent actor. When empty, looks in pekko.persistence.journal.plugin to find configuration entry path. When configured, uses journalPluginId as absolute path to the journal configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.
Attributes
- Inherited from:
- PersistenceIdentity
- Source
- Persistence.scala
Highest received sequence number so far or 0L if this actor hasn't replayed or stored any persistent events yet.
Highest received sequence number so far or 0L if this actor hasn't replayed or stored any persistent events yet.
Attributes
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
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
- Inherited from:
- Snapshotter
- Source
- Snapshotter.scala
Id of the persistent entity for which messages should be replayed.
Id of the persistent entity for which messages should be replayed.
Attributes
- Inherited from:
- PersistenceIdentity
- Source
- Persistence.scala
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
Overridden callback. Prepends all messages in the stash to the mailbox and clears the stash. Must be called when overriding this method, otherwise stashed messages won't be propagated to DeadLetters when actor stops.
Overridden callback. Prepends all messages in the stash to the mailbox and clears the stash. Must be called when overriding this method, otherwise stashed messages won't be propagated to DeadLetters when actor stops.
Attributes
- Definition Classes
- Inherited from:
- UnrestrictedStash
- Source
- Stash.scala
Overridden callback. Prepends all messages in the stash to the mailbox, clears the stash, stops all children and invokes the postStop() callback.
Overridden callback. Prepends all messages in the stash to the mailbox, clears the stash, stops all children and invokes the postStop() callback.
Attributes
- Definition Classes
- Inherited from:
- UnrestrictedStash
- Source
- Stash.scala
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
Command handler. Typically validates commands against current state (and/or by communication with other actors). On successful validation, one or more events are derived from a command and these events are then persisted by calling persist.
Command handler. Typically validates commands against current state (and/or by communication with other actors). On successful validation, one or more events are derived from a command and these events are then persisted by calling persist.
Attributes
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
Recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a pekko.persistence.SnapshotOffer message followed by events that are younger than the offered snapshot.
Recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a pekko.persistence.SnapshotOffer message followed by events that are younger than the offered snapshot.
This handler must not have side-effects other than changing persistent actor state i.e. it should not perform actions that may fail, such as interacting with external services, for example.
If there is a problem with recovering the state of the actor from the journal, the error will be logged and the actor will be stopped.
Attributes
- See also
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
Called when the persistent actor is started for the first time. The returned pekko.persistence.Recovery object defines how the Actor will recover its persistent state before handling the first incoming message.
Called when the persistent actor is started for the first time. The returned pekko.persistence.Recovery object defines how the Actor will recover its persistent state before handling the first incoming message.
To skip recovery completely return Recovery.none.
Attributes
- Inherited from:
- PersistenceRecovery
- Source
- Persistence.scala
Returns true if this persistent actor has successfully finished recovery.
Returns true if this persistent actor has successfully finished recovery.
Attributes
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
Returns true if this persistent actor is currently recovering.
Returns true if this persistent actor is currently recovering.
Attributes
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
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
- Inherited from:
- Snapshotter
- Source
- Snapshotter.scala
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
Configuration id of the snapshot plugin servicing this persistent actor. When empty, looks in pekko.persistence.snapshot-store.plugin to find configuration entry path. When configured, uses snapshotPluginId as absolute path to the snapshot store configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.
Configuration id of the snapshot plugin servicing this persistent actor. When empty, looks in pekko.persistence.snapshot-store.plugin to find configuration entry path. When configured, uses snapshotPluginId as absolute path to the snapshot store configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.
Attributes
- Inherited from:
- PersistenceIdentity
- Source
- Persistence.scala
Returns lastSequenceNr.
Returns persistenceId.
Returns persistenceId.
Attributes
- Definition Classes
-
Eventsourced -> Snapshotter
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
Adds the current message (the message that the actor received last) to the actor's stash.
Adds the current message (the message that the actor received last) to the actor's stash.
Attributes
- Throws
-
java.lang.IllegalStateException
if the same message is stashed more than once
pekko.actor.StashOverflowExceptionin case of a stash capacity violation
- Definition Classes
-
Eventsourced -> StashSupport
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.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
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
- Definition Classes
-
Eventsourced -> Actor
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
Prepends all messages in the stash to the mailbox, and then clears the stash.
Prepends all messages in the stash to the mailbox, and then clears the stash.
Messages from the stash are enqueued to the mailbox until the capacity of the mailbox (if any) has been reached. In case a bounded mailbox overflows, a MessageQueueAppendFailedException is thrown.
The stash is guaranteed to be empty after calling unstashAll().
Attributes
- Definition Classes
-
Eventsourced -> StashSupport
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
Implicits
Inherited implicits
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
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