AbstractPersistentLoggingFSM
Java API: compatible with lambda expressions
Persistent Finite State Machine actor abstract base class with FSM Logging
- Deprecated
- Source:
- PersistentFSM.scala
Type members
Inherited classlikes
Inherited types
Value members
Inherited methods
Override this handler to define the action on Domain Event
Override this handler to define the action on Domain Event
- Value parameters:
- currentData
state data of the previous state
- domainEvent
domain event to apply
- Returns:
updated state data
- Inherited from:
- PersistentFSM
- Source:
- PersistentFSM.scala
Cancel named timer, ensuring that the message is not subsequently delivered (no race).
Cancel named timer, ensuring that the message is not subsequently delivered (no race).
- Value parameters:
- name
of the timer to cancel
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Defer the handler execution until all pending handlers have been executed. It is guaranteed that no new commands
will be received by a persistent actor between a call to defer
and the execution of its handler
.
Allows to define logic within the actor, which will respect the invocation-order-guarantee
in respect to persistAsync
or persist
calls. That is, if persistAsync
or persist
was invoked before defer
,
the corresponding handlers will be invoked in the same order as they were registered in.
Defer the handler execution until all pending handlers have been executed. It is guaranteed that no new commands
will be received by a persistent actor between a call to defer
and the execution of its handler
.
Allows to define logic within the actor, which will respect the invocation-order-guarantee
in respect to persistAsync
or persist
calls. That is, if persistAsync
or persist
was invoked before defer
,
the corresponding handlers will be invoked in the same order as they were registered in.
This call will NOT result in event
being persisted, use persist
or persistAsync
instead
if the given event should possible to replay.
If there are no pending persist handler calls, the handler will be called immediately.
If persistence of an earlier event fails, the persistent actor will stop, and the handler
will not be run.
- Value parameters:
- event
event to be handled in the future, when preceding persist operations have been processes
- handler
handler for the given
event
- Inherited from:
- PersistentActor
- Source:
- PersistentActor.scala
Defer the handler execution until all pending handlers have been executed.
Allows to define logic within the actor, which will respect the invocation-order-guarantee
in respect to persistAsync
or persist
calls. That is, if persistAsync
or persist
was invoked before deferAsync
,
the corresponding handlers will be invoked in the same order as they were registered in.
Defer the handler execution until all pending handlers have been executed.
Allows to define logic within the actor, which will respect the invocation-order-guarantee
in respect to persistAsync
or persist
calls. That is, if persistAsync
or persist
was invoked before deferAsync
,
the corresponding handlers will be invoked in the same order as they were registered in.
This call will NOT result in event
being persisted, use persist
or persistAsync
instead
if the given event should possible to replay.
If there are no pending persist handler calls, the handler will be called immediately.
If persistence of an earlier event fails, the persistent actor will stop, and the handler
will not be run.
- Value parameters:
- event
event to be handled in the future, when preceding persist operations have been processes
- handler
handler for the given
event
- Inherited from:
- PersistentActor
- Source:
- PersistentActor.scala
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
.
- Value parameters:
- toSequenceNr
upper sequence number (inclusive) bound of persistent messages to be deleted.
- Inherited from:
- Eventsourced
- 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.
- 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.
- Inherited from:
- Snapshotter
- Source:
- Snapshotter.scala
Domain event's Class Used for identifying domain events during recovery
Domain event's Class Used for identifying domain events during recovery
- Inherited from:
- AbstractPersistentFSM
- Source:
- PersistentFSM.scala
Adapter from Java Class to scala.reflect.ClassTag
Adapter from Java Class to scala.reflect.ClassTag
- Returns:
domain event scala.reflect.ClassTag
- Definition Classes
- Inherited from:
- AbstractPersistentFSM
- Source:
- PersistentFSM.scala
Adapter from Java 8 Functional Interface to Scala Function
Adapter from Java 8 Functional Interface to Scala Function
- Value parameters:
- action
- Java 8 lambda expression defining the action
- Returns:
action represented as a Scala Function
- Inherited from:
- AbstractPersistentFSM
- Source:
- PersistentFSM.scala
Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.
Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Retrieve current rolling log in oldest-first order. The log is filled with each incoming event before processing by the user supplied state handler. The log entries are lost when this actor is restarted.
Retrieve current rolling log in oldest-first order. The log is filled with each incoming event before processing by the user supplied state handler. The log entries are lost when this actor is restarted.
- Inherited from:
- LoggingPersistentFSM
- Source:
- PersistentFSMBase.scala
Returns the ActorRef for this actor.
Returns the ActorRef for this actor.
Same as self()
.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.
The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.
Same as sender()
.
WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Produce transition to other state. Return this from a state function in order to effect the transition.
Produce transition to other state. Return this from a state function in order to effect the transition.
- Value parameters:
- nextStateName
state designator for the next state
- Returns:
state transition descriptor
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Sends the supplied message to all current listeners using the provided sender() as sender.
Sends the supplied message to all current listeners using the provided sender() as sender.
- Inherited from:
- Listeners
- Source:
- Listeners.scala
Produce transition to other state. Return this from a state function in order to effect the transition.
Produce transition to other state. Return this from a state function in order to effect the transition.
This method always triggers transition events, even for A -> A
transitions.
If you want to stay in the same state without triggering an state transition event use stay instead.
- Value parameters:
- nextStateName
state designator for the next state
- Returns:
state transition descriptor
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
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.
- Inherited from:
- PersistenceStash
- Source:
- Persistence.scala
Inquire whether the named timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer whose message was already received.
Inquire whether the named timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer whose message was already received.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
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
.
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
.
- 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.
- Inherited from:
- Eventsourced
- Source:
- Eventsourced.scala
Chain this into the receive function.
Chain this into the receive function.
def receive = listenerManagement orElse …
- Inherited from:
- Listeners
- Source:
- Listeners.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.
- Inherited from:
- Snapshotter
- Source:
- Snapshotter.scala
By default PersistentFSM.Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.
By default PersistentFSM.Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches on any type of event.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
- Value parameters:
- apply
an action to apply to the argument if the type and predicate matches
- dataType
a type to match the argument against
- predicate
a predicate that will be evaluated on the argument if the type matches
- Returns:
a builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
- Value parameters:
- apply
an action to apply to the argument if the type matches
- dataType
a type to match the argument against
- Returns:
a builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches if any of the event types in the list match or any of the event instances in the list compares equal.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- eventMatches
a list of types or instances to match against
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches on the data type and if any of the event types in the list match or any of the event instances in the list compares equal.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- dataType
the data type to match on
- eventMatches
a list of types or instances to match against
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches if the predicate matches.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- predicate
a predicate that will be evaluated on the data and the event
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches if the event type matches.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- eventType
the event type to match on
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches if the event type and predicate matches.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- eventType
the event type to match on
- predicate
a predicate that will be evaluated on the data and the event
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches on an event and data type.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- dataType
the data type to match on
- eventType
the event type to match on
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches on an event and data type and a predicate.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- dataType
the data type to match on
- eventType
the event type to match on
- predicate
a predicate to evaluate on the matched types
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches if the event compares equal.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- event
an event to compare equal against
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.
A case statement that matches on the data type and if the event compares equal.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- dataType
the data type to match on
- event
an event to compare equal against
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.
Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.
A case statement that matches on a from state and a to state.
- Value parameters:
- apply
an action to apply when the states match
- fromState
the from state to match on
- toState
the to state to match on
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.
Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.
A case statement that matches on a from state and a to state.
- Value parameters:
- apply
an action to apply when the states match
- fromState
the from state to match on
- toState
the to state to match on
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStopBuilder with the first case statement set.
Create an akka.japi.pf.FSMStopBuilder with the first case statement set.
A case statement that matches on a reason type and a predicate.
- Value parameters:
- apply
an action to apply to the reason, event and state data if there is a match
- predicate
a predicate that will be evaluated on the reason if the type matches
- reasonType
the reason type to match on
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStopBuilder with the first case statement set.
Create an akka.japi.pf.FSMStopBuilder with the first case statement set.
A case statement that matches on a reason type.
- Value parameters:
- apply
an action to apply to the reason, event and state data if there is a match
- reasonType
the reason type to match on
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Create an akka.japi.pf.FSMStopBuilder with the first case statement set.
Create an akka.japi.pf.FSMStopBuilder with the first case statement set.
A case statement that matches on an PersistentFSM.Reason.
- Value parameters:
- apply
an action to apply to the event and state data if there is a match
- reason
the reason for the termination
- Returns:
the builder with the case statement added
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Return next state data (available in onTransition handlers)
Return next state data (available in onTransition handlers)
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Override this handler to define the action on recovery completion
Override this handler to define the action on recovery completion
- Inherited from:
- PersistentFSM
- Source:
- PersistentFSM.scala
Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.
Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.
Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Set handler which is called upon each state transition, i.e. not when staying in the same state. This may use the pair extractor defined in the FSM companion object like so:
Set handler which is called upon each state transition, i.e. not when staying in the same state. This may use the pair extractor defined in the FSM companion object like so:
onTransition { case Old -> New => doSomething }
It is also possible to supply a 2-ary function object:
onTransition(handler _) private def handler(from: S, to: S) { ... }
The underscore is unfortunately necessary to enable the nicer syntax shown above (it uses the implicit conversion total2pf under the hood).
Multiple handlers may be installed, and every one of them will be called, not only the first one matching.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Add a handler which is called upon each state transition, i.e. not when staying in the same state.
Add a handler which is called upon each state transition, i.e. not when staying in the same state.
Multiple handlers may be installed, and every one of them will be called, not only the first one matching.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Add a handler which is called upon each state transition, i.e. not when staying in the same state.
Add a handler which is called upon each state transition, i.e. not when staying in the same state.
Multiple handlers may be installed, and every one of them will be called, not only the first one matching.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Asynchronously persists event
. On successful persistence, handler
is called with the
persisted event. It is guaranteed that no new commands will be received by a persistent actor
between a call to persist
and the execution of its handler
. This also holds for
multiple persist
calls per received command. Internally, this is achieved by stashing new
commands and unstashing them when the event
has been persisted and handled. The stash used
for that is an internal stash which doesn't interfere with the inherited user stash.
Asynchronously persists event
. On successful persistence, handler
is called with the
persisted event. It is guaranteed that no new commands will be received by a persistent actor
between a call to persist
and the execution of its handler
. This also holds for
multiple persist
calls per received command. Internally, this is achieved by stashing new
commands and unstashing them when the event
has been persisted and handled. The stash used
for that is an internal stash which doesn't interfere with the inherited user stash.
An event handler
may close over persistent actor state and modify it. The sender
of a persisted
event is the sender of the corresponding command. This means that one can reply to a command
sender within an event handler
.
Within an event handler, applications usually update persistent actor state using persisted event data, notify listeners and reply to command senders.
If persistence of an event fails, onPersistFailure will be invoked and the actor will unconditionally be stopped. The reason that it cannot resume when persist fails is that it is unknown if the event was actually persisted or not, and therefore it is in an inconsistent state. Restarting on persistent failures will most likely fail anyway, since the journal is probably unavailable. It is better to stop the actor and after a back-off timeout start it again.
- Value parameters:
- event
event to be persisted
- handler
handler for each persisted
event
- Inherited from:
- PersistentActor
- Source:
- PersistentActor.scala
Asynchronously persists events
in specified order. This is equivalent to calling
persist[A](event: A)(handler: A => Unit)
multiple times with the same handler
,
except that events
are persisted atomically with this method.
Asynchronously persists events
in specified order. This is equivalent to calling
persist[A](event: A)(handler: A => Unit)
multiple times with the same handler
,
except that events
are persisted atomically with this method.
- Value parameters:
- events
events to be persisted
- handler
handler for each persisted
events
- Inherited from:
- PersistentActor
- Source:
- PersistentActor.scala
Asynchronously persists events
in specified order. This is equivalent to calling
persistAsync[A](event: A)(handler: A => Unit)
multiple times with the same handler
,
except that events
are persisted atomically with this method.
Asynchronously persists events
in specified order. This is equivalent to calling
persistAsync[A](event: A)(handler: A => Unit)
multiple times with the same handler
,
except that events
are persisted atomically with this method.
- Value parameters:
- events
events to be persisted
- handler
handler for each persisted
events
- Inherited from:
- PersistentActor
- Source:
- PersistentActor.scala
Asynchronously persists event
. On successful persistence, handler
is called with the
persisted event.
Asynchronously persists event
. On successful persistence, handler
is called with the
persisted event.
Unlike persist
the persistent actor will continue to receive incoming commands between the
call to persist
and executing it's handler
. This asynchronous, non-stashing, version of
of persist should be used when you favor throughput over the "command-2 only processed after
command-1 effects' have been applied" guarantee, which is provided by the plain persist
method.
An event handler
may close over persistent actor state and modify it. The sender
of a persisted
event is the sender of the corresponding command. This means that one can reply to a command
sender within an event handler
.
If persistence of an event fails, onPersistFailure will be invoked and the actor will unconditionally be stopped. The reason that it cannot resume when persist fails is that it is unknown if the event was actually persisted or not, and therefore it is in an inconsistent state. Restarting on persistent failures will most likely fail anyway, since the journal is probably unavailable. It is better to stop the actor and after a back-off timeout start it again.
- Value parameters:
- event
event to be persisted
- handler
handler for each persisted
event
- Inherited from:
- PersistentActor
- Source:
- PersistentActor.scala
Id of the persistent entity for which messages should be replayed.
Id of the persistent entity for which messages should be replayed.
- 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.
- Inherited from:
- Actor
- Source:
- Actor.scala
- Definition Classes
- Inherited from:
- AbstractPersistentFSM
- Source:
- PersistentFSM.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.
- 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.
- Inherited from:
- Actor
- Source:
- Actor.scala
After recovery events are handled as in usual FSM actor
After recovery events are handled as in usual FSM actor
- Definition Classes
- PersistentFSM -> Eventsourced
- Inherited from:
- PersistentFSM
- Source:
- PersistentFSM.scala
Discover the latest recorded state
Discover the latest recorded state
- Definition Classes
- PersistentFSM -> Eventsourced
- Inherited from:
- PersistentFSM
- Source:
- PersistentFSM.scala
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.
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
.
- 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.
- Inherited from:
- Eventsourced
- Source:
- Eventsourced.scala
Returns true
if this persistent actor is currently recovering.
Returns true
if this persistent actor is currently recovering.
- Inherited from:
- Eventsourced
- 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.
- Inherited from:
- Snapshotter
- Source:
- Snapshotter.scala
Save the current state as a snapshot
Save the current state as a snapshot
- Inherited from:
- PersistentFSM
- Source:
- PersistentFSM.scala
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.
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!
- Inherited from:
- Actor
- Source:
- Actor.scala
Set state timeout explicitly. This method can safely be used from within a state handler.
Set state timeout explicitly. This method can safely be used from within a state handler.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
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
.
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
.
- Inherited from:
- PersistenceIdentity
- Source:
- Persistence.scala
Returns lastSequenceNr
.
Returns lastSequenceNr
.
- Inherited from:
- Eventsourced
- Source:
- Eventsourced.scala
Returns persistenceId
.
Returns persistenceId
.
- Definition Classes
- Eventsourced -> Snapshotter
- Inherited from:
- Eventsourced
- Source:
- Eventsourced.scala
Start a timer that will send msg
once to the self
actor after
the given delay
.
Start a timer that will send msg
once to the self
actor after
the given delay
.
Each timer has a name
and if a new timer with same name
is started
the previous is cancelled. It is guaranteed that a message from the
previous timer is not received, even if it was already enqueued
in the mailbox when the new timer was started.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Start a timer that will send msg
once to the self
actor after
the given delay
.
Start a timer that will send msg
once to the self
actor after
the given delay
.
Each timer has a name
and if a new timer with same name
is started
the previous is cancelled. It is guaranteed that a message from the
previous timer is not received, even if it was already enqueued
in the mailbox when the new timer was started.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Schedules a message to be sent repeatedly to the self
actor with a
given frequency.
Schedules a message to be sent repeatedly to the self
actor with a
given frequency.
It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.
If the execution is delayed longer than the interval
, the subsequent message will
be sent immediately after the prior one. This also has the consequence that after
long garbage collection pauses or other reasons when the JVM was suspended all
"missed" messages will be sent when the process wakes up again.
In the long run, the frequency of messages will be exactly the reciprocal of the
specified interval
.
Warning: startTimerAtFixedRate
can result in bursts of scheduled messages after long
garbage collection pauses, which may in worst case cause undesired load on the system.
Therefore startTimerWithFixedDelay
is often preferred.
Each timer has a name
and if a new timer with same name
is started
the previous is cancelled. It is guaranteed that a message from the
previous timer is not received, even if it was already enqueued
in the mailbox when the new timer was started.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Schedules a message to be sent repeatedly to the self
actor with a
given frequency.
Schedules a message to be sent repeatedly to the self
actor with a
given frequency.
It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.
If the execution is delayed longer than the interval
, the subsequent message will
be sent immediately after the prior one. This also has the consequence that after
long garbage collection pauses or other reasons when the JVM was suspended all
"missed" messages will be sent when the process wakes up again.
In the long run, the frequency of messages will be exactly the reciprocal of the
specified interval
.
Warning: startTimerAtFixedRate
can result in bursts of scheduled messages after long
garbage collection pauses, which may in worst case cause undesired load on the system.
Therefore startTimerWithFixedDelay
is often preferred.
Each timer has a name
and if a new timer with same name
is started
the previous is cancelled. It is guaranteed that a message from the
previous timer is not received, even if it was already enqueued
in the mailbox when the new timer was started.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Schedules a message to be sent repeatedly to the self
actor with a
fixed delay
between messages.
Schedules a message to be sent repeatedly to the self
actor with a
fixed delay
between messages.
It will not compensate the delay between messages if scheduling is delayed
longer than specified for some reason. The delay between sending of subsequent
messages will always be (at least) the given delay
.
In the long run, the frequency of messages will generally be slightly lower than
the reciprocal of the specified delay
.
Each timer has a name
and if a new timer with same name
is started
the previous is cancelled. It is guaranteed that a message from the
previous timer is not received, even if it was already enqueued
in the mailbox when the new timer was started.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Schedules a message to be sent repeatedly to the self
actor with a
fixed delay
between messages.
Schedules a message to be sent repeatedly to the self
actor with a
fixed delay
between messages.
It will not compensate the delay between messages if scheduling is delayed
longer than specified for some reason. The delay between sending of subsequent
messages will always be (at least) the given delay
.
In the long run, the frequency of messages will generally be slightly lower than
the reciprocal of the specified delay
.
Each timer has a name
and if a new timer with same name
is started
the previous is cancelled. It is guaranteed that a message from the
previous timer is not received, even if it was already enqueued
in the mailbox when the new timer was started.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Set initial state. Call this method from the constructor before the initialize method. If different state is needed after a restart this method, followed by initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
Set initial state. Call this method from the constructor before the initialize method. If different state is needed after a restart this method, followed by initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
- Value parameters:
- stateData
initial state data
- stateName
initial state designator
- timeout
state timeout for the initial state, overriding the default timeout for that state
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Set initial state. Call this method from the constructor before the initialize method. If different state is needed after a restart this method, followed by initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
Set initial state. Call this method from the constructor before the initialize method. If different state is needed after a restart this method, followed by initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
- Value parameters:
- stateData
initial state data
- stateName
initial state designator
- timeout
state timeout for the initial state, overriding the default timeout for that state
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Set initial state. Call this method from the constructor before the initialize method. If different state is needed after a restart this method, followed by initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
Set initial state. Call this method from the constructor before the initialize method. If different state is needed after a restart this method, followed by initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
- Value parameters:
- stateData
initial state data
- stateName
initial state designator
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Return current state data (i.e. object of type D)
Return current state data (i.e. object of type D)
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Return current state name (i.e. object of type S)
Return current state name (i.e. object of type S)
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Produce "empty" transition descriptor. Return this from a state function when no state change is to be effected.
Produce "empty" transition descriptor. Return this from a state function when no state change is to be effected.
No transition event will be triggered by stay.
If you want to trigger an event like S -> S
for onTransition
to handle use goto
instead.
- Returns:
descriptor for staying in current state
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Produce change descriptor to stop this FSM actor with reason "Normal".
Produce change descriptor to stop this FSM actor with reason "Normal".
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
- Inherited from:
- Actor
- Source:
- Actor.scala
Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.
Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.
- Value parameters:
- stateFunction
partial function describing response to input
- stateName
designator for the state
- stateTimeout
default state timeout for this state
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.
Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.
- Value parameters:
- stateFunctionBuilder
partial function builder describing response to input
- stateName
designator for the state
- stateTimeout
default state timeout for this state
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Insert a new StateFunction at the end of the processing chain for the given state.
Insert a new StateFunction at the end of the processing chain for the given state.
- Value parameters:
- stateFunctionBuilder
partial function builder describing response to input
- stateName
designator for the state
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Insert a new StateFunction at the end of the processing chain for the given state.
Insert a new StateFunction at the end of the processing chain for the given state.
- Value parameters:
- stateFunction
partial function describing response to input
- stateName
designator for the state
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.
Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.
The current state may be queried using stateName
.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.
Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.
The current state may be queried using stateName
.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Deprecated and Inherited methods
Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.
Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.
- Value parameters:
- msg
message to be delivered
- name
identifier to be used with cancelTimer()
- repeat
send once if false, scheduleAtFixedRate if true
- timeout
delay of first message delivery and between subsequent messages
- Deprecated
[Since version 2.6.0]
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.
Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.
- Value parameters:
- msg
message to be delivered
- name
identifier to be used with cancelTimer()
- timeout
delay of first message delivery and between subsequent messages
- Deprecated
[Since version 2.6.0]
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Inherited fields
This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.
This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Default reason if calling stop()
.
Default reason if calling stop()
.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
Reason given when someone was calling system.stop(fsm)
from outside;
also applies to Stop
supervision directive.
Reason given when someone was calling system.stop(fsm)
from outside;
also applies to Stop
supervision directive.
- Inherited from:
- AbstractPersistentFSMBase
- Source:
- PersistentFSMBase.scala
This case object is received in case of a state timeout.
This case object is received in case of a state timeout.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala
Domain event's scala.reflect.ClassTag Used for identifying domain events during recovery
Domain event's scala.reflect.ClassTag Used for identifying domain events during recovery
- Inherited from:
- PersistentFSM
- Source:
- PersistentFSM.scala
Map from state identifier to state instance
Map from state identifier to state instance
- Inherited from:
- PersistentFSM
- Source:
- PersistentFSM.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!
akka.actor.ActorContext is the Scala API. getContext
returns a
akka.actor.AbstractActor.ActorContext, which is the Java API of the actor
context.
- 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
- Inherited from:
- Actor
- Source:
- Actor.scala
Convenience wrapper for using a total function instead of a partial function literal. To be used with onTransition.
Convenience wrapper for using a total function instead of a partial function literal. To be used with onTransition.
- Inherited from:
- PersistentFSMBase
- Source:
- PersistentFSMBase.scala