Type Members

1.  final case class CurrentState[S](fsmRef: ActorRef, state: S, timeout: Option[FiniteDuration]) 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.  trait FSMState extends AnyRef

   FSMState base trait, makes possible for simple default serialization by conversion to String

4.  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.

5.  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.

6.  sealed trait Reason extends AnyRef

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

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

8.  case class StateChangeEvent(stateIdentifier: String, timeout: Option[FiniteDuration]) extends PersistentFsmEvent with Product with Serializable

   Persisted on state change Not deprecated as used for users migrating from PersistentFSM to EventSourcedBehavior

   Persisted on state change Not deprecated as used for users migrating from PersistentFSM to EventSourcedBehavior

   stateIdentifier

   FSM state identifier

   timeout

   FSM state timeout

9.  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 whithin the onTermination block.

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

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

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

11.  final case class Transition[S](fsmRef: ActorRef, from: S, to: S, timeout: Option[FiniteDuration]) extends Product with Serializable

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

12.  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.