object PersistentFSM

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

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 akka.actor.FSM.SubscribeTransitionCallBack before sending any akka.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 akka.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 akka.actor.FSM is shutting itself down because of an error, e.g.

    Signifies that the akka.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 akka.actor.LoggingFSM, can be obtained by calling getLog.

  6. sealed trait Reason extends AnyRef

    Reason why this akka.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 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)

  8. 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 akka.actor.FSM whithin the onTermination block.

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

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

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

  10. 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 akka.actor.FSM.SubscribeTransitionCallBack).

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

    Unsubscribe from akka.actor.FSM.Transition notifications which was effected by sending the corresponding akka.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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. val →: ->.type
  21. object ->

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

  22. object Normal extends Reason with Product with Serializable

    Default reason if calling stop().

  23. 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)
  24. 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.

  25. object StateTimeout extends Product with Serializable

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

Inherited from AnyRef

Inherited from Any

Ungrouped