Packages

c

akka.persistence.fsm

AbstractPersistentFSM

abstract class AbstractPersistentFSM[S <: FSMState, D, E] extends AbstractPersistentFSMBase[S, D, E] with PersistentFSM[S, D, E]

Java API: compatible with lambda expressions

Persistent Finite State Machine actor abstract base class.

Source
PersistentFSM.scala
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractPersistentFSM
  2. PersistentFSM
  3. PersistentActor
  4. Eventsourced
  5. PersistenceRecovery
  6. PersistenceIdentity
  7. PersistenceStash
  8. StashFactory
  9. Stash
  10. RequiresMessageQueue
  11. UnrestrictedStash
  12. StashSupport
  13. Snapshotter
  14. AbstractPersistentFSMBase
  15. PersistentFSMBase
  16. ActorLogging
  17. Listeners
  18. Actor
  19. AnyRef
  20. 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 AbstractPersistentFSM()

Type Members

  1. type Event = PersistentFSM.Event[D]
    Definition Classes
    PersistentFSMBase
  2. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor
  3. type State = PersistentFSM.State[S, D, E]
    Definition Classes
    PersistentFSMBase
  4. type StateFunction = PartialFunction[Event, State]
    Definition Classes
    PersistentFSMBase
  5. type StopEvent = PersistentFSM.StopEvent[S, D]
    Definition Classes
    PersistentFSMBase
  6. type Timeout = Option[FiniteDuration]
    Definition Classes
    PersistentFSMBase
  7. type TransitionHandler = PartialFunction[(S, S), Unit]
    Definition Classes
    PersistentFSMBase
  8. final class TransformHelper extends AnyRef
    Definition Classes
    PersistentFSMBase

Abstract Value Members

  1. abstract def applyEvent(domainEvent: E, currentData: D): D

    Override this handler to define the action on Domain Event

    Override this handler to define the action on Domain Event

    domainEvent

    domain event to apply

    currentData

    state data of the previous state

    returns

    updated state data

    Definition Classes
    PersistentFSM
  2. abstract def domainEventClass: Class[E]

    Domain event's Class Used for identifying domain events during recovery

  3. abstract def persistenceId: String

    Id of the persistent entity for which messages should be replayed.

    Id of the persistent entity for which messages should be replayed.

    Definition Classes
    PersistenceIdentity

Concrete 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 AbstractPersistentFSM[S, D, E] to any2stringadd[AbstractPersistentFSM[S, D, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. val ->: PersistentFSM.->.type

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

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

    Definition Classes
    PersistentFSMBase
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val Event: PersistentFSM.Event.type
    Definition Classes
    PersistentFSMBase
  7. val Normal: Reason

    Default reason if calling stop().

    Default reason if calling stop().

    Definition Classes
    AbstractPersistentFSMBase
  8. val Shutdown: Reason

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

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

    Definition Classes
    AbstractPersistentFSMBase
  9. val StateTimeout: PersistentFSM.StateTimeout.type

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

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

    Definition Classes
    PersistentFSMBase
  10. val StopEvent: PersistentFSM.StopEvent.type
    Definition Classes
    PersistentFSMBase
  11. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  12. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  13. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  14. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  15. def aroundReceive(receive: Receive, message: Any): Unit

    INTERNAL API.

    INTERNAL API.

    receive

    current behavior.

    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. final def cancelTimer(name: String): Unit

    Cancel named timer, ensuring that the message is not subsequently delivered (no race).

    Cancel named timer, ensuring that the message is not subsequently delivered (no race).

    name

    of the timer to cancel

    Definition Classes
    PersistentFSMBase
  18. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  19. implicit val context: ActorContext

    Scala API: Stores the context for this actor, including self, and sender.

    Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    akka.actor.ActorContext is the Scala API. getContext returns a akka.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  20. def defer[A](event: A)(handler: (A) ⇒ Unit): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. It is guaranteed that no new commands will be received by a persistent actor between a call to defer and the execution of its handler. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync or persist calls. That is, if persistAsync or persist was invoked before defer, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, use persist or persistAsync instead if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediately.

    If persistence of an earlier event fails, the persistent actor will stop, and the handler will not be run.

    event

    event to be handled in the future, when preceding persist operations have been processes

    handler

    handler for the given event

    Definition Classes
    PersistentActor
  21. def deferAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync or persist calls. That is, if persistAsync or persist was invoked before deferAsync, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, use persist or persistAsync instead if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediately.

    If persistence of an earlier event fails, the persistent actor will stop, and the handler will not be run.

    event

    event to be handled in the future, when preceding persist operations have been processes

    handler

    handler for the given event

    Definition Classes
    PersistentActor
  22. def deleteMessages(toSequenceNr: Long): Unit

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    If the delete is successful a DeleteMessagesSuccess will be sent to the actor. If the delete fails a DeleteMessagesFailure will be sent to the actor.

    The given toSequenceNr must be less than or equal to Eventsourced#lastSequenceNr, otherwise DeleteMessagesFailure is sent to the actor without performing the delete. All persistent messages may be deleted without specifying the actual sequence number by using Long.MaxValue as the toSequenceNr.

    toSequenceNr

    upper sequence number (inclusive) bound of persistent messages to be deleted.

    Definition Classes
    Eventsourced
  23. def deleteSnapshot(sequenceNr: Long): Unit

    Deletes the snapshot identified by sequenceNr.

    Deletes the snapshot identified by sequenceNr.

    The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.

    Definition Classes
    Snapshotter
  24. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit

    Deletes all snapshots matching criteria.

    Deletes all snapshots matching criteria.

    The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.

    Definition Classes
    Snapshotter
  25. final def domainEventClassTag: ClassTag[E]

    Adapter from Java Class to scala.reflect.ClassTag

    Adapter from Java Class to scala.reflect.ClassTag

    returns

    domain event scala.reflect.ClassTag

    Definition Classes
    AbstractPersistentFSMPersistentFSM
  26. val domainEventTag: ClassTag[E]

    Domain event's scala.reflect.ClassTag Used for identifying domain events during recovery

    Domain event's scala.reflect.ClassTag Used for identifying domain events during recovery

    Definition Classes
    PersistentFSM
  27. def ensuring(cond: (AbstractPersistentFSM[S, D, E]) ⇒ Boolean, msg: ⇒ Any): AbstractPersistentFSM[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSM[S, D, E] to Ensuring[AbstractPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: (AbstractPersistentFSM[S, D, E]) ⇒ Boolean): AbstractPersistentFSM[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSM[S, D, E] to Ensuring[AbstractPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractPersistentFSM[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSM[S, D, E] to Ensuring[AbstractPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: Boolean): AbstractPersistentFSM[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSM[S, D, E] to Ensuring[AbstractPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. final def exec(action: Consumer[D]): (D) ⇒ Unit

    Adapter from Java 8 Functional Interface to Scala Function

    Adapter from Java 8 Functional Interface to Scala Function

    action

    - Java 8 lambda expression defining the action

    returns

    action represented as a Scala Functin

  34. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSM[S, D, E] to StringFormat[AbstractPersistentFSM[S, D, E]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  35. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. def getContext(): ActorContext

    Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.

    Returns this AbstractActor's ActorContext The ActorContext is not thread safe so do not expose it outside of the AbstractActor.

    Definition Classes
    AbstractPersistentFSMBase
  37. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Same as self().

    Definition Classes
    AbstractPersistentFSMBase
  38. def getSender(): ActorRef

    The reference sender Actor of the currently processed message.

    The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

    Same as sender().

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    AbstractPersistentFSMBase
  39. final def goTo(nextStateName: S): State

    Produce transition to other state.

    Produce transition to other state. Return this from a state function in order to effect the transition.

    nextStateName

    state designator for the next state

    returns

    state transition descriptor

    Definition Classes
    AbstractPersistentFSMBase
  40. def gossip(msg: Any)(implicit sender: ActorRef = Actor.noSender): Unit

    Sends the supplied message to all current listeners using the provided sender() as sender.

    Sends the supplied message to all current listeners using the provided sender() as sender.

    Attributes
    protected
    Definition Classes
    Listeners
  41. final def goto(nextStateName: S): State

    Produce transition to other state.

    Produce transition to other state. Return this from a state function in order to effect the transition.

    This method always triggers transition events, even for A -> A transitions. If you want to stay in the same state without triggering an state transition event use #stay instead.

    nextStateName

    state designator for the next state

    returns

    state transition descriptor

    Definition Classes
    PersistentFSMBase
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. def internalStashOverflowStrategy: StashOverflowStrategy

    The returned StashOverflowStrategy object determines how to handle the message failed to stash when the internal Stash capacity exceeded.

    The returned StashOverflowStrategy object determines how to handle the message failed to stash when the internal Stash capacity exceeded.

    Definition Classes
    PersistenceStash
  44. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  45. final def isTimerActive(name: String): Boolean

    Inquire whether the named timer is still active.

    Inquire whether the named timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer whose message was already received.

    Definition Classes
    PersistentFSMBase
  46. def journalPluginId: String

    Configuration id of the journal plugin servicing this persistent actor.

    Configuration id of the journal plugin servicing this persistent actor. When empty, looks in akka.persistence.journal.plugin to find configuration entry path. When configured, uses journalPluginId as absolute path to the journal configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.

    Definition Classes
    PersistenceIdentity
  47. def lastSequenceNr: Long

    Highest received sequence number so far or 0L if this actor hasn't replayed or stored any persistent events yet.

    Highest received sequence number so far or 0L if this actor hasn't replayed or stored any persistent events yet.

    Definition Classes
    Eventsourced
  48. def listenerManagement: actor.Actor.Receive

    Chain this into the receive function.

    Chain this into the receive function.

    def receive = listenerManagement orElse …
    Attributes
    protected
    Definition Classes
    Listeners
  49. val listeners: Set[ActorRef]
    Attributes
    protected
    Definition Classes
    Listeners
  50. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

    Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

    Definition Classes
    Snapshotter
  51. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  52. def logTermination(reason: Reason): Unit

    By default PersistentFSM.Failure is logged at error level and other reason types are not logged.

    By default PersistentFSM.Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.

    Attributes
    protected
    Definition Classes
    PersistentFSMBase
  53. final def matchAnyEvent(apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches on any type of event.

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  54. final def matchData[DT <: D](dataType: Class[DT], predicate: TypedPredicate[DT], apply: UnitApply[DT]): UnitPFBuilder[D]

    Create a akka.japi.pf.UnitPFBuilder with the first case statement set.

    Create a akka.japi.pf.UnitPFBuilder with the first case statement set.

    dataType

    a type to match the argument against

    predicate

    a predicate that will be evaluated on the argument if the type matches

    apply

    an action to apply to the argument if the type and predicate matches

    returns

    a builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  55. final def matchData[DT <: D](dataType: Class[DT], apply: UnitApply[DT]): UnitPFBuilder[D]

    Create a akka.japi.pf.UnitPFBuilder with the first case statement set.

    Create a akka.japi.pf.UnitPFBuilder with the first case statement set.

    dataType

    a type to match the argument against

    apply

    an action to apply to the argument if the type matches

    returns

    a builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  56. final def matchEvent(eventMatches: List[AnyRef], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches if any of the event types in the list match or any of the event instances in the list compares equal.

    eventMatches

    a list of types or instances to match against

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  57. final def matchEvent[DT <: D](eventMatches: List[AnyRef], dataType: Class[DT], apply: Apply2[AnyRef, DT, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches on the data type and if any of the event types in the list match or any of the event instances in the list compares equal.

    eventMatches

    a list of types or instances to match against

    dataType

    the data type to match on

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  58. final def matchEvent(predicate: TypedPredicate2[AnyRef, D], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches if the predicate matches.

    predicate

    a predicate that will be evaluated on the data and the event

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  59. final def matchEvent[ET](eventType: Class[ET], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches if the event type matches.

    eventType

    the event type to match on

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  60. final def matchEvent[ET](eventType: Class[ET], predicate: TypedPredicate2[ET, D], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches if the event type and predicate matches.

    eventType

    the event type to match on

    predicate

    a predicate that will be evaluated on the data and the event

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  61. final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches on an event and data type.

    eventType

    the event type to match on

    dataType

    the data type to match on

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  62. final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], predicate: TypedPredicate2[ET, DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches on an event and data type and a predicate.

    eventType

    the event type to match on

    dataType

    the data type to match on

    predicate

    a predicate to evaluate on the matched types

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  63. final def matchEventEquals[Ev](event: Ev, apply: Apply2[Ev, D, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches if the event compares equal.

    event

    an event to compare equal against

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  64. final def matchEventEquals[Ev, DT <: D](event: Ev, dataType: Class[DT], apply: Apply2[Ev, DT, State]): FSMStateFunctionBuilder[S, D, E]

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    A case statement that matches on the data type and if the event compares equal.

    event

    an event to compare equal against

    dataType

    the data type to match on

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  65. final def matchState(fromState: S, toState: S, apply: UnitApply2[S, S]): FSMTransitionHandlerBuilder[S]

    Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.

    Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.

    A case statement that matches on a from state and a to state.

    fromState

    the from state to match on

    toState

    the to state to match on

    apply

    an action to apply when the states match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  66. final def matchState(fromState: S, toState: S, apply: UnitApplyVoid): FSMTransitionHandlerBuilder[S]

    Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.

    Create an akka.japi.pf.FSMTransitionHandlerBuilder with the first case statement set.

    A case statement that matches on a from state and a to state.

    fromState

    the from state to match on

    toState

    the to state to match on

    apply

    an action to apply when the states match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  67. final def matchStop[RT <: Reason](reasonType: Class[RT], predicate: TypedPredicate[RT], apply: UnitApply3[RT, S, D]): FSMStopBuilder[S, D]

    Create an akka.japi.pf.FSMStopBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStopBuilder with the first case statement set.

    A case statement that matches on a reason type and a predicate.

    reasonType

    the reason type to match on

    predicate

    a predicate that will be evaluated on the reason if the type matches

    apply

    an action to apply to the reason, event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  68. final def matchStop[RT <: Reason](reasonType: Class[RT], apply: UnitApply3[RT, S, D]): FSMStopBuilder[S, D]

    Create an akka.japi.pf.FSMStopBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStopBuilder with the first case statement set.

    A case statement that matches on a reason type.

    reasonType

    the reason type to match on

    apply

    an action to apply to the reason, event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  69. final def matchStop(reason: Reason, apply: UnitApply2[S, D]): FSMStopBuilder[S, D]

    Create an akka.japi.pf.FSMStopBuilder with the first case statement set.

    Create an akka.japi.pf.FSMStopBuilder with the first case statement set.

    A case statement that matches on an PersistentFSM.Reason.

    reason

    the reason for the termination

    apply

    an action to apply to the event and state data if there is a match

    returns

    the builder with the case statement added

    Definition Classes
    AbstractPersistentFSMBase
  70. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. final def nextStateData: D

    Return next state data (available in onTransition handlers)

    Return next state data (available in onTransition handlers)

    Definition Classes
    PersistentFSMBase
  72. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  73. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  74. def onPersistFailure(cause: Throwable, event: Any, seqNr: Long): Unit

    Called when persist fails.

    Called when persist fails. By default it logs the error. Subclass may override to customize logging and for example send negative acknowledgment to sender.

    The actor is always stopped after this method has been invoked.

    Note that the event may or may not have been saved, depending on the type of failure.

    cause

    failure cause.

    event

    the event that was to be persisted

    Attributes
    protected
    Definition Classes
    Eventsourced
  75. def onPersistRejected(cause: Throwable, event: Any, seqNr: Long): Unit

    Called when the journal rejected persist of an event.

    Called when the journal rejected persist of an event. The event was not stored. By default this method logs the problem as an error, and the actor continues. The callback handler that was passed to the persist method will not be invoked.

    cause

    failure cause

    event

    the event that was to be persisted

    Attributes
    protected
    Definition Classes
    Eventsourced
  76. def onRecoveryCompleted(): Unit

    Override this handler to define the action on recovery completion

    Override this handler to define the action on recovery completion

    Definition Classes
    PersistentFSM
  77. def onRecoveryFailure(cause: Throwable, event: Option[Any]): Unit

    Called whenever a message replay fails.

    Called whenever a message replay fails. By default it logs the error.

    Subclass may override to customize logging.

    The actor is always stopped after this method has been invoked.

    cause

    failure cause.

    event

    the event that was processed in receiveRecover, if the exception was thrown there

    Attributes
    protected
    Definition Classes
    Eventsourced
  78. final def onTermination(stopBuilder: FSMStopBuilder[S, D]): Unit

    Set handler which is called upon termination of this FSM actor.

    Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.

    Definition Classes
    AbstractPersistentFSMBase
  79. final def onTermination(terminationHandler: PartialFunction[StopEvent, Unit]): Unit

    Set handler which is called upon termination of this FSM actor.

    Set handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.

    Definition Classes
    PersistentFSMBase
  80. final def onTransition(transitionHandler: UnitApply2[S, S]): Unit

    Add a handler which is called upon each state transition, i.e.

    Add a handler which is called upon each state transition, i.e. not when staying in the same state.

    Multiple handlers may be installed, and every one of them will be called, not only the first one matching.

    Definition Classes
    AbstractPersistentFSMBase
  81. final def onTransition(transitionHandlerBuilder: FSMTransitionHandlerBuilder[S]): Unit

    Add a handler which is called upon each state transition, i.e.

    Add a handler which is called upon each state transition, i.e. not when staying in the same state.

    Multiple handlers may be installed, and every one of them will be called, not only the first one matching.

    Definition Classes
    AbstractPersistentFSMBase
  82. final def onTransition(transitionHandler: TransitionHandler): Unit

    Set handler which is called upon each state transition, i.e.

    Set handler which is called upon each state transition, i.e. not when staying in the same state. This may use the pair extractor defined in the FSM companion object like so:

    onTransition {
      case Old -> New => doSomething
    }
    

    It is also possible to supply a 2-ary function object:

    onTransition(handler _)
    
    private def handler(from: S, to: S) { ... }
    

    The underscore is unfortunately necessary to enable the nicer syntax shown above (it uses the implicit conversion total2pf under the hood).

    Multiple handlers may be installed, and every one of them will be called, not only the first one matching.

    Definition Classes
    PersistentFSMBase
  83. def persist[A](event: A)(handler: (A) ⇒ Unit): Unit

    Asynchronously persists event.

    Asynchronously persists event. On successful persistence, handler is called with the persisted event. It is guaranteed that no new commands will be received by a persistent actor between a call to persist and the execution of its handler. This also holds for multiple persist calls per received command. Internally, this is achieved by stashing new commands and unstashing them when the event has been persisted and handled. The stash used for that is an internal stash which doesn't interfere with the inherited user stash.

    An event handler may close over persistent actor state and modify it. The sender of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    Within an event handler, applications usually update persistent actor state using persisted event data, notify listeners and reply to command senders.

    If persistence of an event fails, #onPersistFailure will be invoked and the actor will unconditionally be stopped. The reason that it cannot resume when persist fails is that it is unknown if the event was actually persisted or not, and therefore it is in an inconsistent state. Restarting on persistent failures will most likely fail anyway, since the journal is probably unavailable. It is better to stop the actor and after a back-off timeout start it again.

    event

    event to be persisted

    handler

    handler for each persisted event

    Definition Classes
    PersistentActor
  84. def persistAll[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Asynchronously persists events in specified order.

    Asynchronously persists events in specified order. This is equivalent to calling persist[A](event: A)(handler: A => Unit) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted

    handler

    handler for each persisted events

    Definition Classes
    PersistentActor
  85. def persistAllAsync[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Asynchronously persists events in specified order.

    Asynchronously persists events in specified order. This is equivalent to calling persistAsync[A](event: A)(handler: A => Unit) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted

    handler

    handler for each persisted events

    Definition Classes
    PersistentActor
  86. def persistAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Asynchronously persists event.

    Asynchronously persists event. On successful persistence, handler is called with the persisted event.

    Unlike persist the persistent actor will continue to receive incoming commands between the call to persist and executing it's handler. This asynchronous, non-stashing, version of of persist should be used when you favor throughput over the "command-2 only processed after command-1 effects' have been applied" guarantee, which is provided by the plain persist method.

    An event handler may close over persistent actor state and modify it. The sender of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    If persistence of an event fails, #onPersistFailure will be invoked and the actor will unconditionally be stopped. The reason that it cannot resume when persist fails is that it is unknown if the event was actually persisted or not, and therefore it is in an inconsistent state. Restarting on persistent failures will most likely fail anyway, since the journal is probably unavailable. It is better to stop the actor and after a back-off timeout start it again.

    event

    event to be persisted

    handler

    handler for each persisted event

    Definition Classes
    PersistentActor
  87. def postRestart(reason: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    reason

    the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
    Annotations
    @throws( classOf[Exception] )
  88. def postStop(): Unit

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox and clears the stash. Must be called when overriding this method, otherwise stashed messages won't be propagated to DeadLetters when actor stops.

    Definition Classes
    UnrestrictedStashActor
  89. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox, clears the stash, stops all children and invokes the postStop() callback.

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    UnrestrictedStashActor
  90. def preStart(): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

    Definition Classes
    Actor
    Annotations
    @throws( classOf[Exception] )
  91. def receive: Receive

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    PersistentActorActor
  92. def receiveCommand: Receive

    After recovery events are handled as in usual FSM actor

    After recovery events are handled as in usual FSM actor

    Definition Classes
    PersistentFSM → Eventsourced
  93. def receiveRecover: Receive

    Discover the latest recorded state

    Discover the latest recorded state

    Definition Classes
    PersistentFSM → Eventsourced
    Annotations
    @silent()
  94. def recovery: Recovery

    Called when the persistent actor is started for the first time.

    Called when the persistent actor is started for the first time. The returned Recovery object defines how the Actor will recover its persistent state before handling the first incoming message.

    To skip recovery completely return Recovery.none.

    Definition Classes
    PersistenceRecovery
  95. def recoveryFinished: Boolean

    Returns true if this persistent actor has successfully finished recovery.

    Returns true if this persistent actor has successfully finished recovery.

    Definition Classes
    Eventsourced
  96. def recoveryRunning: Boolean

    Returns true if this persistent actor is currently recovering.

    Returns true if this persistent actor is currently recovering.

    Definition Classes
    Eventsourced
  97. def saveSnapshot(snapshot: Any): Unit

    Saves a snapshot of this snapshotter's state.

    Saves a snapshot of this snapshotter's state.

    The PersistentActor will be notified about the success or failure of this via an SaveSnapshotSuccess or SaveSnapshotFailure message.

    Definition Classes
    Snapshotter
  98. final def saveStateSnapshot(): Unit

    Save the current state as a snapshot

    Save the current state as a snapshot

    Definition Classes
    PersistentFSM
  99. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself:

    self ! message
    

    Definition Classes
    Actor
  100. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in akka.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  101. final def setStateTimeout(state: S, timeout: Timeout): Unit

    Set state timeout explicitly.

    Set state timeout explicitly. This method can safely be used from within a state handler.

    Definition Classes
    PersistentFSMBase
  102. final def setTimer(name: String, msg: Any, timeout: FiniteDuration): Unit

    Schedule named timer to deliver message after given delay, possibly repeating.

    Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.

    name

    identifier to be used with cancelTimer()

    msg

    message to be delivered

    timeout

    delay of first message delivery and between subsequent messages

    Definition Classes
    AbstractPersistentFSMBase
  103. final def setTimer(name: String, msg: Any, timeout: FiniteDuration, repeat: Boolean = false): Unit

    Schedule named timer to deliver message after given delay, possibly repeating.

    Schedule named timer to deliver message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.

    name

    identifier to be used with cancelTimer()

    msg

    message to be delivered

    timeout

    delay of first message delivery and between subsequent messages

    repeat

    send once if false, scheduleAtFixedRate if true

    Definition Classes
    PersistentFSMBase
  104. def snapshotPluginId: String

    Configuration id of the snapshot plugin servicing this persistent actor.

    Configuration id of the snapshot plugin servicing this persistent actor. When empty, looks in akka.persistence.snapshot-store.plugin to find configuration entry path. When configured, uses snapshotPluginId as absolute path to the snapshot store configuration entry. Configuration entry must contain few required fields, such as class. See src/main/resources/reference.conf.

    Definition Classes
    PersistenceIdentity
  105. def snapshotSequenceNr: Long

    Returns lastSequenceNr.

    Returns lastSequenceNr.

    Definition Classes
    Eventsourced → Snapshotter
  106. def snapshotterId: String

    Returns persistenceId.

    Returns persistenceId.

    Definition Classes
    Eventsourced → Snapshotter
  107. final def startWith(stateName: S, stateData: D, timeout: FiniteDuration): Unit

    Set initial state.

    Set initial state. Call this method from the constructor before the #initialize method. If different state is needed after a restart this method, followed by #initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.

    stateName

    initial state designator

    stateData

    initial state data

    timeout

    state timeout for the initial state, overriding the default timeout for that state

    Definition Classes
    AbstractPersistentFSMBase
  108. final def startWith(stateName: S, stateData: D): Unit

    Set initial state.

    Set initial state. Call this method from the constructor before the #initialize method. If different state is needed after a restart this method, followed by #initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.

    stateName

    initial state designator

    stateData

    initial state data

    Definition Classes
    AbstractPersistentFSMBase
  109. final def startWith(stateName: S, stateData: D, timeout: Timeout = None): Unit

    Set initial state.

    Set initial state. Call this method from the constructor before the #initialize method. If different state is needed after a restart this method, followed by #initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.

    stateName

    initial state designator

    stateData

    initial state data

    timeout

    state timeout for the initial state, overriding the default timeout for that state

    Definition Classes
    PersistentFSMBase
  110. def stash(): Unit

    Adds the current message (the message that the actor received last) to the actor's stash.

    Adds the current message (the message that the actor received last) to the actor's stash.

    Definition Classes
    Eventsourced → StashSupport
    Exceptions thrown

    IllegalStateException if the same message is stashed more than once

    StashOverflowException in case of a stash capacity violation

  111. final def stateData: D

    Return current state data (i.e.

    Return current state data (i.e. object of type D)

    Definition Classes
    PersistentFSMBase
  112. final def stateName: S

    Return current state name (i.e.

    Return current state name (i.e. object of type S)

    Definition Classes
    PersistentFSMBase
  113. lazy val statesMap: Map[String, S]

    Map from state identifier to state instance

    Map from state identifier to state instance

    Definition Classes
    PersistentFSM
  114. final def stay(): State

    Produce "empty" transition descriptor.

    Produce "empty" transition descriptor. Return this from a state function when no state change is to be effected.

    No transition event will be triggered by #stay. If you want to trigger an event like S -> S for onTransition to handle use goto instead.

    returns

    descriptor for staying in current state

    Definition Classes
    PersistentFSMBase
  115. final def stop(reason: Reason, stateData: D): State

    Produce change descriptor to stop this FSM actor including specified reason.

    Produce change descriptor to stop this FSM actor including specified reason.

    Definition Classes
    PersistentFSMBase
  116. final def stop(reason: Reason): State

    Produce change descriptor to stop this FSM actor including specified reason.

    Produce change descriptor to stop this FSM actor including specified reason.

    Definition Classes
    PersistentFSMBase
  117. final def stop(): State

    Produce change descriptor to stop this FSM actor with reason "Normal".

    Produce change descriptor to stop this FSM actor with reason "Normal".

    Definition Classes
    PersistentFSMBase
  118. def supervisorStrategy: SupervisorStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    Actor
  119. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  120. def toString(): String
    Definition Classes
    AnyRef → Any
  121. implicit final def total2pf(transitionHandler: (S, S) ⇒ Unit): TransitionHandler

    Convenience wrapper for using a total function instead of a partial function literal.

    Convenience wrapper for using a total function instead of a partial function literal. To be used with onTransition.

    Definition Classes
    PersistentFSMBase
  122. final def transform(func: StateFunction): TransformHelper
    Definition Classes
    PersistentFSMBase
  123. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream

    Definition Classes
    Eventsourced → Actor
  124. def unstashAll(): Unit

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Messages from the stash are enqueued to the mailbox until the capacity of the mailbox (if any) has been reached. In case a bounded mailbox overflows, a MessageQueueAppendFailedException is thrown.

    The stash is guaranteed to be empty after calling unstashAll().

    Definition Classes
    Eventsourced → StashSupport
  125. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  127. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  128. final def when(stateName: S, stateTimeout: FiniteDuration, stateFunctionBuilder: FSMStateFunctionBuilder[S, D, E]): Unit

    Insert a new StateFunction at the end of the processing chain for the given state.

    Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.

    stateName

    designator for the state

    stateTimeout

    default state timeout for this state

    stateFunctionBuilder

    partial function builder describing response to input

    Definition Classes
    AbstractPersistentFSMBase
  129. final def when(stateName: S, stateFunctionBuilder: FSMStateFunctionBuilder[S, D, E]): Unit

    Insert a new StateFunction at the end of the processing chain for the given state.

    Insert a new StateFunction at the end of the processing chain for the given state.

    stateName

    designator for the state

    stateFunctionBuilder

    partial function builder describing response to input

    Definition Classes
    AbstractPersistentFSMBase
  130. final def when(stateName: S)(stateFunction: StateFunction): Unit

    Insert a new StateFunction at the end of the processing chain for the given state.

    Insert a new StateFunction at the end of the processing chain for the given state.

    stateName

    designator for the state

    stateFunction

    partial function describing response to input

    Definition Classes
    AbstractPersistentFSMBase
  131. final def when(stateName: S, stateTimeout: FiniteDuration = null)(stateFunction: StateFunction): Unit

    Insert a new StateFunction at the end of the processing chain for the given state.

    Insert a new StateFunction at the end of the processing chain for the given state. If the stateTimeout parameter is set, entering this state without a differing explicit timeout setting will trigger a StateTimeout event; the same is true when using #stay.

    stateName

    designator for the state

    stateTimeout

    default state timeout for this state

    stateFunction

    partial function describing response to input

    Definition Classes
    PersistentFSMBase
  132. final def whenUnhandled(stateFunctionBuilder: FSMStateFunctionBuilder[S, D, E]): Unit

    Set handler which is called upon reception of unhandled messages.

    Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.

    The current state may be queried using stateName.

    Definition Classes
    AbstractPersistentFSMBase
  133. final def whenUnhandled(stateFunction: StateFunction): Unit

    Set handler which is called upon reception of unhandled messages.

    Set handler which is called upon reception of unhandled messages. Calling this method again will overwrite the previous contents.

    The current state may be queried using stateName.

    Definition Classes
    PersistentFSMBase
  134. def [B](y: B): (AbstractPersistentFSM[S, D, E], B)
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSM[S, D, E] to ArrowAssoc[AbstractPersistentFSM[S, D, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def ->[B](y: B): (AbstractPersistentFSM[S, D, E], B)
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSM[S, D, E] to ArrowAssoc[AbstractPersistentFSM[S, D, E]] performed by method ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (abstractPersistentFSM: ArrowAssoc[AbstractPersistentFSM[S, D, E]]).->(y)
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from PersistentFSM[S, D, E]

Inherited from PersistentActor

Inherited from Eventsourced

Inherited from PersistenceRecovery

Inherited from PersistenceIdentity

Inherited from PersistenceStash

Inherited from StashFactory

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from AbstractPersistentFSMBase[S, D, E]

Inherited from PersistentFSMBase[S, D, E]

Inherited from ActorLogging

Inherited from Listeners

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AbstractPersistentFSM[S, D, E] to any2stringadd[AbstractPersistentFSM[S, D, E]]

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

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

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

Ungrouped