trait LoggingPersistentFSM[S, D, E] extends PersistentFSMBase[S, D, E]
Stackable trait for akka.actor.FSM which adds a rolling event log and debug logging capabilities (analogous to akka.event.LoggingReceive).
- Self Type
- LoggingPersistentFSM[S, D, E] with Actor
- Source
- PersistentFSMBase.scala
- Alphabetic
- By Inheritance
- LoggingPersistentFSM
- PersistentFSMBase
- ActorLogging
- Listeners
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
type
Event = PersistentFSM.Event[D]
- Definition Classes
- PersistentFSMBase
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
-
type
State = PersistentFSM.State[S, D, E]
- Definition Classes
- PersistentFSMBase
-
type
StateFunction = PartialFunction[(LoggingPersistentFSM.this)#Event, (LoggingPersistentFSM.this)#State]
- Definition Classes
- PersistentFSMBase
-
type
StopEvent = PersistentFSM.StopEvent[S, D]
- Definition Classes
- PersistentFSMBase
-
type
Timeout = Option[FiniteDuration]
- Definition Classes
- PersistentFSMBase
-
type
TransitionHandler = PartialFunction[(S, S), Unit]
- Definition Classes
- PersistentFSMBase
-
final
class
TransformHelper extends AnyRef
- Definition Classes
- PersistentFSMBase
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to any2stringadd[LoggingPersistentFSM[S, D, E]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
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
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
Event: PersistentFSM.Event.type
- Definition Classes
- PersistentFSMBase
-
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
-
val
StopEvent: PersistentFSM.StopEvent.type
- Definition Classes
- PersistentFSMBase
-
def
aroundPostRestart(reason: Throwable): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundPostStop(): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundPreStart(): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
def
aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
implicit
val
context: ActorContext
- Definition Classes
- Actor
-
def
ensuring(cond: (LoggingPersistentFSM[S, D, E]) ⇒ Boolean, msg: ⇒ Any): LoggingPersistentFSM[S, D, E]
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to Ensuring[LoggingPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (LoggingPersistentFSM[S, D, E]) ⇒ Boolean): LoggingPersistentFSM[S, D, E]
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to Ensuring[LoggingPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): LoggingPersistentFSM[S, D, E]
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to Ensuring[LoggingPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): LoggingPersistentFSM[S, D, E]
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to Ensuring[LoggingPersistentFSM[S, D, E]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to StringFormat[LoggingPersistentFSM[S, D, E]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getLog: IndexedSeq[LogEntry[S, D]]
Retrieve current rolling log in oldest-first order.
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
- protected
-
def
gossip(msg: Any)(implicit sender: ActorRef): Unit
- Attributes
- protected
- Definition Classes
- Listeners
-
final
def
goto(nextStateName: S): (LoggingPersistentFSM.this)#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
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
-
def
listenerManagement: actor.Actor.Receive
- Attributes
- protected
- Definition Classes
- Listeners
-
val
listeners: Set[ActorRef]
- Attributes
- protected
- Definition Classes
- Listeners
-
def
log: LoggingAdapter
- Definition Classes
- ActorLogging
- def logDepth: Int
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
nextStateData: D
Return next state data (available in onTransition handlers)
Return next state data (available in onTransition handlers)
- Definition Classes
- PersistentFSMBase
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
onTermination(terminationHandler: PartialFunction[(LoggingPersistentFSM.this)#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
-
final
def
onTransition(transitionHandler: (LoggingPersistentFSM.this)#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
-
def
postRestart(reason: Throwable): Unit
- Definition Classes
- Actor
- Annotations
- @throws( classOf[java.lang.Exception] )
-
def
postStop(): Unit
Call
onTermination
hook; if you want to retain this behavior when overriding make sure to callsuper.postStop()
.Call
onTermination
hook; if you want to retain this behavior when overriding make sure to callsuper.postStop()
.Please note that this method is called by default from
preRestart()
, so override that one ifonTermination
shall not be called during restart.- Definition Classes
- PersistentFSMBase → Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preRestart(reason: Throwable, message: Option[Any]): Unit
- Definition Classes
- Actor
- Annotations
- @throws( classOf[java.lang.Exception] )
-
def
preStart(): Unit
- Definition Classes
- Actor
- Annotations
- @throws( classOf[java.lang.Exception] )
-
def
receive: (LoggingPersistentFSM.this)#Receive
- Definition Classes
- PersistentFSMBase → Actor
-
implicit final
val
self: ActorRef
- Definition Classes
- Actor
-
final
def
sender(): ActorRef
- Definition Classes
- Actor
-
final
def
setStateTimeout(state: S, timeout: (LoggingPersistentFSM.this)#Timeout): Unit
Set state timeout explicitly.
Set state timeout explicitly. This method can safely be used from within a state handler.
- Definition Classes
- PersistentFSMBase
-
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
-
final
def
startWith(stateName: S, stateData: D, timeout: (LoggingPersistentFSM.this)#Timeout = None): Unit
Set initial state.
Set initial state. Call this method from the constructor before the #initialize method. If different state is needed after a restart this method, followed by #initialize, can be used in the actor life cycle hooks akka.actor.Actor#preStart and akka.actor.Actor#postRestart.
- stateName
initial state designator
- stateData
initial state data
- timeout
state timeout for the initial state, overriding the default timeout for that state
- Definition Classes
- PersistentFSMBase
-
final
def
stateData: D
Return current state data (i.e.
Return current state data (i.e. object of type D)
- Definition Classes
- PersistentFSMBase
-
final
def
stateName: S
Return current state name (i.e.
Return current state name (i.e. object of type S)
- Definition Classes
- PersistentFSMBase
-
final
def
stay(): (LoggingPersistentFSM.this)#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
foronTransition
to handle usegoto
instead.- returns
descriptor for staying in current state
- Definition Classes
- PersistentFSMBase
-
final
def
stop(reason: Reason, stateData: D): (LoggingPersistentFSM.this)#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
-
final
def
stop(reason: Reason): (LoggingPersistentFSM.this)#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
-
final
def
stop(): (LoggingPersistentFSM.this)#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
-
def
supervisorStrategy: SupervisorStrategy
- Definition Classes
- Actor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit final
def
total2pf(transitionHandler: (S, S) ⇒ Unit): (LoggingPersistentFSM.this)#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
-
final
def
transform(func: (LoggingPersistentFSM.this)#StateFunction): (LoggingPersistentFSM.this)#TransformHelper
- Definition Classes
- PersistentFSMBase
-
def
unhandled(message: Any): Unit
- Definition Classes
- Actor
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
when(stateName: S, stateTimeout: FiniteDuration = null)(stateFunction: (LoggingPersistentFSM.this)#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
-
final
def
whenUnhandled(stateFunction: (LoggingPersistentFSM.this)#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
-
def
→[B](y: B): (LoggingPersistentFSM[S, D, E], B)
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to ArrowAssoc[LoggingPersistentFSM[S, D, E]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
Shadowed Implicit Value Members
-
def
->[B](y: B): (LoggingPersistentFSM[S, D, E], B)
- Implicit
- This member is added by an implicit conversion from LoggingPersistentFSM[S, D, E] to ArrowAssoc[LoggingPersistentFSM[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:(loggingPersistentFSM: ArrowAssoc[LoggingPersistentFSM[S, D, E]]).->(y)
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()