akka.actor

FSM

object FSM

Source
FSM.scala
Linear Supertypes
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FSM
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class CurrentState[S](fsmRef: ActorRef, state: S) extends Product with Serializable

    Message type which is sent directly to the subscribed actor in akka.actor.FSM.SubscribeTransitionCallBack before sending any akka.actor.FSM.Transition messages.

  2. case class Event[D](event: Any, stateData: D) extends NoSerializationVerificationNeeded with Product with Serializable

    All messages sent to the akka.actor.FSM will be wrapped inside an Event, which allows pattern matching to extract both state and data.

  3. case class Failure(cause: Any) extends Reason with Product with Serializable

    Signifies that the akka.actor.FSM is shutting itself down because of an error, e.

  4. case class LogEntry[S, D](stateName: S, stateData: D, event: Any) extends Product with Serializable

    Log Entry of the akka.actor.LoggingFSM, can be obtained by calling getLog.

  5. sealed trait Reason extends AnyRef

    Reason why this akka.actor.FSM is shutting down.

  6. case class State[S, D](stateName: S, stateData: D, timeout: Option[FiniteDuration] = scala.None, stopReason: Option[Reason] = scala.None, replies: List[Any] = immutable.this.Nil) extends Product with Serializable

    This captures all of the managed state of the akka.actor.FSM: the state name, the state data, possibly custom timeout, stop reason and replies accumulated while processing the last message.

  7. case class StopEvent[S, D](reason: Reason, currentState: S, stateData: D) extends NoSerializationVerificationNeeded with Product with Serializable

    Case class representing the state of the akka.actor.FSM whithin the onTermination block.

  8. case class SubscribeTransitionCallBack(actorRef: ActorRef) extends Product with Serializable

    Send this to an akka.actor.FSM to request first the FSM.CurrentState and then a series of FSM.Transition updates.

  9. case class Transition[S](fsmRef: ActorRef, from: S, to: S) extends Product with Serializable

    Message type which is used to communicate transitions between states to all subscribed listeners (use akka.actor.FSM.SubscribeTransitionCallBack).

  10. case class UnsubscribeTransitionCallBack(actorRef: ActorRef) extends Product with Serializable

    Unsubscribe from akka.actor.FSM.Transition notifications which was effected by sending the corresponding akka.actor.FSM.SubscribeTransitionCallBack.

Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. object ->

    This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.

  5. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  7. object Normal extends Reason with Product with Serializable

    Default reason if calling stop().

  8. object NullFunction extends PartialFunction[Any, Nothing]

    A partial function value which does not match anything and can be used to “reset” whenUnhandled and onTermination handlers.

  9. object Shutdown extends Reason with Product with Serializable

    Reason given when someone was calling system.stop(fsm) from outside; also applies to Stop supervision directive.

  10. object StateTimeout extends Product with Serializable

    This case object is received in case of a state timeout.

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def clone(): AnyRef

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

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  23. def toString(): String

    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped