Class

akka.actor.FSM

State

Related Doc: package FSM

Permalink

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

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.

Source
FSM.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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 State(stateName: S, stateData: D, timeout: Option[FiniteDuration] = None, stopReason: Option[Reason] = None, replies: List[Any] = Nil)

    Permalink

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 State[S, D] to any2stringadd[State[S, D]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (State[S, D], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def copy(stateName: S = stateName, stateData: D = stateData, timeout: Option[FiniteDuration] = timeout, stopReason: Option[Reason] = stopReason, replies: List[Any] = replies): State[S, D]

    Permalink

  9. def ensuring(cond: (State[S, D]) ⇒ Boolean, msg: ⇒ Any): State[S, D]

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (State[S, D]) ⇒ Boolean): State[S, D]

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): State[S, D]

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): State[S, D]

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def forMax(timeout: Duration): State[S, D]

    Permalink

    JAVA API: Modify state transition descriptor to include a state timeout for the next state.

    JAVA API: Modify state transition descriptor to include a state timeout for the next state. This timeout overrides any default timeout set for the next state.

    Use Duration.Inf to deactivate an existing timeout.

  16. def forMax(timeout: Duration): State[S, D]

    Permalink

    Modify state transition descriptor to include a state timeout for the next state.

    Modify state transition descriptor to include a state timeout for the next state. This timeout overrides any default timeout set for the next state.

    Use Duration.Inf to deactivate an existing timeout.

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D] to StringFormat[State[S, D]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. val replies: List[Any]

    Permalink

  24. def replying(replyValue: Any): State[S, D]

    Permalink

    Send reply to sender of the current message, if available.

    Send reply to sender of the current message, if available.

    returns

    this state transition descriptor

  25. val stateData: D

    Permalink

  26. val stateName: S

    Permalink

  27. val stopReason: Option[Reason]

    Permalink

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  29. val timeout: Option[FiniteDuration]

    Permalink

  30. def using(nextStateData: D): State[S, D]

    Permalink

    Modify state transition descriptor with new state data.

    Modify state transition descriptor with new state data. The data will be set when transitioning to the new state.

    Annotations
    @silent()

  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. def →[B](y: B): (State[S, D], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped