Click or drag to resize
Akka.NETPersistentFSMBaseTState, TData, TEvent Class
TBD
Inheritance Hierarchy

Namespace:  Akka.Persistence.Fsm
Assembly:  Akka.Persistence (in Akka.Persistence.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax
public abstract class PersistentFSMBase<TState, TData, TEvent> : PersistentActor, 
	IListeners

Type Parameters

TState
TBD
TData
TBD
TEvent
TBD

The PersistentFSMBaseTState, TData, TEvent type exposes the following members.

Constructors
Properties
  NameDescription
Protected propertyExtension
TBD
(Inherited from Eventsourced.)
Public propertyInternalStashOverflowStrategy
TBD
(Inherited from Eventsourced.)
Public propertyIsRecovering
Returns true if this persistent entity is currently recovering.
(Inherited from Eventsourced.)
Public propertyIsRecoveryFinished
Returns true if this persistent entity has successfully finished recovery.
(Inherited from Eventsourced.)
Public propertyIsStateTimerActive
TBD
Public propertyJournal
TBD
(Inherited from Eventsourced.)
Public propertyJournalPluginId
TBD
(Inherited from Eventsourced.)
Public propertyLastSequenceNr
Highest received sequence number so far or `0L` if this actor hasn't replayed or stored any persistent events yet.
(Inherited from Eventsourced.)
Public propertyListeners
TBD
Protected propertyLog
TBD
(Inherited from Eventsourced.)
Public propertyNextStateData
Public propertyPersistenceId
Id of the persistent entity for which messages should be replayed.
(Inherited from Eventsourced.)
Public propertyRecovery
Called when the persistent actor is started for the first time. The returned Recovery object defines how the actor will recover its persistent state before handling the first incoming message. To skip recovery completely return None.
(Inherited from Eventsourced.)
Protected propertySelf
Gets the self ActorRef
(Inherited from ActorBase.)
Protected propertySender
Gets the sending ActorRef of the current message
(Inherited from ActorBase.)
Public propertySnapshotPluginId
TBD
(Inherited from Eventsourced.)
Public propertySnapshotSequenceNr (Inherited from Eventsourced.)
Public propertySnapshotStore
TBD
(Inherited from Eventsourced.)
Public propertySnapshotterId
Returns PersistenceId.
(Inherited from Eventsourced.)
Public propertyStash
TBD
(Inherited from Eventsourced.)
Public propertyStateData
Current state data
Public propertyStateName
Current state name
Top
Methods
  NameDescription
Protected methodApplyState
TBD
Public methodAroundPostRestart
Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default.
(Inherited from Eventsourced.)
Public methodAroundPostStop
Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default..
(Inherited from Eventsourced.)
Public methodAroundPreRestart
Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default.
(Inherited from Eventsourced.)
Public methodAroundPreStart
Can be overridden to intercept calls to `PreStart`. Calls `PreStart` by default.
(Inherited from Eventsourced.)
Protected methodAroundReceive
TBD
(Inherited from Eventsourced.)
Protected methodBecome
Changes the actor's command behavior and replaces the current receive handler with the specified handler.
(Inherited from ActorBase.)
Protected methodBecomeStacked
Changes the actor's behavior and replaces the current receive handler with the specified handler. The current handler is stored on a stack, and you can revert to it by calling UnbecomeStacked
Remarks
Please note, that in order to not leak memory, make sure every call to BecomeStacked(Receive) is matched with a call to UnbecomeStacked.
(Inherited from ActorBase.)
Public methodCancelTimer
Cancel a named Timer, ensuring that the message is not subsequently delivered (no race.)
Public methodDeferAsyncTEvent
Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to PersistAsyncTEvent(TEvent, ActionTEvent) calls. That is, if PersistAsyncTEvent(TEvent, ActionTEvent) was invoked before DeferAsyncTEvent(TEvent, ActionTEvent), the corresponding handlers will be invoked in the same order as they were registered in. This call will NOT result in evt being persisted, use PersistTEvent(TEvent, ActionTEvent) or PersistAsyncTEvent(TEvent, ActionTEvent) instead if the given evt should be possible to replay. If there are no pending persist handler calls, the handler will be called immediately. If persistence of an earlier event fails, the persistent actor will stop, and the handler will not be run.
(Inherited from Eventsourced.)
Public methodDeleteMessages
Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr. If the delete is successful a DeleteMessagesSuccess will be sent to the actor. If the delete fails a DeleteMessagesFailure will be sent to the actor.
(Inherited from Eventsourced.)
Public methodDeleteSnapshot
Deletes the snapshot identified by sequenceNr. The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.
(Inherited from Eventsourced.)
Public methodDeleteSnapshots
Deletes all snapshots matching criteria. The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.
(Inherited from Eventsourced.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGoTo(TState)
Produce transition to other state. Return this from a state function in order to effect the transition.
Public methodGoTo(TState, TData)
Produce transition to other state. Return this from a state function in order to effect the transition.
Protected methodInitialize Obsolete.

Verify the existence of initial state and setup timers. Used in PersistentFSMTState, TData, TEvent on recovery.

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

ReceiveRecover(Object)

Public methodIsTimerActive
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.
Public methodLoadSnapshot
Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.
(Inherited from Eventsourced.)
Protected methodLogTermination
By default, Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnPersistFailure
Called when persist fails. By default it logs the error. Subclass may override to customize logging and for example send negative acknowledgment to sender. The actor is always stopped after this method has been invoked. Note that the event may or may not have been saved, depending on the type of failure.
(Inherited from Eventsourced.)
Protected methodOnPersistRejected (Inherited from Eventsourced.)
Protected methodOnRecoveryFailure
Called whenever a message replay fails. By default it log the errors.
(Inherited from Eventsourced.)
Protected methodOnReplaySuccess
Called whenever a message replay succeeds.
(Inherited from Eventsourced.)
Public methodOnTermination
Set the handler which is called upon termination of this FSM actor. Calling this method again will overwrite the previous contents.
Public methodOnTransition
Set handler which is called upon each state transition, i.e. not when staying in the same state.
Public methodPersistTEvent
Asynchronously persists an event. On successful persistence, the handler is called with the persisted event. This method guarantees that no new commands will be received by a persistent actor between a call to PersistTEvent(TEvent, ActionTEvent) and execution of it's handler. It also holds multiple persist calls per received command. Internally this is done by stashing. The stash used for that is an internal stash which doesn't interfere with the inherited user stash. An event handler may close over eventsourced actor state and modify it. Sender of the persistent event is considered a sender of the corresponding command. That means one can respond to sender from within an event handler. Within an event handler, applications usually update persistent actor state using persisted event data, notify listeners and reply to command senders. If persistence of an event fails, OnPersistFailure(Exception, Object, Int64) will be invoked and the actor will unconditionally be stopped. The reason that it cannot resume when persist fails is that it is unknown if the event was actually persisted or not, and therefore it is in an inconsistent state. Restarting on persistent failures will most likely fail anyway, since the journal is probably unavailable. It is better to stop the actor and after a back-off timeout start it again.
(Inherited from Eventsourced.)
Public methodPersistAllTEvent (Inherited from Eventsourced.)
Public methodPersistAllAsyncTEvent (Inherited from Eventsourced.)
Public methodPersistAsyncTEvent
Asynchronously persists an event. On successful persistence, the handler is called with the persisted event. Unlike PersistTEvent(TEvent, ActionTEvent) method, this one will continue to receive incoming commands between calls and executing it's event handler. This version should be used in favor of PersistTEvent(TEvent, ActionTEvent) method when throughput is more important that commands execution precedence. An event handler may close over eventsourced actor state and modify it. Sender of the persistent event is considered a sender of the corresponding command. That means, one can respond to sender from within an event handler. Within an event handler, applications usually update persistent actor state using persisted event data, notify listeners and reply to command senders. If persistence of an event fails, OnPersistFailure(Exception, Object, Int64) will be invoked and the actor will unconditionally be stopped. The reason that it cannot resume when persist fails is that it is unknown if the event was actually persisted or not, and therefore it is in an inconsistent state. Restarting on persistent failures will most likely fail anyway, since the journal is probably unavailable. It is better to stop the actor and after a back-off timeout start it again.
(Inherited from Eventsourced.)
Protected methodPostRestart
User overridable callback: By default it calls `PreStart()`.

Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

(Inherited from ActorBase.)
Protected methodPostStop (Overrides ActorBasePostStop.)
Protected methodPreRestart
User overridable callback: '''By default it disposes of all children and then calls `postStop()`.'''

Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

(Inherited from ActorBase.)
Protected methodPreStart
User overridable callback.

Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

(Inherited from ActorBase.)
Protected methodProcessMsg
TBD
Protected methodReceive
Processor for user defined messages.
(Inherited from PersistentActor.)
Protected methodReceiveCommand
TBD
(Overrides EventsourcedReceiveCommand(Object).)
Protected methodReceiveRecover
Recovery handler that receives persistent events during recovery. If a state snapshot has been captured and saved, this handler will receive a SnapshotOffer message followed by events that are younger than offer itself. This handler must not have side-effects other than changing persistent actor state i.e. it should not perform actions that may fail, such as interacting with external services, for example. If there is a problem with recovering the state of the actor from the journal, the error will be logged and the actor will be stopped.
(Inherited from Eventsourced.)
Public methodSaveSnapshot
Saves snapshot of current ISnapshotter state. The PersistentActor will be notified about the success or failure of this via an SaveSnapshotSuccess or SaveSnapshotFailure message.
(Inherited from Eventsourced.)
Protected methodSetReceiveTimeout

Defines the inactivity timeout after which the sending of a ReceiveTimeout message is triggered. When specified, the receive function should be able to handle a ReceiveTimeout message.

Please note that the receive timeout might fire and enqueue the ReceiveTimeout message right after another message was enqueued; hence it is not guaranteed that upon reception of the receive timeout there must have been an idle period beforehand as configured via this method.

Once set, the receive timeout stays in effect (i.e. continues firing repeatedly after inactivity periods). Pass in null to switch off this feature.

(Inherited from ActorBase.)
Public methodSetStateTimeout
Set the state timeout explicitly. This method can be safely used from within a state handler.
Public methodSetTimer
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.
Public methodStartWith
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 PreStart and PostRestart(Exception).
Public methodStay
Produce "empty" transition descriptor. Return this from a state function when no state change is to be effected.
Public methodStop
Public methodStop(FSMBaseReason)
Produce change descriptor to stop this FSM actor with the specified FSMBaseReason.
Public methodStop(FSMBaseReason, TData)
TBD
Protected methodSupervisorStrategy
TBD
(Inherited from ActorBase.)
Protected methodTerminate
TBD
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTransform
TBD
Protected methodUnbecomeStacked
Reverts the Actor behavior to the previous one on the behavior stack.
(Inherited from ActorBase.)
Protected methodUnhandled
Is called when a message isn't handled by the current behavior of the actor by default it fails with either a DeathPactException (in case of an unhandled Terminated message) or publishes an UnhandledMessage to the actor's system's EventStream
(Inherited from Eventsourced.)
Public methodWhen
Public methodWhenUnhandled
Set handler which is called upon reception of unhandled FSM messages. Calling this method again will overwrite the previous contents.
Top
Fields
  NameDescription
Protected field_currentState
FSM state data and current timeout handling
Protected field_generation
TBD
Protected field_listener
TBD
Protected field_timeoutFuture
TBD
Protected field_timers
Timer handling
Protected fieldDebugEvent
Can be set to enable debugging on certain actions taken by the FSM
Top
Extension Methods
See Also