A FSM implementation with persistent state.
Supports the usual pekko.actor.FSM functionality with additional persistence features. PersistentFSM is identified by 'persistenceId' value. State changes are persisted atomically together with domain events, which means that either both succeed or both fail, i.e. a state transition event will not be stored if persistence of an event related to that change fails. Persistence execution order is: persist -> wait for ack -> apply state. Incoming messages are deferred until the state is applied. State Data is constructed based on domain events, according to user's implementation of applyEvent function.
Attributes
- Companion
- object
- Deprecated
- true
- Source
- PersistentFSM.scala
- Graph
-
- Supertypes
-
trait ActorLoggingtrait Listenerstrait PersistentActortrait PersistenceRecoverytrait PersistenceIdentitytrait PersistenceStashtrait Stashtrait UnrestrictedStashtrait Snapshottertrait Actorclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
Members list
Type members
Inherited classlikes
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
- Supertypes
-
class Objecttrait Matchableclass Any
Inherited types
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- Actor
- Source
- Actor.scala
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Value members
Abstract 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
Attributes
- Returns
-
updated state data
- Source
- PersistentFSM.scala
Concrete methods
Override this handler to define the action on recovery completion
Override this handler to define the action on recovery completion
Attributes
- Source
- PersistentFSM.scala
After recovery events are handled as in usual FSM actor
After recovery events are handled as in usual FSM actor
Attributes
- Definition Classes
-
Eventsourced
- Source
- PersistentFSM.scala
Discover the latest recorded state
Discover the latest recorded state
Attributes
- Definition Classes
-
Eventsourced
- Source
- PersistentFSM.scala
Save the current state as a snapshot
Inherited methods
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
Attributes
- 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
Attributes
- 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
Attributes
- 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.
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
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.
Attributes
- 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
Attributes
- 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.
Attributes
- 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.
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.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
Chain this into the receive function.
Chain this into the receive function.
def receive = listenerManagement orElse …
Attributes
- 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.
Attributes
- Inherited from:
- Snapshotter
- Source
- Snapshotter.scala
Attributes
- Inherited from:
- ActorLogging
- Source
- Actor.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.
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Return next state data (available in onTransition handlers)
Return next state data (available in onTransition handlers)
Attributes
- 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.
Attributes
- Inherited from:
- PersistentFSMBase
- 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.
Attributes
- Inherited from:
- PersistentFSMBase
- 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
Attributes
- 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
Attributes
- 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
Attributes
- 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
Attributes
- 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.
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
Call onTermination hook; if you want to retain this behavior when overriding make sure to call super.postStop().
Call onTermination hook; if you want to retain this behavior when overriding make sure to call super.postStop().
Please note that this method is called by default from preRestart(), so override that one if onTermination shall not be called during restart.
Attributes
- Definition Classes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.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
- Definition Classes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.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.
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
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.
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.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
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.
Attributes
- 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.
Attributes
- 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.
Attributes
- 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 pekko.actor.Actor#preStart and pekko.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 pekko.actor.Actor#preStart and pekko.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
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.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
-
IllegalStateException
if the same message is stashed more than once
StashOverflowExceptionin case of a stash capacity violation
- Definition Classes
-
Eventsourced -> StashSupport
- Inherited from:
- Eventsourced (hidden)
- Source
- Eventsourced.scala
Return current state data (i.e. object of type D)
Return current state data (i.e. object of type D)
Attributes
- 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)
Attributes
- 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.
Attributes
- 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.
Attributes
- 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.
Attributes
- 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".
Attributes
- 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.
Attributes
- Inherited from:
- Actor
- Source
- Actor.scala
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.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
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
Attributes
- 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.
Attributes
- Inherited from:
- PersistentFSMBase
- 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
Attributes
- Deprecated
-
[Since version Akka 2.6.0] - Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Concrete fields
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
Attributes
- Source
- PersistentFSM.scala
Map from state identifier to state instance
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.
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- PersistentFSMBase
- 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.
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala
Attributes
- Inherited from:
- Listeners
- Source
- Listeners.scala
Implicits
Implicits
Enables to pass a ClassTag of a domain event base type from the implementing class
Enables to pass a ClassTag of a domain event base type from the implementing class
Attributes
- Returns
-
scala.reflect.ClassTag of domain event base type
- Source
- PersistentFSM.scala
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
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.
Attributes
- Inherited from:
- PersistentFSMBase
- Source
- PersistentFSMBase.scala