Packages

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 pekko.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, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toany2stringadd[State[S, D, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (State[S, D, E], B)
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toArrowAssoc[State[S, D, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val afterTransitionDo: (D) => Unit
  7. def andThen(handler: (D) => Unit): State[S, D, E]

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

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

    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
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. val domainEvents: Seq[E]
  12. def ensuring(cond: (State[S, D, E]) => Boolean, msg: => Any): State[S, D, E]
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toEnsuring[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]
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toEnsuring[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]
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toEnsuring[State[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): State[S, D, E]
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toEnsuring[State[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def forMax(timeout: Duration): State[S, D, E]

    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.

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

    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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. val replies: List[Any]
  26. def replying(replyValue: Any): State[S, D, E]

    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
  28. val stateName: S
  29. val stopReason: Option[Reason]
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. val timeout: Option[FiniteDuration]
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toStringFormat[State[S, D, E]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (State[S, D, E], B)
    Implicit
    This member is added by an implicit conversion from State[S, D, E] toArrowAssoc[State[S, D, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped