public abstract class AbstractFSM<S,D> extends java.lang.Object implements FSM<S,D>
Finite State Machine actor abstract base class.
This is an EXPERIMENTAL feature and is subject to change until it has received more real world testing.
FSM.$minus$greater$, FSM.CurrentState<S>, FSM.CurrentState$, FSM.Event<D>, FSM.Event$, FSM.Failure, FSM.Failure$, FSM.LogEntry<S,D>, FSM.LogEntry$, FSM.Normal$, FSM.NullFunction$, FSM.Reason, FSM.Shutdown$, FSM.State<S,D>, FSM.State$, FSM.StateTimeout$, FSM.StopEvent<S,D>, FSM.StopEvent$, FSM.SubscribeTransitionCallBack, FSM.SubscribeTransitionCallBack$, FSM.Timer$, FSM.TransformHelper, FSM.Transition<S>, FSM.Transition$, FSM.UnsubscribeTransitionCallBack, FSM.UnsubscribeTransitionCallBack$
Actor.emptyBehavior$
Constructor and Description |
---|
AbstractFSM() |
Modifier and Type | Method and Description |
---|---|
FSM.State<S,D> |
goTo(S nextStateName)
Produce transition to other state.
|
FSMStateFunctionBuilder<S,D> |
matchAnyEvent(FI.Apply2<java.lang.Object,D,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
<DT extends D> |
matchData(java.lang.Class<DT> dataType,
FI.TypedPredicate<DT> predicate,
FI.UnitApply<DT> apply)
Create a
UnitPFBuilder with the first case statement set. |
<DT extends D> |
matchData(java.lang.Class<DT> dataType,
FI.UnitApply<DT> apply)
Create a
UnitPFBuilder with the first case statement set. |
<ET,DT extends D> |
matchEvent(java.lang.Class<ET> eventType,
java.lang.Class<DT> dataType,
FI.Apply2<ET,DT,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
<ET,DT extends D> |
matchEvent(java.lang.Class<ET> eventType,
java.lang.Class<DT> dataType,
FI.TypedPredicate2<ET,DT> predicate,
FI.Apply2<ET,DT,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
<ET> FSMStateFunctionBuilder<S,D> |
matchEvent(java.lang.Class<ET> eventType,
FI.Apply2<ET,D,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
<ET> FSMStateFunctionBuilder<S,D> |
matchEvent(java.lang.Class<ET> eventType,
FI.TypedPredicate2<ET,D> predicate,
FI.Apply2<ET,D,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
FSMStateFunctionBuilder<S,D> |
matchEvent(FI.TypedPredicate2<java.lang.Object,D> predicate,
FI.Apply2<java.lang.Object,D,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
<DT extends D> |
matchEvent(java.util.List<java.lang.Object> eventMatches,
java.lang.Class<DT> dataType,
FI.Apply2<java.lang.Object,DT,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
FSMStateFunctionBuilder<S,D> |
matchEvent(java.util.List<java.lang.Object> eventMatches,
FI.Apply2<java.lang.Object,D,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
<E,DT extends D> |
matchEventEquals(E event,
java.lang.Class<DT> dataType,
FI.Apply2<E,DT,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
<E> FSMStateFunctionBuilder<S,D> |
matchEventEquals(E event,
FI.Apply2<E,D,FSM.State<S,D>> apply)
Create an
FSMStateFunctionBuilder with the first case statement set. |
FSMTransitionHandlerBuilder<S> |
matchState(S fromState,
S toState,
FI.UnitApply2<S,S> apply)
Create an
FSMTransitionHandlerBuilder with the first case statement set. |
FSMTransitionHandlerBuilder<S> |
matchState(S fromState,
S toState,
FI.UnitApplyVoid apply)
Create an
FSMTransitionHandlerBuilder with the first case statement set. |
<RT extends FSM.Reason> |
matchStop(java.lang.Class<RT> reasonType,
FI.TypedPredicate<RT> predicate,
FI.UnitApply3<RT,S,D> apply)
Create an
FSMStopBuilder with the first case statement set. |
<RT extends FSM.Reason> |
matchStop(java.lang.Class<RT> reasonType,
FI.UnitApply3<RT,S,D> apply)
Create an
FSMStopBuilder with the first case statement set. |
FSMStopBuilder<S,D> |
matchStop(FSM.Reason reason,
FI.UnitApply2<S,D> apply)
Create an
FSMStopBuilder with the first case statement set. |
FSM.Reason |
Normal()
Default reason if calling
stop() . |
static <S,D> scala.PartialFunction<S,D> |
NullFunction()
A partial function value which does not match anything and can be used to
“reset”
whenUnhandled and onTermination handlers. |
void |
onTermination(FSMStopBuilder<S,D> stopBuilder)
Set handler which is called upon termination of this FSM actor.
|
void |
onTransition(FI.UnitApply2<S,S> transitionHandler)
Add a handler which is called upon each state transition, i.e.
|
void |
onTransition(FSMTransitionHandlerBuilder<S> transitionHandlerBuilder)
Add a handler which is called upon each state transition, i.e.
|
void |
setTimer(java.lang.String name,
java.lang.Object msg,
scala.concurrent.duration.FiniteDuration timeout)
Schedule named timer to deliver message after given delay, possibly repeating.
|
FSM.Reason |
Shutdown()
Reason given when someone was calling
system.stop(fsm) from outside;
also applies to Stop supervision directive. |
void |
startWith(S stateName,
D stateData)
Set initial state.
|
void |
startWith(S stateName,
D stateData,
scala.concurrent.duration.FiniteDuration timeout)
Set initial state.
|
void |
when(S stateName,
scala.concurrent.duration.FiniteDuration stateTimeout,
FSMStateFunctionBuilder<S,D> stateFunctionBuilder)
Insert a new StateFunction at the end of the processing chain for the
given state.
|
void |
when(S stateName,
FSMStateFunctionBuilder<S,D> stateFunctionBuilder)
Insert a new StateFunction at the end of the processing chain for the
given state.
|
void |
when(S stateName,
scala.PartialFunction<FSM.Event<D>,FSM.State<S,D>> stateFunction)
Insert a new StateFunction at the end of the processing chain for the
given state.
|
void |
whenUnhandled(FSMStateFunctionBuilder<S,D> stateFunctionBuilder)
Set handler which is called upon reception of unhandled messages.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyState, cancelTimer, currentState, debugEvent, Event, generation, handleEvent, handleEventDefault, handleTransition, initialize, isStateTimerActive, isTimerActive, logTermination, makeTransition, nextState, nextStateData, onTermination, onTransition, postStop, processEvent, processMsg, receive, register, setStateTimeout, setTimer, startWith, stateData, stateFunctions, stateName, StateTimeout, stateTimeouts, stay, stop, stop, stop, StopEvent, terminate, terminateEvent, timeoutFuture, timerGen, timers, total2pf, transform, transitionEvent, when, whenUnhandled
aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, noSender, postRestart, preRestart, preStart, self, sender, supervisorStrategy, unhandled
gossip, listenerManagement, listeners
_log, log
public static <S,D> scala.PartialFunction<S,D> NullFunction()
whenUnhandled
and onTermination
handlers.
onTermination(FSM.NullFunction())
public final void when(S stateName, scala.PartialFunction<FSM.Event<D>,FSM.State<S,D>> stateFunction)
stateName
- designator for the statestateFunction
- partial function describing response to inputpublic final void when(S stateName, FSMStateFunctionBuilder<S,D> stateFunctionBuilder)
stateName
- designator for the statestateFunctionBuilder
- partial function builder describing response to inputpublic final void when(S stateName, scala.concurrent.duration.FiniteDuration stateTimeout, FSMStateFunctionBuilder<S,D> stateFunctionBuilder)
stateName
- designator for the statestateTimeout
- default state timeout for this statestateFunctionBuilder
- partial function builder describing response to inputpublic final void startWith(S stateName, D stateData)
FSM.initialize()
method.
If different state is needed after a restart this method, followed by FSM.initialize()
, can
be used in the actor life cycle hooks Actor.preStart()
and Actor.postRestart(java.lang.Throwable)
.
stateName
- initial state designatorstateData
- initial state datapublic final void startWith(S stateName, D stateData, scala.concurrent.duration.FiniteDuration timeout)
FSM.initialize()
method.
If different state is needed after a restart this method, followed by FSM.initialize()
, can
be used in the actor life cycle hooks Actor.preStart()
and Actor.postRestart(java.lang.Throwable)
.
stateName
- initial state designatorstateData
- initial state datatimeout
- state timeout for the initial state, overriding the default timeout for that statepublic final void onTransition(FSMTransitionHandlerBuilder<S> transitionHandlerBuilder)
Multiple handlers may be installed, and every one of them will be called, not only the first one matching.
public final void onTransition(FI.UnitApply2<S,S> transitionHandler)
Multiple handlers may be installed, and every one of them will be called, not only the first one matching.
public final void whenUnhandled(FSMStateFunctionBuilder<S,D> stateFunctionBuilder)
The current state may be queried using stateName
.
public final void onTermination(FSMStopBuilder<S,D> stopBuilder)
public final <ET,DT extends D> FSMStateFunctionBuilder<S,D> matchEvent(java.lang.Class<ET> eventType, java.lang.Class<DT> dataType, FI.TypedPredicate2<ET,DT> predicate, FI.Apply2<ET,DT,FSM.State<S,D>> apply)
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 ondataType
- the data type to match onpredicate
- a predicate to evaluate on the matched typesapply
- an action to apply to the event and state data if there is a matchpublic final <ET,DT extends D> FSMStateFunctionBuilder<S,D> matchEvent(java.lang.Class<ET> eventType, java.lang.Class<DT> dataType, FI.Apply2<ET,DT,FSM.State<S,D>> apply)
FSMStateFunctionBuilder
with the first case statement set.
A case statement that matches on an event and data type.
eventType
- the event type to match ondataType
- the data type to match onapply
- an action to apply to the event and state data if there is a matchpublic final <ET> FSMStateFunctionBuilder<S,D> matchEvent(java.lang.Class<ET> eventType, FI.TypedPredicate2<ET,D> predicate, FI.Apply2<ET,D,FSM.State<S,D>> apply)
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 onpredicate
- a predicate that will be evaluated on the data and the eventapply
- an action to apply to the event and state data if there is a matchpublic final <ET> FSMStateFunctionBuilder<S,D> matchEvent(java.lang.Class<ET> eventType, FI.Apply2<ET,D,FSM.State<S,D>> apply)
FSMStateFunctionBuilder
with the first case statement set.
A case statement that matches if the event type matches.
eventType
- the event type to match onapply
- an action to apply to the event and state data if there is a matchpublic final FSMStateFunctionBuilder<S,D> matchEvent(FI.TypedPredicate2<java.lang.Object,D> predicate, FI.Apply2<java.lang.Object,D,FSM.State<S,D>> apply)
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 eventapply
- an action to apply to the event and state data if there is a matchpublic final <DT extends D> FSMStateFunctionBuilder<S,D> matchEvent(java.util.List<java.lang.Object> eventMatches, java.lang.Class<DT> dataType, FI.Apply2<java.lang.Object,DT,FSM.State<S,D>> apply)
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 againstdataType
- the data type to match onapply
- an action to apply to the event and state data if there is a matchpublic final FSMStateFunctionBuilder<S,D> matchEvent(java.util.List<java.lang.Object> eventMatches, FI.Apply2<java.lang.Object,D,FSM.State<S,D>> apply)
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 againstapply
- an action to apply to the event and state data if there is a matchpublic final <E,DT extends D> FSMStateFunctionBuilder<S,D> matchEventEquals(E event, java.lang.Class<DT> dataType, FI.Apply2<E,DT,FSM.State<S,D>> apply)
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 againstdataType
- the data type to match onapply
- an action to apply to the event and state data if there is a matchpublic final <E> FSMStateFunctionBuilder<S,D> matchEventEquals(E event, FI.Apply2<E,D,FSM.State<S,D>> apply)
FSMStateFunctionBuilder
with the first case statement set.
A case statement that matches if the event compares equal.
event
- an event to compare equal againstapply
- an action to apply to the event and state data if there is a matchpublic final FSMStateFunctionBuilder<S,D> matchAnyEvent(FI.Apply2<java.lang.Object,D,FSM.State<S,D>> apply)
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 matchpublic final FSMTransitionHandlerBuilder<S> matchState(S fromState, S toState, FI.UnitApplyVoid apply)
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 ontoState
- the to state to match onapply
- an action to apply when the states matchpublic final FSMTransitionHandlerBuilder<S> matchState(S fromState, S toState, FI.UnitApply2<S,S> apply)
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 ontoState
- the to state to match onapply
- an action to apply when the states matchpublic final FSMStopBuilder<S,D> matchStop(FSM.Reason reason, FI.UnitApply2<S,D> apply)
FSMStopBuilder
with the first case statement set.
A case statement that matches on an FSM.Reason
.
reason
- the reason for the terminationapply
- an action to apply to the event and state data if there is a matchpublic final <RT extends FSM.Reason> FSMStopBuilder<S,D> matchStop(java.lang.Class<RT> reasonType, FI.UnitApply3<RT,S,D> apply)
FSMStopBuilder
with the first case statement set.
A case statement that matches on a reason type.
reasonType
- the reason type to match onapply
- an action to apply to the reason, event and state data if there is a matchpublic final <RT extends FSM.Reason> FSMStopBuilder<S,D> matchStop(java.lang.Class<RT> reasonType, FI.TypedPredicate<RT> predicate, FI.UnitApply3<RT,S,D> apply)
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 onapply
- an action to apply to the reason, event and state data if there is a matchpredicate
- a predicate that will be evaluated on the reason if the type matchespublic final <DT extends D> UnitPFBuilder<D> matchData(java.lang.Class<DT> dataType, FI.UnitApply<DT> apply)
UnitPFBuilder
with the first case statement set.
dataType
- a type to match the argument againstapply
- an action to apply to the argument if the type matchespublic final <DT extends D> UnitPFBuilder<D> matchData(java.lang.Class<DT> dataType, FI.TypedPredicate<DT> predicate, FI.UnitApply<DT> apply)
UnitPFBuilder
with the first case statement set.
dataType
- a type to match the argument againstpredicate
- a predicate that will be evaluated on the argument if the type matchesapply
- an action to apply to the argument if the type and predicate matchespublic final FSM.State<S,D> goTo(S nextStateName)
nextStateName
- state designator for the next statepublic final void setTimer(java.lang.String name, java.lang.Object msg, scala.concurrent.duration.FiniteDuration timeout)
name
- identifier to be used with cancelTimer()msg
- message to be deliveredtimeout
- delay of first message delivery and between subsequent messagespublic FSM.Reason Normal()
stop()
.public FSM.Reason Shutdown()
system.stop(fsm)
from outside;
also applies to Stop
supervision directive.