Packages

object FSM

Source
FSM.scala
Linear Supertypes
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FSM
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class CurrentState[S](fsmRef: ActorRef, state: S) extends Product with Serializable

    Message type which is sent directly to the subscribed actor in pekko.actor.FSM.SubscribeTransitionCallBack before sending any pekko.actor.FSM.Transition messages.

  2. final case class Event[D](event: Any, stateData: D) extends NoSerializationVerificationNeeded with Product with Serializable

    All messages sent to the pekko.actor.FSM will be wrapped inside an Event, which allows pattern matching to extract both state and data.

  3. final case class Failure(cause: Any) extends Reason with Product with Serializable

    Signifies that the pekko.actor.FSM is shutting itself down because of an error, e.g.

    Signifies that the pekko.actor.FSM is shutting itself down because of an error, e.g. if the state to transition into does not exist. You can use this to communicate a more precise cause to the onTermination block.

  4. final case class LogEntry[S, D](stateName: S, stateData: D, event: Any) extends Product with Serializable

    Log Entry of the pekko.actor.LoggingFSM, can be obtained by calling getLog.

  5. sealed trait Reason extends AnyRef

    Reason why this pekko.actor.FSM is shutting down.

  6. class State[S, D] extends Product with Serializable
  7. final case class StopEvent[S, D](reason: Reason, currentState: S, stateData: D) extends NoSerializationVerificationNeeded with Product with Serializable

    Case class representing the state of the pekko.actor.FSM within the onTermination block.

  8. final case class SubscribeTransitionCallBack(actorRef: ActorRef) extends Product with Serializable

    Send this to an pekko.actor.FSM to request first the FSM.CurrentState and then a series of FSM.Transition updates.

    Send this to an pekko.actor.FSM to request first the FSM.CurrentState and then a series of FSM.Transition updates. Cancel the subscription using FSM.UnsubscribeTransitionCallBack.

  9. final case class Transition[S](fsmRef: ActorRef, from: S, to: S) extends Product with Serializable

    Message type which is used to communicate transitions between states to all subscribed listeners (use pekko.actor.FSM.SubscribeTransitionCallBack).

  10. final case class UnsubscribeTransitionCallBack(actorRef: ActorRef) extends Product with Serializable

    Unsubscribe from pekko.actor.FSM.Transition notifications which was effected by sending the corresponding pekko.actor.FSM.SubscribeTransitionCallBack.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. val : ->.type
  20. object ->

    This extractor is just convenience for matching a (S, S) pair, including a reminder what the new state is.

  21. case object Normal extends Reason with Product with Serializable

    Default reason if calling stop().

  22. object NullFunction extends PartialFunction[Any, Nothing]

    A partial function value which does not match anything and can be used to “reset” whenUnhandled and onTermination handlers.

    A partial function value which does not match anything and can be used to “reset” whenUnhandled and onTermination handlers.

    onTermination(FSM.NullFunction)
  23. case object Shutdown extends Reason with Product with Serializable

    Reason given when someone was calling system.stop(fsm) from outside; also applies to Stop supervision directive.

  24. object State extends Serializable

    This captures all of the managed state of the pekko.actor.FSM: the state name, the state data, possibly custom timeout, stop reason and replies accumulated while processing the last message.

  25. case object StateTimeout extends Product with Serializable

    This case object is received in case of a state timeout.

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped