akka.actor

LoggingFSM

trait LoggingFSM [S, D] extends FSM[S, D]

Stackable trait for FSM which adds a rolling event log.

Self Type
LoggingFSM[S, D] with Actor
Since

1.2

Linear Supertypes
FSM[S, D], ListenerManagement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. LoggingFSM
  2. FSM
  3. ListenerManagement
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Type Members

  1. case class Event (event: Any, stateData: D) extends Product with Serializable

  2. type State = State[S, D]

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

    Definition Classes
    FSM
  4. case class StopEvent [S, D] (reason: Reason, currentState: S, stateData: D) extends Product with Serializable

  5. type Timeout = Option[Duration]

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

    Definition Classes
    FSM

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. object Ev extends AnyRef

  7. def addListener (listener: ActorRef): Unit

    Adds the listener this this registry's listener list.

    Adds the listener this this registry's listener list. The listener is started by this method if manageLifeCycleOfListeners yields true.

    Definition Classes
    ListenerManagement
  8. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  9. def cancelTimer (name: String): Any

    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

    Attributes
    protected[akka]
    Definition Classes
    LoggingFSMFSM
  10. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  12. def equals (arg0: Any): Boolean

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. def foreachListener (f: (ActorRef) ⇒ Unit): Unit

    Execute f with each listener as argument.

    Execute f with each listener as argument. ActorInitializationException is not handled.

    Attributes
    protected[akka]
    Definition Classes
    ListenerManagement
  15. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  16. 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.

    Attributes
    protected
  17. 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

    Attributes
    protected final
    Definition Classes
    FSM
  18. def hasListener (listener: ActorRef): Boolean

    Checks if a specific listener is registered.

    Checks if a specific listener is registered. ActorInitializationException leads to removal of listener if that one isShutdown.

    Definition Classes
    ListenerManagement
  19. def hasListeners : Boolean

    Definition Classes
    ListenerManagement
  20. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  21. 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.

    Attributes
    protected final
    Definition Classes
    FSM
  22. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  23. def logDepth : Int

  24. val manageLifeCycleOfListeners : Boolean

    Specifies whether listeners should be started when added and stopped when removed or not

    Specifies whether listeners should be started when added and stopped when removed or not

    Attributes
    protected
    Definition Classes
    FSMListenerManagement
  25. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  26. def nextStateData : D

    Return next state data (available in onTransition handlers)

    Return next state data (available in onTransition handlers)

    Attributes
    protected[akka]
    Definition Classes
    FSM
  27. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  28. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  29. def notifyListeners (message: ⇒ Any): Unit

    Attributes
    protected[akka]
    Definition Classes
    ListenerManagement
  30. def onTermination (terminationHandler: PartialFunction[StopEvent[S, D], Unit]): Unit

    Set handler which is called upon termination of this FSM actor.

    Set handler which is called upon termination of this FSM actor.

    Attributes
    protected final
    Definition Classes
    FSM
  31. def onTransition (transitionHandler: TransitionHandler): Unit

    Set handler which is called upon each state transition, i.

    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.

    Attributes
    protected final
    Definition Classes
    FSM
  32. def postStop (): Unit

    Definition Classes
    FSM
  33. def receive : Receive

    ******************************************* Main actor receive() method *******************************************

    ******************************************* Main actor receive() method *******************************************

    Attributes
    protected final
    Definition Classes
    FSM
  34. def removeListener (listener: ActorRef): Unit

    Removes the listener this this registry's listener list.

    Removes the listener this this registry's listener list. The listener is stopped by this method if manageLifeCycleOfListeners yields true.

    Definition Classes
    ListenerManagement
  35. 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.

    Attributes
    protected final
    Definition Classes
    FSM
  36. def setTimer (name: String, msg: Any, timeout: Duration, repeat: Boolean): State

    Schedule named timer to deliver message after given delay, possibly repeating.

    Schedule named timer to deliver message after given delay, possibly repeating.

    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

    returns

    current state descriptor

    Attributes
    protected[akka]
    Definition Classes
    LoggingFSMFSM
  37. 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.

    stateName

    initial state designator

    stateData

    initial state data

    timeout

    state timeout for the initial state, overriding the default timeout for that state

    Attributes
    protected final
    Definition Classes
    FSM
  38. def stateData : D

    Return current state data (i.

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

    Attributes
    protected[akka]
    Definition Classes
    FSM
  39. def stateName : S

    Return current state name (i.

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

    Attributes
    protected[akka]
    Definition Classes
    FSM
  40. 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.

    returns

    descriptor for staying in current state

    Attributes
    protected final
    Definition Classes
    FSM
  41. 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.

    Attributes
    protected final
    Definition Classes
    FSM
  42. 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.

    Attributes
    protected final
    Definition Classes
    FSM
  43. 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".

    Attributes
    protected final
    Definition Classes
    FSM
  44. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  45. def timerActive_? (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.

    Attributes
    protected[akka] final
    Definition Classes
    FSM
  46. def toString (): String

    Definition Classes
    AnyRef → Any
  47. implicit def total2pf (transitionHandler: (S, S) ⇒ Unit): PartialFunction[(S, S), Unit]

    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.

    Attributes
    protected implicit final
    Definition Classes
    FSM
  48. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  51. def when (stateName: S, stateTimeout: Timeout = None)(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

    Attributes
    protected final
    Definition Classes
    FSM
  52. 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.

    Attributes
    protected final
    Definition Classes
    FSM

Inherited from FSM[S, D]

Inherited from ListenerManagement

Inherited from AnyRef

Inherited from Any