Class

akka.actor

AbstractLoggingFSM

Related Doc: package actor

Permalink

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
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractLoggingFSM
  2. LoggingFSM
  3. AbstractFSM
  4. FSM
  5. ActorLogging
  6. Listeners
  7. Actor
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractLoggingFSM()

    Permalink

Type Members

  1. type Event = FSM.Event[D]

    Permalink
    Definition Classes
    FSM
  2. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor
  3. type State = FSM.State[S, D]

    Permalink
    Definition Classes
    FSM
  4. type StateFunction = PartialFunction[Event, State]

    Permalink
    Definition Classes
    FSM
  5. type StopEvent = FSM.StopEvent[S, D]

    Permalink
    Definition Classes
    FSM
  6. type Timeout = Option[FiniteDuration]

    Permalink
    Definition Classes
    FSM
  7. final class TransformHelper extends AnyRef

    Permalink
    Definition Classes
    FSM
  8. type TransitionHandler = PartialFunction[(S, S), Unit]

    Permalink
    Definition Classes
    FSM

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    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
  4. val ->: FSM.->.type

    Permalink

    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
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. val Event: FSM.Event.type

    Permalink
    Definition Classes
    FSM
  7. val Normal: Reason

    Permalink

    Default reason if calling stop().

    Default reason if calling stop().

    Definition Classes
    AbstractFSM
  8. val Shutdown: Reason

    Permalink

    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.

    Definition Classes
    AbstractFSM
  9. val StateTimeout: FSM.StateTimeout.type

    Permalink

    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
  10. val StopEvent: FSM.StopEvent.type

    Permalink
    Definition Classes
    FSM
  11. def aroundPostRestart(reason: Throwable): Unit

    Permalink

    Can be overridden to intercept calls to postRestart.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  12. def aroundPostStop(): Unit

    Permalink

    Can be overridden to intercept calls to postStop.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  13. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink

    Can be overridden to intercept calls to preRestart.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  14. def aroundPreStart(): Unit

    Permalink

    Can be overridden to intercept calls to preStart.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  15. def aroundReceive(receive: Actor.Receive, msg: Any): Unit

    Permalink

    INTERNAL API.

    INTERNAL API.

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

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. final def cancelTimer(name: String): Unit

    Permalink

    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
  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. implicit val context: ActorContext

    Permalink

    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. getContext returns a akka.actor.UntypedActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  20. def ensuring(cond: (AbstractLoggingFSM[S, D]) ⇒ Boolean, msg: ⇒ Any): AbstractLoggingFSM[S, D]

    Permalink
    Implicit information
    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
  21. def ensuring(cond: (AbstractLoggingFSM[S, D]) ⇒ Boolean): AbstractLoggingFSM[S, D]

    Permalink
    Implicit information
    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
  22. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractLoggingFSM[S, D]

    Permalink
    Implicit information
    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
  23. def ensuring(cond: Boolean): AbstractLoggingFSM[S, D]

    Permalink
    Implicit information
    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
  24. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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()
  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def getLog: IndexedSeq[LogEntry[S, D]]

    Permalink

    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
  30. final def goTo(nextStateName: S): State

    Permalink

    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
  31. def gossip(msg: Any)(implicit sender: ActorRef = Actor.noSender): Unit

    Permalink

    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
  32. final def goto(nextStateName: S): State

    Permalink

    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.

    nextStateName

    state designator for the next state

    returns

    state transition descriptor

    Definition Classes
    FSM
  33. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  34. final def initialize(): Unit

    Permalink

    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.

    Definition Classes
    FSM
    See also

    #startWith

  35. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  36. final def isTimerActive(name: String): Boolean

    Permalink

    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
  37. def listenerManagement: Actor.Receive

    Permalink

    Chain this into the receive function.

    Chain this into the receive function.

    def receive = listenerManagement orElse …
    Attributes
    protected
    Definition Classes
    Listeners
  38. val listeners: Set[ActorRef]

    Permalink
    Attributes
    protected
    Definition Classes
    Listeners
  39. def log: LoggingAdapter

    Permalink
    Definition Classes
    ActorLogging
  40. def logDepth: Int

    Permalink
    Definition Classes
    LoggingFSM
  41. def logTermination(reason: Reason): Unit

    Permalink

    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
  42. final def matchAnyEvent(apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  43. final def matchData[DT <: D](dataType: Class[DT], predicate: TypedPredicate[DT], apply: UnitApply[DT]): UnitPFBuilder[D]

    Permalink

    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
  44. final def matchData[DT <: D](dataType: Class[DT], apply: UnitApply[DT]): UnitPFBuilder[D]

    Permalink

    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
  45. final def matchEvent(eventMatches: List[AnyRef], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  46. final def matchEvent[DT <: D](eventMatches: List[AnyRef], dataType: Class[DT], apply: Apply2[AnyRef, DT, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  47. final def matchEvent(predicate: TypedPredicate2[AnyRef, D], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  48. final def matchEvent[ET](eventType: Class[ET], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  49. final def matchEvent[ET](eventType: Class[ET], predicate: TypedPredicate2[ET, D], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  50. final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  51. final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], predicate: TypedPredicate2[ET, DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  52. final def matchEventEquals[E](event: E, apply: Apply2[E, D, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  53. final def matchEventEquals[E, DT <: D](event: E, dataType: Class[DT], apply: Apply2[E, DT, State]): FSMStateFunctionBuilder[S, D]

    Permalink

    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
  54. final def matchState(fromState: S, toState: S, apply: UnitApply2[S, S]): FSMTransitionHandlerBuilder[S]

    Permalink

    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
  55. final def matchState(fromState: S, toState: S, apply: UnitApplyVoid): FSMTransitionHandlerBuilder[S]

    Permalink

    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
  56. final def matchStop[RT <: Reason](reasonType: Class[RT], predicate: TypedPredicate[RT], apply: UnitApply3[RT, S, D]): FSMStopBuilder[S, D]

    Permalink

    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
  57. final def matchStop[RT <: Reason](reasonType: Class[RT], apply: UnitApply3[RT, S, D]): FSMStopBuilder[S, D]

    Permalink

    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
  58. final def matchStop(reason: Reason, apply: UnitApply2[S, D]): FSMStopBuilder[S, D]

    Permalink

    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
  59. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  60. final def nextStateData: D

    Permalink

    Return next state data (available in onTransition handlers)

    Return next state data (available in onTransition handlers)

    Definition Classes
    FSM
  61. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  62. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  63. final def onTermination(stopBuilder: FSMStopBuilder[S, D]): Unit

    Permalink

    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
  64. final def onTermination(terminationHandler: PartialFunction[StopEvent, Unit]): Unit

    Permalink

    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
  65. final def onTransition(transitionHandler: UnitApply2[S, S]): Unit

    Permalink

    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
  66. final def onTransition(transitionHandlerBuilder: FSMTransitionHandlerBuilder[S]): Unit

    Permalink

    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
  67. final def onTransition(transitionHandler: TransitionHandler): Unit

    Permalink

    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
  68. def postRestart(reason: Throwable): Unit

    Permalink

    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] )
  69. def postStop(): Unit

    Permalink

    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.

    Definition Classes
    FSMActor
  70. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink

    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] )
  71. def preStart(): Unit

    Permalink

    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] )
  72. def receive: Receive

    Permalink

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    FSMActor
  73. implicit final val self: ActorRef

    Permalink

    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
  74. final def sender(): ActorRef

    Permalink

    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!

    Definition Classes
    Actor
  75. final def setStateTimeout(state: S, timeout: Timeout): Unit

    Permalink

    Set state timeout explicitly.

    Set state timeout explicitly. This method can safely be used from within a state handler.

    Definition Classes
    FSM
  76. final def setTimer(name: String, msg: Any, timeout: FiniteDuration): Unit

    Permalink

    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
  77. final def setTimer(name: String, msg: Any, timeout: FiniteDuration, repeat: Boolean = false): Unit

    Permalink

    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
  78. final def startWith(stateName: S, stateData: D, timeout: FiniteDuration): Unit

    Permalink

    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
  79. final def startWith(stateName: S, stateData: D): Unit

    Permalink

    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
  80. final def startWith(stateName: S, stateData: D, timeout: Timeout = None): Unit

    Permalink

    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
  81. final def stateData: D

    Permalink

    Return current state data (i.e.

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

    Definition Classes
    FSM
  82. final def stateName: S

    Permalink

    Return current state name (i.e.

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

    Definition Classes
    FSM
  83. final def stay(): State

    Permalink

    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.

    returns

    descriptor for staying in current state

    Definition Classes
    FSM
  84. final def stop(reason: Reason, stateData: D): State

    Permalink

    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
  85. final def stop(reason: Reason): State

    Permalink

    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
  86. final def stop(): State

    Permalink

    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
  87. def supervisorStrategy: SupervisorStrategy

    Permalink

    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
  88. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  89. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  90. implicit final def total2pf(transitionHandler: (S, S) ⇒ Unit): TransitionHandler

    Permalink

    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
  91. final def transform(func: StateFunction): TransformHelper

    Permalink
    Definition Classes
    FSM
  92. def unhandled(message: Any): Unit

    Permalink

    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
  93. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  95. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. final def when(stateName: S, stateTimeout: FiniteDuration, stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): Unit

    Permalink

    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
  97. final def when(stateName: S, stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): Unit

    Permalink

    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
  98. final def when(stateName: S)(stateFunction: StateFunction): Unit

    Permalink

    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
  99. final def when(stateName: S, stateTimeout: FiniteDuration = null)(stateFunction: StateFunction): Unit

    Permalink

    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
  100. final def whenUnhandled(stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): Unit

    Permalink

    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
  101. final def whenUnhandled(stateFunction: StateFunction): Unit

    Permalink

    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
  102. def [B](y: B): (AbstractLoggingFSM[S, D], B)

    Permalink
    Implicit information
    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

  1. def ->[B](y: B): (AbstractLoggingFSM[S, D], B)

    Permalink
    Implicit information
    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()

Inherited from LoggingFSM[S, D]

Inherited from AbstractFSM[S, D]

Inherited from FSM[S, D]

Inherited from ActorLogging

Inherited from Listeners

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AbstractLoggingFSM[S, D] to any2stringadd[AbstractLoggingFSM[S, D]]

Inherited by implicit conversion StringFormat from AbstractLoggingFSM[S, D] to StringFormat[AbstractLoggingFSM[S, D]]

Inherited by implicit conversion Ensuring from AbstractLoggingFSM[S, D] to Ensuring[AbstractLoggingFSM[S, D]]

Inherited by implicit conversion ArrowAssoc from AbstractLoggingFSM[S, D] to ArrowAssoc[AbstractLoggingFSM[S, D]]

Ungrouped