FSM<(Of <(<'TS, TD>)>)> Members

The FSM<(Of <(<'TS, TD>)>)> type exposes the following members.

Methods


  Name Description
Public method AroundPostRestart
Can be overridden to intercept calls to `postRestart`. Calls `postRestart` by default.
(Inherited from ActorBase.)
Public method AroundPostStop
Can be overridden to intercept calls to `postStop`. Calls `postStop` by default..
(Inherited from ActorBase.)
Public method AroundPreRestart
Can be overridden to intercept calls to `preRestart`. Calls `preRestart` by default.
(Inherited from ActorBase.)
Public method AroundPreStart
Can be overridden to intercept calls to `preStart`. Calls `preStart` by default.
(Inherited from ActorBase.)
Protected method Become (Inherited from ActorBase.)
Public method CancelTimer
Cancel a named Timer, ensuring that the message is not subsequently delivered (no race.)
Public method Equals(System.Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method GoTo
Produce transition to other state. Return this from a state function in order to effect the transition.
Public method Initialize
Verify the existence of initial state and setup timers. This should be the last call within the constructor or PreStart()()()() and PostRestart(Exception).
Public method IsTimerActive
Determines whether the named timer is still active. Returns true unless the timer does not exist, has previously been cancelled, or if it was a single-shot timer whose message was already received.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method OnTermination
Set the handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.
Public method OnTransition
Set handler which is called upon each state transition, i.e. not when staying in the same state.
Protected method PostRestart (Inherited from ActorBase.)
Protected method PreRestart (Inherited from ActorBase.)
Protected method PreStart (Inherited from ActorBase.)
Protected method SetReceiveTimeout (Inherited from ActorBase.)
Public method SetStateTimeout
Set the state timeout explicitly. This method can be safely used from within a state handler.
Public method SetTimer
Schedule named timer to delvier message after given delay, possibly repeating. Any existing timer with the same name will automatically be canceled before adding the new timer.
Public method StartWith
Sets the initial state for this FSM. 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 [ActorBase.PreStart()] and PostRestart(Exception).
Public method Stay
Produce "empty" transition descriptor. Return this from a state function when no state change is to be effected.
Public method Stop()()()()
Produce change descriptor to stop this FSM actor with FSMBase..::..ReasonFSMBase..::..Normal
Public method Stop(FSMBase..::..Reason)
Produce change descriptor to stop this FSM actor with the specified FSMBase..::..Reason.
Public method Stop(FSMBase..::..Reason, TD)
Protected method SupervisorStrategy (Inherited from ActorBase.)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method Transform
Protected method Unbecome (Inherited from ActorBase.)
Protected method Unhandled (Inherited from ActorBase.)
Public method When
Insert a new FSM<(Of <(<'TS, TD>)>)>..::..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 FSMBase..::..StateTimeout.
Public method WhenUnhandled
Set handler which i called upon reception of unhandled FSM messages. Calling this method again will overwrite the previous contents.

Properties


  Name Description
Public property Listeners
Public property Log
Public property NextStateData
Return next state data (available in OnTransition(FSM<(Of <(<'TS, TD>)>)>..::..TransitionHandler) handlers)
Protected property Self (Inherited from ActorBase.)
Protected property Sender (Inherited from ActorBase.)
Public property StateData
Current state data
Public property StateName
Current state name