Packages

abstract class AbstractPersistentFSMBase[S, D, E] extends PersistentFSMBase[S, D, E]

Java API: compatible with lambda expressions

Finite State Machine actor abstract base class.

Annotations
@deprecated
Deprecated

(Since version Akka 2.6.0) Use EventSourcedBehavior

Source
PersistentFSMBase.scala
Linear Supertypes
PersistentFSMBase[S, D, E], ActorLogging, Listeners, Actor, AnyRef, Any
Known Subclasses
AbstractPersistentFSM, AbstractPersistentLoggingFSM
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractPersistentFSMBase
  2. PersistentFSMBase
  3. ActorLogging
  4. Listeners
  5. Actor
  6. AnyRef
  7. 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 AbstractPersistentFSMBase()

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

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 AbstractPersistentFSMBase[S, D, E] to any2stringadd[AbstractPersistentFSMBase[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().

  8. val Shutdown: Reason

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

  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
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  12. def aroundPostStop(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  13. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  14. def aroundPreStart(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  15. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  19. implicit val context: ActorContext
    Definition Classes
    Actor
  20. def ensuring(cond: (AbstractPersistentFSMBase[S, D, E]) ⇒ Boolean, msg: ⇒ Any): AbstractPersistentFSMBase[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSMBase[S, D, E] to Ensuring[AbstractPersistentFSMBase[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (AbstractPersistentFSMBase[S, D, E]) ⇒ Boolean): AbstractPersistentFSMBase[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSMBase[S, D, E] to Ensuring[AbstractPersistentFSMBase[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractPersistentFSMBase[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSMBase[S, D, E] to Ensuring[AbstractPersistentFSMBase[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): AbstractPersistentFSMBase[S, D, E]
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSMBase[S, D, E] to Ensuring[AbstractPersistentFSMBase[S, D, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. def getContext(): ActorContext

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

  28. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Same as self().

  29. 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!

  30. 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

  31. def gossip(msg: Any)(implicit sender: ActorRef): Unit
    Attributes
    protected
    Definition Classes
    Listeners
  32. 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
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. 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
  36. def listenerManagement: actor.Actor.Receive
    Attributes
    protected
    Definition Classes
    Listeners
  37. val listeners: Set[ActorRef]
    Attributes
    protected
    Definition Classes
    Listeners
  38. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  39. 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
  40. final def matchAnyEvent(apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D, E]

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

    Create an pekko.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

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

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

    Create a pekko.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

  42. final def matchData[DT <: D](dataType: Class[DT], apply: UnitApply[DT]): UnitPFBuilder[D]

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

    Create a pekko.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

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

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

    Create an pekko.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

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

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

    Create an pekko.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

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

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

    Create an pekko.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

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

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

    Create an pekko.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

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

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

    Create an pekko.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

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

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

    Create an pekko.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

  49. 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 pekko.japi.pf.FSMStateFunctionBuilder with the first case statement set.

    Create an pekko.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

  50. final def matchEventEquals[Ev](event: Ev, apply: Apply2[Ev, D, State]): FSMStateFunctionBuilder[S, D, E]

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

    Create an pekko.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

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

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

    Create an pekko.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

  52. final def matchState(fromState: S, toState: S, apply: UnitApply2[S, S]): FSMTransitionHandlerBuilder[S]

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

    Create an pekko.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

  53. final def matchState(fromState: S, toState: S, apply: UnitApplyVoid): FSMTransitionHandlerBuilder[S]

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

    Create an pekko.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

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

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

    Create an pekko.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

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

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

    Create an pekko.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

  56. final def matchStop(reason: Reason, apply: UnitApply2[S, D]): FSMStopBuilder[S, D]

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

    Create an pekko.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

  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. final def nextStateData: D

    Return next state data (available in onTransition handlers)

    Return next state data (available in onTransition handlers)

    Definition Classes
    PersistentFSMBase
  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  61. 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.

  62. 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
  63. 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.

  64. 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.

  65. 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
  66. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  67. def postStop(): Unit

    Call onTermination hook; if you want to retain this behavior when overriding make sure to call super.postStop().

    Call onTermination hook; if you want to retain this behavior when overriding make sure to call super.postStop().

    Please note that this method is called by default from preRestart(), so override that one if onTermination shall not be called during restart.

    Definition Classes
    PersistentFSMBase → Actor
    Annotations
    @throws( classOf[Exception] )
  68. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  69. def preStart(): Unit
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  70. def receive: Receive
    Definition Classes
    PersistentFSMBase → Actor
  71. implicit final val self: ActorRef
    Definition Classes
    Actor
  72. final def sender(): ActorRef
    Definition Classes
    Actor
  73. 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
  74. def startSingleTimer(name: String, msg: Any, delay: Duration): Unit

    Start a timer that will send msg once to the self actor after the given delay.

    Start a timer that will send msg once to the self actor after the given delay.

    Each timer has a name and if a new timer with same name is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.

  75. def startSingleTimer(name: String, msg: Any, delay: FiniteDuration): Unit

    Start a timer that will send msg once to the self actor after the given delay.

    Start a timer that will send msg once to the self actor after the given delay.

    Each timer has a name and if a new timer with same name is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.

    Definition Classes
    PersistentFSMBase
  76. def startTimerAtFixedRate(name: String, msg: Any, interval: Duration): Unit

    Schedules a message to be sent repeatedly to the self actor with a given frequency.

    Schedules a message to be sent repeatedly to the self actor with a given frequency.

    It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.

    If the execution is delayed longer than the interval, the subsequent message will be sent immediately after the prior one. This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" messages will be sent when the process wakes up again.

    In the long run, the frequency of messages will be exactly the reciprocal of the specified interval.

    Warning: startTimerAtFixedRate can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore startTimerWithFixedDelay is often preferred.

    Each timer has a name and if a new timer with same name is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.

  77. def startTimerAtFixedRate(name: String, msg: Any, interval: FiniteDuration): Unit

    Schedules a message to be sent repeatedly to the self actor with a given frequency.

    Schedules a message to be sent repeatedly to the self actor with a given frequency.

    It will compensate the delay for a subsequent message if the sending of previous message was delayed more than specified. In such cases, the actual message interval will differ from the interval passed to the method.

    If the execution is delayed longer than the interval, the subsequent message will be sent immediately after the prior one. This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" messages will be sent when the process wakes up again.

    In the long run, the frequency of messages will be exactly the reciprocal of the specified interval.

    Warning: startTimerAtFixedRate can result in bursts of scheduled messages after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore startTimerWithFixedDelay is often preferred.

    Each timer has a name and if a new timer with same name is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.

    Definition Classes
    PersistentFSMBase
  78. def startTimerWithFixedDelay(name: String, msg: Any, delay: Duration): Unit

    Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.

    Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.

    It will not compensate the delay between messages if scheduling is delayed longer than specified for some reason. The delay between sending of subsequent messages will always be (at least) the given delay.

    In the long run, the frequency of messages will generally be slightly lower than the reciprocal of the specified delay.

    Each timer has a name and if a new timer with same name is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.

  79. def startTimerWithFixedDelay(name: String, msg: Any, delay: FiniteDuration): Unit

    Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.

    Schedules a message to be sent repeatedly to the self actor with a fixed delay between messages.

    It will not compensate the delay between messages if scheduling is delayed longer than specified for some reason. The delay between sending of subsequent messages will always be (at least) the given delay.

    In the long run, the frequency of messages will generally be slightly lower than the reciprocal of the specified delay.

    Each timer has a name and if a new timer with same name is started the previous is cancelled. It is guaranteed that a message from the previous timer is not received, even if it was already enqueued in the mailbox when the new timer was started.

    Definition Classes
    PersistentFSMBase
  80. 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 pekko.actor.Actor#preStart and pekko.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

  81. 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 pekko.actor.Actor#preStart and pekko.actor.Actor#postRestart.

    stateName

    initial state designator

    stateData

    initial state data

  82. 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 pekko.actor.Actor#preStart and pekko.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
  83. final def stateData: D

    Return current state data (i.e.

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

    Definition Classes
    PersistentFSMBase
  84. final def stateName: S

    Return current state name (i.e.

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

    Definition Classes
    PersistentFSMBase
  85. 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
  86. 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
  87. 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
  88. 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
  89. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  90. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  91. def toString(): String
    Definition Classes
    AnyRef → Any
  92. 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
  93. final def transform(func: StateFunction): TransformHelper
    Definition Classes
    PersistentFSMBase
  94. def unhandled(message: Any): Unit
    Definition Classes
    Actor
  95. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  97. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. 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

  99. 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

  100. 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

  101. 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
  102. 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.

  103. 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
  104. def →[B](y: B): (AbstractPersistentFSMBase[S, D, E], B)
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSMBase[S, D, E] to ArrowAssoc[AbstractPersistentFSMBase[S, D, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def ->[B](y: B): (AbstractPersistentFSMBase[S, D, E], B)
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSMBase[S, D, E] to ArrowAssoc[AbstractPersistentFSMBase[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:
    (abstractPersistentFSMBase: ArrowAssoc[AbstractPersistentFSMBase[S, D, E]]).->(y)
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractPersistentFSMBase[S, D, E] to StringFormat[AbstractPersistentFSMBase[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. 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

    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.0) Use startSingleTimer instead.

  4. 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
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.0)

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 AbstractPersistentFSMBase[S, D, E] to any2stringadd[AbstractPersistentFSMBase[S, D, E]]

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

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

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

Ungrouped