Can be overridden to intercept calls to postRestart
.
INTERNAL API.
INTERNAL API.
INTERNAL API.
INTERNAL API.
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
.
Returns this AbstractActor's AbstractActorContext The AbstractActorContext is not thread safe so do not expose it outside of the AbstractActor.
Returns this AbstractActor's AbstractActorContext The AbstractActorContext is not thread safe so do not expose it outside of the AbstractActor.
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()
).
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
.
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.
Set up the initial receive behavior of the Actor.
Set up the initial receive behavior of the Actor.
The receive behavior.
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.
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!
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()
.
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.
Java API: compatible with lambda expressions
An actor that persists (journals) messages of type Persistent. Messages of other types are not persisted.
Example:
During start and restart, persistent messages are replayed to a processor so that it can recover internal state from these messages. New messages sent to a processor during recovery do not interfere with replayed messages, hence applications don't need to wait for a processor to complete its recovery.
Automated recovery can be turned off or customized by overriding the preStart and preRestart life cycle hooks. If automated recovery is turned off, an application can explicitly recover a processor by sending it a Recover message.
Persistent messages are assigned sequence numbers that are generated on a per-processor basis. A sequence starts at
1L
and doesn't contain gaps unless a processor (logically) deletes a message.During recovery, a processor internally buffers new messages until recovery completes, so that new messages do not interfere with replayed messages. This internal buffer (the processor stash) is isolated from the user stash inherited by
akka.actor.Stash
.Processor
implementation classes can therefore use the user stash for stashing/unstashing both persistent and transient messages.Processors can also store snapshots of internal state by calling saveSnapshot. During recovery, a saved snapshot is offered to the processor with a SnapshotOffer message, followed by replayed messages, if any, that are younger than the snapshot. Default is to offer the latest saved snapshot.
(Since version 2.3.4) AbstractProcessor will be removed. Instead extend
akka.persistence.AbstractPersistentActor
and use it'spersistAsync(command)(callback)
method to get equivalent semantics.PersistentBatch
Recover
Processor