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.
Default reason if calling stop()
.
Default reason if calling stop()
.
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.
This case object is received in case of a state timeout.
This case object is received in case of a state timeout.
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to postRestart
. Calls postRestart
by default.
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to postStop
. Calls postStop
by default.
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to preRestart
. Calls preRestart
by default.
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to preStart
. Calls preStart
by default.
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to this actor's current behavior.
current behavior.
current message.
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
Scala API: Stores the context for this actor, including self, and sender.
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.
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.
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.
Returns the ActorRef for this actor.
Returns the ActorRef for this actor.
Same as self()
.
The reference sender Actor of the currently processed message.
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!
Produce transition to other state.
Produce transition to other state. Return this from a state function in order to effect the transition.
state designator for the next state
state transition descriptor
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.
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
Verify existence of initial state and setup timers.
Verify existence of initial state and setup timers. This should be the last call within the constructor, or akka.actor.Actor#preStart and akka.actor.Actor#postRestart
An initial currentState -> currentState
notification will be triggered by calling this method.
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.
Chain this into the receive function.
Chain this into the receive function.
def receive = listenerManagement orElse …
By default FSM.Failure is logged at error level and other reason types are not logged.
By default FSM.Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.
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.
an action to apply to the event and state data if there is a match
the builder with the case statement added
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
a type to match the argument against
a predicate that will be evaluated on the argument if the type matches
an action to apply to the argument if the type and predicate matches
a builder with the case statement added
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
a type to match the argument against
an action to apply to the argument if the type matches
a builder with the case statement added
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.
a list of types or instances to match against
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
a list of types or instances to match against
the data type to match on
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
a predicate that will be evaluated on the data and the event
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
the event type to match on
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
the event type to match on
a predicate that will be evaluated on the data and the event
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
the event type to match on
the data type to match on
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
the event type to match on
the data type to match on
a predicate to evaluate on the matched types
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
an event to compare equal against
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
an event to compare equal against
the data type to match on
an action to apply to the event and state data if there is a match
the builder with the case statement added
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.
the from state to match on
the to state to match on
an action to apply when the states match
the builder with the case statement added
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.
the from state to match on
the to state to match on
an action to apply when the states match
the builder with the case statement added
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.
the reason type to match on
a predicate that will be evaluated on the reason if the type matches
an action to apply to the reason, event and state data if there is a match
the builder with the case statement added
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.
the reason type to match on
an action to apply to the reason, event and state data if there is a match
the builder with the case statement added
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 FSM.Reason.
the reason for the termination
an action to apply to the event and state data if there is a match
the builder with the case statement added
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 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.
Add a handler which is called upon each state transition, i.e.
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.
Add a handler which is called upon each state transition, i.e.
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.
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.
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.
Call onTermination
hook; if you want to retain this behavior when
overriding make sure to call super.postStop()
.
Scala API: User overridable callback: By default it disposes of all children and then calls postStop()
.
Scala API: User overridable callback: By default it disposes of all children and then calls postStop()
.
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.
User overridable callback.
User overridable callback.
Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
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!
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
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
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
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
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
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
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".
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
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.
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
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 builder describing response to input
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 builder describing response to input
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.
designator for the state
partial function builder describing response to input
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.
designator for the state
partial function describing response to input
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
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
(abstractLoggingFSM: ArrowAssoc[AbstractLoggingFSM[S, D]]).->(y)
Java API: compatible with lambda expressions
Finite State Machine actor abstract base class.