Packages

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
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)

Value Members

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

    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.

  3. 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.

  4. val replies: List[Any]
  5. 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

  6. val stateData: D
  7. val stateName: S
  8. val stopReason: Option[Reason]
  9. val timeout: Option[FiniteDuration]
  10. def using(nextStateData: 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.