Object/Trait

akka.actor

FSM

Related Docs: trait FSM | package actor

Permalink

object FSM

Source
FSM.scala
Linear Supertypes
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FSM
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink

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

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

    Permalink

    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. final case class Failure(cause: Any) extends Reason with Product with Serializable

    Permalink

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

    Signifies that the akka.actor.FSM is shutting itself down because of an error, e.g. if the state to transition into does not exist. You can use this to communicate a more precise cause to the onTermination block.

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

    Permalink

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

  5. sealed trait Reason extends AnyRef

    Permalink

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

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

    Permalink

    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. final case class StopEvent[S, D](reason: Reason, currentState: S, stateData: D) extends NoSerializationVerificationNeeded with Product with Serializable

    Permalink

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

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

    Permalink

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

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

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

    Permalink

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

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

    Permalink

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

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. object ->

    Permalink

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

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. object Normal extends Reason with Product with Serializable

    Permalink

    Default reason if calling stop().

  6. object NullFunction extends PartialFunction[Any, Nothing]

    Permalink

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

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

    onTermination(FSM.NullFunction)
  7. object Shutdown extends Reason with Product with Serializable

    Permalink

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

  8. object StateTimeout extends Product with Serializable

    Permalink

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

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def clone(): AnyRef

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. val : ->.type

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped