Packages

c

akka.actor

AbstractFSMWithStash

abstract class AbstractFSMWithStash[S, D] extends AbstractFSM[S, D] with Stash

Java API: compatible with lambda expressions

Finite State Machine actor abstract base class with Stash support.

Source
AbstractFSM.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractFSMWithStash
  2. Stash
  3. RequiresMessageQueue
  4. UnrestrictedStash
  5. StashSupport
  6. AbstractFSM
  7. FSM
  8. ActorLogging
  9. Listeners
  10. Actor
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AbstractFSMWithStash()

Type Members

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

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 AbstractFSMWithStash[S, D] toany2stringadd[AbstractFSMWithStash[S, D]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. val ->: FSM.->.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
    FSM
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val Event: FSM.Event.type
    Definition Classes
    FSM
  7. val Normal: Reason

    Default reason if calling stop().

    Default reason if calling stop().

    Definition Classes
    AbstractFSM
  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
    AbstractFSM
  9. val StateTimeout: FSM.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
    FSM
  10. val StopEvent: FSM.StopEvent.type
    Definition Classes
    FSM
  11. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  12. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postStop. Calls postStop by default.

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

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preRestart. Calls preRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  14. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preStart. Calls preStart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  15. def aroundReceive(receive: Actor.Receive, msg: Any): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to this actor's current behavior.

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[akka]
    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
    FSM
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  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 ensuring(cond: (AbstractFSMWithStash[S, D]) => Boolean, msg: => Any): AbstractFSMWithStash[S, D]
    Implicit
    This member is added by an implicit conversion from AbstractFSMWithStash[S, D] toEnsuring[AbstractFSMWithStash[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (AbstractFSMWithStash[S, D]) => Boolean): AbstractFSMWithStash[S, D]
    Implicit
    This member is added by an implicit conversion from AbstractFSMWithStash[S, D] toEnsuring[AbstractFSMWithStash[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: => Any): AbstractFSMWithStash[S, D]
    Implicit
    This member is added by an implicit conversion from AbstractFSMWithStash[S, D] toEnsuring[AbstractFSMWithStash[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): AbstractFSMWithStash[S, D]
    Implicit
    This member is added by an implicit conversion from AbstractFSMWithStash[S, D] toEnsuring[AbstractFSMWithStash[S, D]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. def getContext(): AbstractActor.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
    AbstractFSM
  28. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Same as self().

    Definition Classes
    AbstractFSM
  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!

    Definition Classes
    AbstractFSM
  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

    Definition Classes
    AbstractFSM
  31. 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
  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
    FSM
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  34. final def initialize(): Unit

    Verify existence of initial state and setup timers.

    Verify existence of initial state and setup timers. This should be the last call within the constructor, or akka.actor.Actor#preStart and akka.actor.Actor#postRestart

    An initial currentState -> currentState notification will be triggered by calling this method.

    Definition Classes
    FSM
    See also

    #startWith

  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. 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
    FSM
  37. def listenerManagement: Actor.Receive

    Chain this into the receive function.

    Chain this into the receive function.

    def receive = listenerManagement orElse …
    Attributes
    protected
    Definition Classes
    Listeners
  38. val listeners: Set[ActorRef]
    Attributes
    protected
    Definition Classes
    Listeners
  39. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  40. def logTermination(reason: Reason): Unit

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

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

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

    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
    AbstractFSM
  42. 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
    AbstractFSM
  43. 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
    AbstractFSM
  44. final def matchEvent(eventMatches: List[AnyRef], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  45. final def matchEvent[DT <: D](eventMatches: List[AnyRef], dataType: Class[DT], apply: Apply2[AnyRef, DT, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  46. final def matchEvent(predicate: TypedPredicate2[AnyRef, D], apply: Apply2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  47. final def matchEvent[ET](eventType: Class[ET], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  48. final def matchEvent[ET](eventType: Class[ET], predicate: TypedPredicate2[ET, D], apply: Apply2[ET, D, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  49. final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  50. final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], predicate: TypedPredicate2[ET, DT], apply: Apply2[ET, DT, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  51. final def matchEventEquals[E](event: E, apply: Apply2[E, D, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  52. final def matchEventEquals[E, DT <: D](event: E, dataType: Class[DT], apply: Apply2[E, DT, State]): FSMStateFunctionBuilder[S, D]

    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
    AbstractFSM
  53. 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
    AbstractFSM
  54. 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
    AbstractFSM
  55. 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
    AbstractFSM
  56. 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
    AbstractFSM
  57. 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 FSM.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
    AbstractFSM
  58. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. final def nextStateData: D

    Return next state data (available in onTransition handlers)

    Return next state data (available in onTransition handlers)

    Definition Classes
    FSM
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  62. 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
    AbstractFSM
  63. 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
    FSM
  64. 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
    AbstractFSM
  65. 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
    AbstractFSM
  66. 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
    FSM
  67. 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])
  68. 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
    Annotations
    @throws(classOf[Exception])
  69. 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
    Annotations
    @throws(classOf[Exception])
  70. 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])
  71. 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
    FSMActor
  72. 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
  73. 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
  74. 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
    FSM
  75. 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.

    Definition Classes
    AbstractFSM
  76. 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
    FSM
  77. 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.

    Definition Classes
    AbstractFSM
  78. 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
    FSM
  79. 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.

    Definition Classes
    AbstractFSM
  80. 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
    FSM
  81. final def startWith(stateName: S, stateData: D, timeout: Duration): 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
    AbstractFSM
  82. 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
    AbstractFSM
  83. 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
    AbstractFSM
  84. 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
    FSM
  85. 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
    StashSupport
    Exceptions thrown

    IllegalStateException if the same message is stashed more than once

    StashOverflowException in case of a stash capacity violation

  86. final def stateData: D

    Return current state data (i.e.

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

    Definition Classes
    FSM
  87. final def stateName: S

    Return current state name (i.e.

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

    Definition Classes
    FSM
  88. 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
    FSM
  89. 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
    FSM
  90. 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
    FSM
  91. 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
    FSM
  92. 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
  93. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  94. def toString(): String
    Definition Classes
    AnyRef → Any
  95. 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
    FSM
  96. final def transform(func: StateFunction): TransformHelper
    Definition Classes
    FSM
  97. 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
    Actor
  98. 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
    StashSupport
  99. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  100. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  101. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  102. final def when(stateName: S, stateTimeout: Duration, stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): 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
    AbstractFSM
  103. final def when(stateName: S, stateTimeout: FiniteDuration, stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): 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
    AbstractFSM
  104. final def when(stateName: S, stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): 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
    AbstractFSM
  105. 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
    AbstractFSM
  106. 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
    FSM
  107. final def whenUnhandled(stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): 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
    AbstractFSM
  108. 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
    FSM

Shadowed Implicit Value Members

  1. def ->[B](y: B): (AbstractFSMWithStash[S, D], B)
    Implicit
    This member is added by an implicit conversion from AbstractFSMWithStash[S, D] toArrowAssoc[AbstractFSMWithStash[S, D]] 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:
    (abstractFSMWithStash: ArrowAssoc[AbstractFSMWithStash[S, D]]).->(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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AbstractFSMWithStash[S, D] toStringFormat[AbstractFSMWithStash[S, D]] 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: Duration, repeat: Boolean): 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
    AbstractFSM
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use startSingleTimer, startTimerWithFixedDelay or startTimerAtFixedRate instead. This has the same semantics as startTimerAtFixedRate, but startTimerWithFixedDelay is often preferred.

  4. final def setTimer(name: String, msg: Any, timeout: Duration): 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
    AbstractFSM
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use startSingleTimer instead.

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

    (Since version 2.6.0) Use startSingleTimer instead.

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

    (Since version 2.6.0) Use startSingleTimer, startTimerWithFixedDelay or startTimerAtFixedRate instead. This has the same semantics as startTimerAtFixedRate, but startTimerWithFixedDelay is often preferred.

  7. def [B](y: B): (AbstractFSMWithStash[S, D], B)
    Implicit
    This member is added by an implicit conversion from AbstractFSMWithStash[S, D] toArrowAssoc[AbstractFSMWithStash[S, D]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from AbstractFSM[S, D]

Inherited from FSM[S, D]

Inherited from ActorLogging

Inherited from Listeners

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAbstractFSMWithStash[S, D] to any2stringadd[AbstractFSMWithStash[S, D]]

Inherited by implicit conversion StringFormat fromAbstractFSMWithStash[S, D] to StringFormat[AbstractFSMWithStash[S, D]]

Inherited by implicit conversion Ensuring fromAbstractFSMWithStash[S, D] to Ensuring[AbstractFSMWithStash[S, D]]

Inherited by implicit conversion ArrowAssoc fromAbstractFSMWithStash[S, D] to ArrowAssoc[AbstractFSMWithStash[S, D]]

Ungrouped