abstract class AbstractLoggingFSM[S, D] extends AbstractFSM[S, D] with LoggingFSM[S, D]
Java API: compatible with lambda expressions
Finite State Machine actor abstract base class.
This is an EXPERIMENTAL feature and is subject to change until it has received more real world testing.
- Source
- AbstractFSM.scala
- Alphabetic
- By Inheritance
- AbstractLoggingFSM
- LoggingFSM
- AbstractFSM
- FSM
- ActorLogging
- Listeners
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new AbstractLoggingFSM()
Type Members
-
type
Event = FSM.Event[D]
- Definition Classes
- FSM
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
-
type
State = FSM.State[S, D]
- Definition Classes
- FSM
-
type
StateFunction = PartialFunction[Event, State]
- Definition Classes
- FSM
-
type
StopEvent = FSM.StopEvent[S, D]
- Definition Classes
- FSM
-
type
Timeout = Option[FiniteDuration]
- Definition Classes
- FSM
-
type
TransitionHandler = PartialFunction[(S, S), Unit]
- Definition Classes
- FSM
-
final
class
TransformHelper
extends AnyRef
- Definition Classes
- FSM
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to any2stringadd[AbstractLoggingFSM[S, D]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
val
->: FSM.->.type
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.
- Definition Classes
- FSM
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
Event: FSM.Event.type
- Definition Classes
- FSM
-
val
Normal: Reason
Default reason if calling
stop().Default reason if calling
stop().- Definition Classes
- AbstractFSM
-
val
Shutdown: Reason
Reason given when someone was calling
system.stop(fsm)from outside; also applies toStopsupervision directive.Reason given when someone was calling
system.stop(fsm)from outside; also applies toStopsupervision directive.- Definition Classes
- AbstractFSM
-
val
StateTimeout: FSM.StateTimeout.type
This case object is received in case of a state timeout.
This case object is received in case of a state timeout.
- Definition Classes
- FSM
-
val
StopEvent: FSM.StopEvent.type
- Definition Classes
- FSM
-
def
aroundPostRestart(reason: Throwable): Unit
Can be overridden to intercept calls to
postRestart. -
def
aroundPostStop(): Unit
Can be overridden to intercept calls to
postStop. -
def
aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
Can be overridden to intercept calls to
preRestart. -
def
aroundPreStart(): Unit
Can be overridden to intercept calls to
preStart. -
def
aroundReceive(receive: Actor.Receive, msg: Any): Unit
INTERNAL API.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
cancelTimer(name: String): Unit
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).
- name
of the timer to cancel
- Definition Classes
- FSM
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
implicit
val
context: ActorContext
Stores the context for this actor, including self, and sender.
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.
getContextreturns a akka.actor.UntypedActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
-
def
ensuring(cond: (AbstractLoggingFSM[S, D]) ⇒ Boolean, msg: ⇒ Any): AbstractLoggingFSM[S, D]
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to Ensuring[AbstractLoggingFSM[S, D]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (AbstractLoggingFSM[S, D]) ⇒ Boolean): AbstractLoggingFSM[S, D]
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to Ensuring[AbstractLoggingFSM[S, D]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): AbstractLoggingFSM[S, D]
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to Ensuring[AbstractLoggingFSM[S, D]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): AbstractLoggingFSM[S, D]
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to Ensuring[AbstractLoggingFSM[S, D]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to StringFormat[AbstractLoggingFSM[S, D]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getLog: IndexedSeq[LogEntry[S, D]]
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.
- Attributes
- protected
- Definition Classes
- LoggingFSM
-
final
def
goTo(nextStateName: S): State
Produce transition to other state.
Produce transition to other state. Return this from a state function in order to effect the transition.
- nextStateName
state designator for the next state
- returns
state transition descriptor
- Definition Classes
- AbstractFSM
-
def
gossip(msg: Any)(implicit sender: ActorRef = Actor.noSender): Unit
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
- protected
- Definition Classes
- Listeners
-
final
def
goto(nextStateName: S): State
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 -> Atransitions. If you want to stay in the same state without triggering an state transition event use #stay instead.- nextStateName
state designator for the next state
- returns
state transition descriptor
- Definition Classes
- FSM
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
initialize(): Unit
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 -> currentStatenotification will be triggered by calling this method.- Definition Classes
- FSM
- See also
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
isTimerActive(name: String): Boolean
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.
- Definition Classes
- FSM
-
def
listenerManagement: Actor.Receive
Chain this into the receive function.
Chain this into the receive function.
def receive = listenerManagement orElse …- Attributes
- protected
- Definition Classes
- Listeners
-
val
listeners: Set[ActorRef]
- Attributes
- protected
- Definition Classes
- Listeners
-
def
log: LoggingAdapter
- Definition Classes
- ActorLogging
-
def
logDepth: Int
- Definition Classes
- LoggingFSM
-
def
logTermination(reason: Reason): Unit
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.
- Attributes
- protected
- Definition Classes
- FSM
-
final
def
matchAnyEvent(apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]
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.
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchData[DT <: D](dataType: Class[DT], predicate: TypedPredicate[DT], apply: UnitApply[DT]): UnitPFBuilder[D]
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
- dataType
a type to match the argument against
- predicate
a predicate that will be evaluated on the argument if the type matches
- apply
an action to apply to the argument if the type and predicate matches
- returns
a builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchData[DT <: D](dataType: Class[DT], apply: UnitApply[DT]): UnitPFBuilder[D]
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
Create a akka.japi.pf.UnitPFBuilder with the first case statement set.
- dataType
a type to match the argument against
- apply
an action to apply to the argument if the type matches
- returns
a builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEvent(eventMatches: List[AnyRef], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]
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.
- eventMatches
a list of types or instances to match against
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEvent[DT <: D](eventMatches: List[AnyRef], dataType: Class[DT], apply: Apply2[AnyRef, DT, State]): FSMStateFunctionBuilder[S, D]
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.
- eventMatches
a list of types or instances to match against
- dataType
the data type to match on
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEvent(predicate: TypedPredicate2[AnyRef, D], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]
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.
- predicate
a predicate that will be evaluated on the data and the event
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEvent[ET](eventType: Class[ET], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D]
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.
- eventType
the event type to match on
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEvent[ET](eventType: Class[ET], predicate: TypedPredicate2[ET, D], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D]
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.
- eventType
the event type to match on
- predicate
a predicate that will be evaluated on the data and the event
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D]
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.
- eventType
the event type to match on
- dataType
the data type to match on
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], predicate: TypedPredicate2[ET, DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D]
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.
- eventType
the event type to match on
- dataType
the data type to match on
- predicate
a predicate to evaluate on the matched types
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEventEquals[E](event: E, apply: Apply2[E, D, State]): FSMStateFunctionBuilder[S, D]
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.
- event
an event to compare equal against
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchEventEquals[E, DT <: D](event: E, dataType: Class[DT], apply: Apply2[E, DT, State]): FSMStateFunctionBuilder[S, D]
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.
- event
an event to compare equal against
- dataType
the data type to match on
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchState(fromState: S, toState: S, apply: UnitApply2[S, S]): FSMTransitionHandlerBuilder[S]
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.
- fromState
the from state to match on
- toState
the to state to match on
- apply
an action to apply when the states match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchState(fromState: S, toState: S, apply: UnitApplyVoid): FSMTransitionHandlerBuilder[S]
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.
- fromState
the from state to match on
- toState
the to state to match on
- apply
an action to apply when the states match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchStop[RT <: Reason](reasonType: Class[RT], predicate: TypedPredicate[RT], apply: UnitApply3[RT, S, D]): FSMStopBuilder[S, D]
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.
- reasonType
the reason type to match on
- predicate
a predicate that will be evaluated on the reason if the type matches
- apply
an action to apply to the reason, event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchStop[RT <: Reason](reasonType: Class[RT], apply: UnitApply3[RT, S, D]): FSMStopBuilder[S, D]
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.
- reasonType
the reason type to match on
- apply
an action to apply to the reason, event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
matchStop(reason: Reason, apply: UnitApply2[S, D]): FSMStopBuilder[S, D]
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.
- reason
the reason for the termination
- apply
an action to apply to the event and state data if there is a match
- returns
the builder with the case statement added
- Definition Classes
- AbstractFSM
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
nextStateData: D
Return next state data (available in onTransition handlers)
Return next state data (available in onTransition handlers)
- Definition Classes
- FSM
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
onTermination(stopBuilder: FSMStopBuilder[S, D]): Unit
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.
- Definition Classes
- AbstractFSM
-
final
def
onTermination(terminationHandler: PartialFunction[StopEvent, Unit]): Unit
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.
- Definition Classes
- FSM
-
final
def
onTransition(transitionHandler: UnitApply2[S, S]): Unit
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.
- Definition Classes
- AbstractFSM
-
final
def
onTransition(transitionHandlerBuilder: FSMTransitionHandlerBuilder[S]): Unit
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.
- Definition Classes
- AbstractFSM
-
final
def
onTransition(transitionHandler: TransitionHandler): Unit
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.
- Definition Classes
- FSM
-
def
postRestart(reason: Throwable): Unit
User overridable callback: By default it calls
preStart().User overridable callback: By default it calls
preStart().- 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.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
postStop(): Unit
Call
onTerminationhook; if you want to retain this behavior when overriding make sure to callsuper.postStop(). -
def
preRestart(reason: Throwable, message: Option[Any]): Unit
User overridable callback: By default it disposes of all children and then calls
postStop().User overridable callback: By default it disposes of all children and then calls
postStop().- reason
the Throwable that caused the restart to happen
- message
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.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preStart(): Unit
User overridable callback.
User overridable callback.
Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
receive: Receive
This defines the initial actor behavior, it must return a partial function with the actor logic.
-
implicit final
val
self: ActorRef
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
- Definition Classes
- Actor
-
final
def
sender(): ActorRef
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
deadLettersin akka.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
-
final
def
setStateTimeout(state: S, timeout: Timeout): Unit
Set state timeout explicitly.
Set state timeout explicitly. This method can safely be used from within a state handler.
- Definition Classes
- FSM
-
final
def
setTimer(name: String, msg: Any, timeout: FiniteDuration): Unit
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.
- name
identifier to be used with cancelTimer()
- msg
message to be delivered
- timeout
delay of first message delivery and between subsequent messages
- Definition Classes
- AbstractFSM
-
final
def
setTimer(name: String, msg: Any, timeout: FiniteDuration, repeat: Boolean = false): Unit
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.
- name
identifier to be used with cancelTimer()
- msg
message to be delivered
- timeout
delay of first message delivery and between subsequent messages
- repeat
send once if false, scheduleAtFixedRate if true
- Definition Classes
- FSM
-
final
def
startWith(stateName: S, stateData: D, timeout: FiniteDuration): Unit
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.
- stateName
initial state designator
- stateData
initial state data
- timeout
state timeout for the initial state, overriding the default timeout for that state
- Definition Classes
- AbstractFSM
-
final
def
startWith(stateName: S, stateData: D): Unit
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.
- stateName
initial state designator
- stateData
initial state data
- Definition Classes
- AbstractFSM
-
final
def
startWith(stateName: S, stateData: D, timeout: Timeout = None): Unit
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.
- stateName
initial state designator
- stateData
initial state data
- timeout
state timeout for the initial state, overriding the default timeout for that state
- Definition Classes
- FSM
-
final
def
stateData: D
Return current state data (i.e.
Return current state data (i.e. object of type D)
- Definition Classes
- FSM
-
final
def
stateName: S
Return current state name (i.e.
Return current state name (i.e. object of type S)
- Definition Classes
- FSM
-
final
def
stay(): State
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 -> SforonTransitionto handle usegotoinstead.- returns
descriptor for staying in current state
- Definition Classes
- FSM
-
final
def
stop(reason: Reason, stateData: D): State
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
- Definition Classes
- FSM
-
final
def
stop(reason: Reason): State
Produce change descriptor to stop this FSM actor including specified reason.
Produce change descriptor to stop this FSM actor including specified reason.
- Definition Classes
- FSM
-
final
def
stop(): State
Produce change descriptor to stop this FSM actor with reason "Normal".
Produce change descriptor to stop this FSM actor with reason "Normal".
- Definition Classes
- FSM
-
def
supervisorStrategy: SupervisorStrategy
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
- Definition Classes
- Actor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit final
def
total2pf(transitionHandler: (S, S) ⇒ Unit): TransitionHandler
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.
- Definition Classes
- FSM
-
final
def
transform(func: StateFunction): TransformHelper
- Definition Classes
- FSM
-
def
unhandled(message: Any): Unit
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
- Definition Classes
- Actor
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
when(stateName: S, stateTimeout: FiniteDuration, stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): Unit
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.
- stateName
designator for the state
- stateTimeout
default state timeout for this state
- stateFunctionBuilder
partial function builder describing response to input
- Definition Classes
- AbstractFSM
-
final
def
when(stateName: S, stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): Unit
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.
- stateName
designator for the state
- stateFunctionBuilder
partial function builder describing response to input
- Definition Classes
- AbstractFSM
-
final
def
when(stateName: S)(stateFunction: StateFunction): Unit
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.
- stateName
designator for the state
- stateFunction
partial function describing response to input
- Definition Classes
- AbstractFSM
-
final
def
when(stateName: S, stateTimeout: FiniteDuration = null)(stateFunction: StateFunction): Unit
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.
- stateName
designator for the state
- stateTimeout
default state timeout for this state
- stateFunction
partial function describing response to input
- Definition Classes
- FSM
-
final
def
whenUnhandled(stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): Unit
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- Definition Classes
- AbstractFSM
-
final
def
whenUnhandled(stateFunction: StateFunction): Unit
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- Definition Classes
- FSM
-
def
→[B](y: B): (AbstractLoggingFSM[S, D], B)
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to ArrowAssoc[AbstractLoggingFSM[S, D]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
def
->[B](y: B): (AbstractLoggingFSM[S, D], B)
- Implicit
- This member is added by an implicit conversion from AbstractLoggingFSM[S, D] to ArrowAssoc[AbstractLoggingFSM[S, D]] performed by method ArrowAssoc in scala.Predef.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(abstractLoggingFSM: ArrowAssoc[AbstractLoggingFSM[S, D]]).->(y)
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()