akka.actor.FSM

State

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new State(stateName: S, stateData: D, timeout: Option[FiniteDuration] = scala.None, stopReason: Option[Reason] = scala.None, replies: List[Any] = immutable.this.Nil)

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. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from State[S, D] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (State[S, D], B)

    Implicit information
    This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (State[S, D]) ⇒ Boolean, msg: ⇒ Any): State[S, D]

    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (State[S, D]) ⇒ Boolean): State[S, D]

    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): State[S, D]

    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): State[S, D]

    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def forMax(timeout: Duration): State[S, D]

    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

    Implicit information
    This member is added by an implicit conversion from State[S, D] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

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

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

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

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

    Definition Classes
    AnyRef
  23. val replies: List[Any]

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

    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

  26. val stateName: S

  27. val stopReason: Option[Reason]

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

    Definition Classes
    AnyRef
  29. val timeout: Option[FiniteDuration]

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

    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.

  31. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (State[S, D], B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from State[S, D] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (state: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from State[S, D] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (state: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: State[S, D]

    Implicit information
    This member is added by an implicit conversion from State[S, D] to ArrowAssoc[State[S, D]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (state: ArrowAssoc[State[S, D]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: State[S, D]

    Implicit information
    This member is added by an implicit conversion from State[S, D] to Ensuring[State[S, D]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (state: Ensuring[State[S, D]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

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

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

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

Ungrouped