Apache Pekko
2.0.0-M3
API
Generated with
Apache Pekko/org.apache.pekko/org.apache.pekko.actor/AbstractLoggingFSM

AbstractLoggingFSM

org.apache.pekko.actor.AbstractLoggingFSM
abstract class AbstractLoggingFSM[S, D] extends AbstractFSM[S, D], LoggingFSM[S, D]

Java API: compatible with lambda expressions

Finite State Machine actor abstract base class.

Attributes

Source
AbstractFSM.scala
Graph
Supertypes
trait LoggingFSM[S, D]
class AbstractFSM[S, D]
trait FSM[S, D]
trait ActorLogging
trait Listeners
trait Actor
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

final class TransformHelper(func: StateFunction)

Attributes

Inherited from:
FSM
Source
FSM.scala
Supertypes
class Object
trait Matchable
class Any

Inherited types

type Event = Event[D]

Attributes

Inherited from:
FSM
Source
FSM.scala
type Receive = Receive

Attributes

Inherited from:
Actor
Source
Actor.scala
type State = State[S, D]

Attributes

Inherited from:
FSM
Source
FSM.scala
type StateFunction = PartialFunction[Event, State]

Attributes

Inherited from:
FSM
Source
FSM.scala
type StopEvent = StopEvent[S, D]

Attributes

Inherited from:
FSM
Source
FSM.scala
type Timeout = Option[FiniteDuration]

Attributes

Inherited from:
FSM
Source
FSM.scala
type TransitionHandler = PartialFunction[(S, S), Unit]

Attributes

Inherited from:
FSM
Source
FSM.scala

Value members

Inherited methods

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

Value parameters

name

of the timer to cancel

Attributes

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
protected def getLog: IndexedSeq[LogEntry[S, D]]

Retrieve current rolling log in oldest-first order. The log is filled with each incoming event before processing by the user supplied state handler. The log entries are lost when this actor is restarted.

Retrieve current rolling log in oldest-first order. The log is filled with each incoming event before processing by the user supplied state handler. The log entries are lost when this actor is restarted.

Attributes

Inherited from:
LoggingFSM
Source
FSM.scala
def getSelf(): ActorRef

Returns the ActorRef for this actor.

Returns the ActorRef for this actor.

Same as self().

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
def getSender(): ActorRef

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.

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!

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def goTo(nextStateName: S): State

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

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

Value parameters

nextStateName

state designator for the next state

Attributes

Returns

state transition descriptor

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
protected def gossip(msg: Any)(implicit sender: ActorRef = ...): 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

Inherited from:
Listeners
Source
Listeners.scala
final def goto(nextStateName: S): State

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

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.

Value parameters

nextStateName

state designator for the next state

Attributes

Returns

state transition descriptor

Inherited from:
FSM
Source
FSM.scala
final def initialize(): Unit

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

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

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

Attributes

See also
Inherited from:
FSM
Source
FSM.scala
final def isTimerActive(name: String): Boolean

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.

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.

Attributes

Inherited from:
FSM
Source
FSM.scala
protected def listenerManagement: Receive

Chain this into the receive function.

Chain this into the receive function.

 def receive = listenerManagement orElse …

Attributes

Inherited from:
Listeners
Source
Listeners.scala
def log: LoggingAdapter

Attributes

Inherited from:
ActorLogging
Source
Actor.scala
def logDepth: Int

Attributes

