Id of the persistent entity for which messages should be replayed.
Id of the persistent entity for which messages should be replayed.
Command handler.
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
.
Recovery handler that receives persisted events during recovery.
Recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a 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.
INTERNAL API.
INTERNAL API.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API.
INTERNAL API.
INTERNAL API
INTERNAL API
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.
true
the first time the deliveryId
is confirmed, i.e. false
for duplicate confirm
#deliver
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 DeleteMessagesSuccess will be sent to the actor. If the delete fails a DeleteMessagesFailure will be sent to the actor.
The given toSequenceNr
must be less than or equal to Eventsourced#lastSequenceNr, otherwise
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
.
upper sequence number (inclusive) bound of persistent messages to be deleted.
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.
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.
Full state of the AtLeastOnceDelivery
.
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.
The returned StashOverflowStrategy object determines how to handle the message failed to stash when the internal Stash capacity exceeded.
The returned StashOverflowStrategy object determines how to handle the message failed to stash when the internal Stash capacity exceeded.
Configuration id of the journal plugin servicing this persistent actor.
Configuration id of the journal plugin servicing this persistent actor.
When empty, looks in akka.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
.
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.
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.
Maximum number of unconfirmed messages that this actor is allowed to hold in memory.
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
akka.persistence.at-least-once-delivery.max-unconfirmed-messages
configuration key. This method can be overridden by implementation classes to return
non-default values.
Number of messages that have not been confirmed yet.
Called when persist fails.
Called when persist fails. By default it logs the error. Subclass may override to customize logging and for example send negative acknowledgment to sender.
The actor is always stopped after this method has been invoked.
Note that the event may or may not have been saved, depending on the type of failure.
failure cause.
the event that was to be persisted
Called when the journal rejected persist
of an event.
Called when the journal rejected persist
of an event. The event was not
stored. By default this method logs the problem as an error, and the actor continues.
The callback handler that was passed to the persist
method will not be invoked.
failure cause
the event that was to be persisted
Called whenever a message replay fails.
Called whenever a message replay fails. By default it logs the error.
Subclass may override to customize logging.
The actor is always stopped after this method has been invoked.
failure cause.
the event that was processed in receiveRecover
, if the exception
was thrown there
Called when the persistent actor is started for the first time.
Called when the persistent actor is started for the first time. The returned Recovery object defines how the Actor will recover its persistent state before handling the first incoming message.
To skip recovery completely return Recovery.none
.
Returns true
if this persistent actor has successfully finished recovery.
Returns true
if this persistent actor has successfully finished recovery.
Returns true
if this persistent actor is currently recovering.
Returns true
if this persistent actor is currently recovering.
Interval between redelivery attempts.
Interval between redelivery attempts.
The default value can be configured with the
akka.persistence.at-least-once-delivery.redeliver-interval
configuration key. This method can be overridden by implementation classes to return
non-default values.
Maximum number of unconfirmed messages that will be sent at each redelivery burst (burst frequency is half of the redelivery interval).
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
akka.persistence.at-least-once-delivery.redelivery-burst-limit
configuration key. This method can be overridden by implementation classes to return
non-default values.
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.
If snapshot from #getDeliverySnapshot was saved it will be received during recovery in a SnapshotOffer message and should be set with this method.
Configuration id of the snapshot plugin servicing this persistent actor.
Configuration id of the snapshot plugin servicing this persistent actor.
When empty, looks in akka.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
.
Returns lastSequenceNr
.
Returns lastSequenceNr
.
Returns persistenceId
.
Returns persistenceId
.
After this number of delivery attempts an AtLeastOnceDelivery.UnconfirmedWarning message
will be sent to self
.
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
akka.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.
AtLeastOnceDelivery