This defines the initial actor behavior, it must return a partial function with the actor logic.
This defines the initial actor behavior, it must return a partial function with the actor logic.
Can be overridden to intercept calls to postRestart
.
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API
INTERNAL API.
INTERNAL API
INTERNAL API
current behavior.
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
Stores the context for this actor, including self, and sender.
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.UntypedActorContext, which is the Java API of the actor
context.
Deletes all persistent messages with sequence numbers less than or equal toSequenceNr
.
Deletes all persistent messages with sequence numbers less than or equal toSequenceNr
. If permanent
is set to false
, the persistent messages are marked as deleted in the journal, otherwise
they permanently deleted from the journal.
upper sequence number bound of persistent messages to be deleted.
if false
, the message is marked as deleted, otherwise it is permanently deleted.
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
.
upper sequence number bound of persistent messages to be deleted.
Deletes a snapshot identified by sequenceNr
and timestamp
.
Deletes a snapshot identified by sequenceNr
and timestamp
.
Deletes all snapshots matching criteria
.
Deletes all snapshots matching criteria
.
Scala API: Send the message created by the deliveryIdToMessage
function to
the destination
actor.
Scala API: Send the message created by the deliveryIdToMessage
function to
the destination
actor. It will retry sending the message until
the delivery is confirmed with #confirmDelivery. Correlation
between deliver
and confirmDelivery
is performed with the
deliveryId
that is provided as parameter to the deliveryIdToMessage
function. The deliveryId
is typically passed in the message to the
destination, which replies with a message containing the same deliveryId
.
The deliveryId
is a strictly monotonically increasing sequence number without
gaps. The same sequence is used for all destinations of the actor, i.e. when sending
to multiple destinations the destinations will see gaps in the sequence if no
translation is performed.
During recovery this method will not send out the message, but it will be sent
later if no matching confirmDelivery
was performed.
This method will throw AtLeastOnceDelivery.MaxUnconfirmedMessagesExceededException if numberOfUnconfirmed is greater than or equal to #maxUnconfirmedMessages.
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.
Highest received sequence number so far or 0L
if this actor hasn't received a persistent
message yet.
Highest received sequence number so far or 0L
if this actor hasn't received a persistent
message yet. Usually equal to the sequence number of currentPersistentMessage
(unless a
receiver implementation is about to re-order persistent messages using stash()
and unstash()
).
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.
Persistence id.
User overridable callback: By default it calls preStart()
.
User overridable callback: By default it calls preStart()
.
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.
Overridden callback.
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.
User-overridable callback.
User-overridable callback. Called before a processor is restarted. Default implementation sends
a Recover(lastSequenceNr)
message to self
if message
is defined, Recover() otherwise
.
the Throwable that caused the restart to happen
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.
Calls preRestart and then super.preRestart()
.
Calls preRestart and then super.preRestart()
. If processor implementation classes want to
opt out from stopping child actors, they should override this method and call preRestart only.
User-overridable callback.
User-overridable callback. Called when a processor is started. Default implementation sends
a Recover()
to self
.
Returns true
if this processor has successfully finished recovery.
Returns true
if this processor has successfully finished recovery.
Returns true
if this processor is currently recovering.
Returns true
if this processor 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.
Saves a snapshot
of this snapshotter's state.
Saves a snapshot
of this snapshotter's state. If saving succeeds, this snapshotter will receive a
SaveSnapshotSuccess message, otherwise a SaveSnapshotFailure message.
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
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!
If snapshot from #getDeliverySnapshot was saved it will be received during recovery in a SnapshotOffer message and should be set with this method.
Returns lastSequenceNr
.
Returns lastSequenceNr
.
Returns persistenceId
.
Returns persistenceId
.
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.
IllegalStateException
if the same message is stashed more than once
StashOverflowException
in case of a stash capacity violation
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
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
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()
.
After this number of delivery attempts a AtLeastOnceDelivery.UnconfirmedWarning message
will be sent to self
.
After this number of delivery attempts a 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.
Returns the current persistent message if there is any.
Returns the current persistent message if there is any.
(Since version 2.3.4) currentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr
.
Deletes a persistent message identified by sequenceNr
.
Deletes a persistent message identified by sequenceNr
. If permanent
is set to false
,
the persistent message is marked as deleted in the journal, otherwise it is permanently
deleted from the journal. A deleted message is not replayed during recovery. This method
is usually called inside preRestartProcessor
when a persistent message caused an exception.
Processors that want to re-receive that persistent message during recovery should not call
this method.
sequence number of the persistent message to be deleted.
if false
, the message is marked as deleted, otherwise it is permanently deleted.
(Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.
Marks a persistent message, identified by sequenceNr
, as deleted.
Marks a persistent message, identified by sequenceNr
, as deleted. A message marked as deleted is
not replayed during recovery. This method is usually called inside preRestartProcessor
when a
persistent message caused an exception. Processors that want to re-receive that persistent message
during recovery should not call this method.
sequence number of the persistent message to be deleted.
(Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.
Java API: returns the current persistent message or null
if there is none.
Java API: returns the current persistent message or null
if there is none.
(Since version 2.3.4) getCurrentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr
.
Processor id.
Processor id. Defaults to this processor's path and can be overridden.
(Since version 2.3.4) Override persistenceId: String
instead. Processor will be removed.
Mix-in this trait with your
PersistentActor
to send messages with at-least-once delivery semantics to destinations. It takes care of re-sending messages when they have not been confirmed within a configurable timeout. Use the #deliver method to send a message to a destination. Call the #confirmDelivery method when the destination has replied with a confirmation message.At-least-once delivery implies that original message send order is not always retained and the destination may receive duplicate messages due to possible resends.
The interval between redelivery attempts can be defined by #redeliverInterval. After a number of delivery attempts a AtLeastOnceDelivery.UnconfirmedWarning message will be sent to
self
. The re-sending will still continue, but you can choose to call #confirmDelivery to cancel the re-sending.The
AtLeastOnceDelivery
trait has a state consisting of unconfirmed messages and a sequence number. It does not store this state itself. You must persist events corresponding to thedeliver
andconfirmDelivery
invocations from yourPersistentActor
so that the state can be restored by calling the same methods during the recovery phase of thePersistentActor
. Sometimes these events can be derived from other business level events, and sometimes you must create separate events. During recovery calls todeliver
will not send out the message, but it will be sent later if no matchingconfirmDelivery
was performed.Support for snapshots is provided by #getDeliverySnapshot and #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 theAtLeastOnceDeliverySnapshot
. It is serialized using protobuf with the ordinary Akka serialization mechanism. It is easiest to include the bytes of theAtLeastOnceDeliverySnapshot
as a blob in your custom snapshot.