Inherited from:
LoggingFSM
Source
FSM.scala
final def matchAnyEvent(apply: Function2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

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

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

A case statement that matches on any type of event.

Value parameters

apply

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

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchData[DT <: D](dataType: Class[DT], predicate: Predicate[DT], apply: Procedure[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.

Value parameters

apply

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

dataType

a type to match the argument against

predicate

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

Attributes

Returns

a builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchData[DT <: D](dataType: Class[DT], apply: Procedure[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.

Value parameters

apply

an action to apply to the argument if the type matches

dataType

a type to match the argument against

Attributes

Returns

a builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEvent(eventMatches: List[AnyRef], apply: Function2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

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

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

Value parameters

apply

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

eventMatches

a list of types or instances to match against

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEvent[DT <: D](eventMatches: List[AnyRef], dataType: Class[DT], apply: Function2[AnyRef, DT, State]): FSMStateFunctionBuilder[S, D]

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

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

Value parameters

apply

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

dataType

the data type to match on

eventMatches

a list of types or instances to match against

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEvent(predicate: Predicate2[AnyRef, D], apply: Function2[AnyRef, D, State]): FSMStateFunctionBuilder[S, D]

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

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

A case statement that matches if the predicate matches.

Value parameters

apply

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

predicate

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

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEvent[ET](eventType: Class[ET], apply: Function2[ET, D, State]): FSMStateFunctionBuilder[S, D]

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

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

A case statement that matches if the event type matches.

Value parameters

apply

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

eventType

the event type to match on

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEvent[ET](eventType: Class[ET], predicate: Predicate2[ET, D], apply: Function2[ET, D, State]): FSMStateFunctionBuilder[S, D]

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

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

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

Value parameters

apply

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

eventType

the event type to match on

predicate

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

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], apply: Function2[ET, DT, State]): FSMStateFunctionBuilder[S, D]

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

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

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

Value parameters

apply

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

dataType

the data type to match on

eventType

the event type to match on

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEvent[ET, DT <: D](eventType: Class[ET], dataType: Class[DT], predicate: Predicate2[ET, DT], apply: Function2[ET, DT, State]): FSMStateFunctionBuilder[S, D]

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

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

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

Value parameters

apply

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

dataType

the data type to match on

eventType

the event type to match on

predicate

a predicate to evaluate on the matched types

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEventEquals[E](event: E, apply: Function2[E, D, State]): FSMStateFunctionBuilder[S, D]

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

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

A case statement that matches if the event compares equal.

Value parameters

apply

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

event

an event to compare equal against

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchEventEquals[E, DT <: D](event: E, dataType: Class[DT], apply: Function2[E, DT, State]): FSMStateFunctionBuilder[S, D]

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

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

Value parameters

apply

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

dataType

the data type to match on

event

an event to compare equal against

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchState(fromState: S, toState: S, apply: Procedure2[S, S]): FSMTransitionHandlerBuilder[S]

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

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

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

Value parameters

apply

an action to apply when the states match

fromState

the from state to match on

toState

the to state to match on

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchState(fromState: S, toState: S, apply: Effect): FSMTransitionHandlerBuilder[S]

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

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

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

Value parameters

apply

an action to apply when the states match

fromState

the from state to match on

toState

the to state to match on

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchStop[RT <: Reason](reasonType: Class[RT], predicate: Predicate[RT], apply: Procedure3[RT, S, D]): FSMStopBuilder[S, D]

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

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

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

Value parameters

apply

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

predicate

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

reasonType

the reason type to match on

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchStop[RT <: Reason](reasonType: Class[RT], apply: Procedure3[RT, S, D]): FSMStopBuilder[S, D]

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

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

A case statement that matches on a reason type.

Value parameters

apply

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

reasonType

the reason type to match on

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def matchStop(reason: Reason, apply: Procedure2[S, D]): FSMStopBuilder[S, D]

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

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

A case statement that matches on a FSM.Reason.

Value parameters

apply

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

reason

the reason for the termination

Attributes

Returns

the builder with the case statement added

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def nextStateData: D

Return next state data (available in onTransition handlers)

Return next state data (available in onTransition handlers)

Attributes

Inherited from:
FSM
Source
FSM.scala
final def onTermination(terminationHandler: PartialFunction[StopEvent, Unit]): Unit

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

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

Attributes

Inherited from:
FSM
Source
FSM.scala
final def onTermination(stopBuilder: FSMStopBuilder[S, D]): Unit

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

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

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def onTransition(transitionHandler: TransitionHandler): Unit

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:

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.

Attributes

Inherited from:
FSM
Source
FSM.scala
final def onTransition(transitionHandler: Procedure2[S, S]): Unit

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

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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def onTransition(transitionHandlerBuilder: FSMTransitionHandlerBuilder[S]): Unit

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

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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
def postRestart(reason: Throwable): Unit

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

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

Value parameters

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.

Attributes

Inherited from:
Actor
Source
Actor.scala
override 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.

Attributes

Definition Classes
FSM -> Actor
Inherited from:
FSM
Source
FSM.scala
def preRestart(reason: Throwable, message: Option[Any]): Unit

Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''

Scala API: User overridable callback: '''By default it disposes of all children and then calls postStop().'''

Value parameters

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.

reason

the Throwable that caused the restart to happen

Attributes

Inherited from:
Actor
Source
Actor.scala
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.

Attributes

Inherited from:
Actor
Source
Actor.scala
override 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.

Attributes

Definition Classes
FSM -> Actor
Inherited from:
FSM
Source
FSM.scala
final def sender(): ActorRef

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

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

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

Attributes

Inherited from:
Actor
Source
Actor.scala
final def setStateTimeout(state: S, timeout: Timeout): Unit

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

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

Attributes

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
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.

Attributes

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
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.

Attributes

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def startWith(stateName: S, stateData: D, timeout: Timeout = ...): Unit

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.

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.

Value parameters

stateData

initial state data

stateName

initial state designator

timeout

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

Attributes

Inherited from:
FSM
Source
FSM.scala
final def startWith(stateName: S, stateData: D, timeout: Duration): Unit

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.

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.

Value parameters

stateData

initial state data

stateName

initial state designator

timeout

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

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def startWith(stateName: S, stateData: D, timeout: FiniteDuration): Unit

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.

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.

Value parameters

stateData

initial state data

stateName

initial state designator

timeout

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

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def startWith(stateName: S, stateData: D): Unit

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.

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.

Value parameters

stateData

initial state data

stateName

initial state designator

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def stateData: D

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

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

Attributes

Inherited from:
FSM
Source
FSM.scala
final def stateName: S

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

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

Attributes

Inherited from:
FSM
Source
FSM.scala
final def stay(): State

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

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 -&gt; S for onTransition to handle use goto instead.

Attributes

Returns

descriptor for staying in current state

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
FSM
Source
FSM.scala
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".

Attributes

Inherited from:
FSM
Source
FSM.scala
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.

Attributes

Inherited from:
Actor
Source
Actor.scala
final def transform(func: StateFunction): TransformHelper

Attributes

Inherited from:
FSM
Source
FSM.scala
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 pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes a pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream

Attributes

Inherited from:
Actor
Source
Actor.scala
final def when(stateName: S, stateTimeout: FiniteDuration = ...)(stateFunction: StateFunction): Unit

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.

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.

Value parameters

stateFunction

partial function describing response to input

stateName

designator for the state

stateTimeout

default state timeout for this state

Attributes

Inherited from:
FSM
Source
FSM.scala
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. 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.

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.

Value parameters

stateFunctionBuilder

partial function builder describing response to input

stateName

designator for the state

stateTimeout

default state timeout for this state

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
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. 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.

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.

Value parameters

stateFunctionBuilder

partial function builder describing response to input

stateName

designator for the state

stateTimeout

default state timeout for this state

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
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.

Value parameters

stateFunctionBuilder

partial function builder describing response to input

stateName

designator for the state

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
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.

Value parameters

stateFunction

partial function describing response to input

stateName

designator for the state

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
final def whenUnhandled(stateFunction: StateFunction): Unit

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

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.

Attributes

Inherited from:
FSM
Source
FSM.scala
final def whenUnhandled(stateFunctionBuilder: FSMStateFunctionBuilder[S, D]): Unit

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

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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala

Inherited fields

val ->: ->.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.

Attributes

Inherited from:
FSM
Source
FSM.scala
val Event: Event.type

Attributes

Inherited from:
FSM
Source
FSM.scala
val Normal: Reason

Default reason if calling stop().

Default reason if calling stop().

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
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.

Attributes

Inherited from:
AbstractFSM
Source
AbstractFSM.scala
val StateTimeout: StateTimeout.type

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

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

Attributes

Inherited from:
FSM
Source
FSM.scala
val StopEvent: StopEvent.type

Attributes

Inherited from:
FSM
Source
FSM.scala
protected val listeners: Set[ActorRef]

Attributes

Inherited from:
Listeners
Source
Listeners.scala

Implicits

Inherited implicits

implicit val context: ActorContext

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

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!

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

Attributes

Inherited from:
Actor
Source
Actor.scala
final implicit 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

Attributes

Inherited from:
Actor
Source
Actor.scala
final implicit def total2pf(transitionHandler: (S, S) => Unit): TransitionHandler

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

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

Attributes

Inherited from:
FSM
Source
FSM.scala
Generated with