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.

INTERNAL API.

Can be overridden to intercept calls to postRestart. Calls postRestart by default.

INTERNAL API.

Can be overridden to intercept calls to postStop. Calls postStop by default.

INTERNAL API.

Can be overridden to intercept calls to preRestart. Calls preRestart by default.

INTERNAL API.

Can be overridden to intercept calls to preStart. Calls preStart by default.

INTERNAL API.

Can be overridden to intercept calls to this actor's current behavior.

Cancel named timer, ensuring that the message is not subsequently delivered (no race).

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.

Sends the supplied message to all current listeners using the provided sender() as sender.

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.

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. 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.

def receive = listenerManagement orElse …

By default FSM.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)

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. 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().

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.

Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

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.

Can be used to send messages to itself:

self ! 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. This method can safely be used from within a state handler.

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.

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.

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.

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.

Return current state data (i.e. object of type D)

Return current state name (i.e. object of type S)

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.

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".

User overridable definition the strategy to use for supervising child actors.

Convenience wrapper for using a total function instead of a partial function literal. To be used with onTransition.

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. 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.

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.

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.