LoggingPersistentFSM
Related Doc:
package fsm
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.
This case object is received in case of a state timeout.
This case object is received in case of a state timeout.
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).
of the timer to cancel
Retrieve current rolling log in oldest-first order.
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.
Produce transition to other state.
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.
state designator for the next state
state transition descriptor
Inquire whether the named timer is still active.
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.
By default PersistentFSM.Failure is logged at error level and other reason types are not logged.
By default PersistentFSM.Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.
Return next state data (available in onTransition handlers)
Return next state data (available in onTransition handlers)
Set handler which is called upon termination of this FSM actor.
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 each state transition, i.e.
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.
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.
Set state timeout explicitly.
Set state timeout explicitly. This method can safely be used from within a state handler.
Schedule named timer to deliver message after given delay, possibly repeating.
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.
identifier to be used with cancelTimer()
message to be delivered
delay of first message delivery and between subsequent messages
send once if false, scheduleAtFixedRate if true
Set initial state.
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.
initial state designator
initial state data
state timeout for the initial state, overriding the default timeout for that state
Return current state data (i.e.
Return current state data (i.e. object of type D)
Return current state name (i.e.
Return current state name (i.e. object of type S)
Produce "empty" transition descriptor.
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.
descriptor for staying in current state
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor with reason "Normal".
Produce change descriptor to stop this FSM actor with reason "Normal".
Convenience wrapper for using a total function instead of a partial function literal.
Convenience wrapper for using a total function instead of a partial function literal. To be used with onTransition.
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. 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.
designator for the state
default state timeout for this state
partial function describing response to input
Set handler which is called upon reception of unhandled messages.
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
(loggingPersistentFSM: ArrowAssoc[LoggingPersistentFSM[S, D, E]]).->(y)
Stackable trait for akka.actor.FSM which adds a rolling event log and debug logging capabilities (analogous to akka.event.LoggingReceive).