Class

akka.persistence.fsm.PersistentFSM

State

Related Doc: package PersistentFSM

Permalink

final case class State[S, D, E](stateName: S, stateData: D, timeout: Option[FiniteDuration] = None, stopReason: Option[Reason] = None, replies: List[Any] = Nil, domainEvents: Seq[E] = Nil, afterTransitionDo: (D) ⇒ Unit = _: D ⇒)(notifies: Boolean = true) 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, replies accumulated while processing the last message, possibly domain event and handler to be executed after FSM moves to the new state (also triggered when staying in the same state)

Source
PersistentFSM.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, domainEvents: Seq[E] = Nil, afterTransitionDo: (D) ⇒ Unit = _: D ⇒)(notifies: Boolean = true)

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. val afterTransitionDo: (D) ⇒ Unit

    Permalink

  7. def andThen(handler: (D) ⇒ Unit): State[S, D, E]

    Permalink

    Register a handler to be triggered after the state has been persisted successfully

  8. def applying(events: E*): State[S, D, E]

    Permalink

    Specify domain events to be applied when transitioning to the new state.

    Specify domain events to be applied when transitioning to the new state.

    Annotations
    @varargs()

  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. val domainEvents: Seq[E]

    Permalink

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef

  17. def finalize(): Unit

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

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

    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.

  19. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. val replies: List[Any]

    Permalink

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

    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

  27. val stateData: D

    Permalink

  28. val stateName: S

    Permalink

  29. val stopReason: Option[Reason]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  31. val timeout: Option[FiniteDuration]

    Permalink

  32. final def wait(): Unit

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

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

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from State[S, D, E] to ArrowAssoc[State[S, D, E]] 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, E] to any2stringadd[State[S, D, E]]

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

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

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

Ungrouped