TBD

TBD

TBD

Returns true if this persistent entity is currently recovering.

Returns true if this persistent entity has successfully finished recovery.

TBD

TBD

TBD

Highest received sequence number so far or `0L` if this actor hasn't replayed or stored any persistent events yet.

TBD

TBD

Return next state data (available in OnTransition(PersistentFSMBaseTState, TData, TEventTransitionHandler) handlers)

Id of the persistent entity for which messages should be replayed.

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.

Gets the self ActorRef

Gets the sending ActorRef of the current message

TBD

Returns LastSequenceNr

TBD

Returns PersistenceId.

TBD

Current state data

Current state name

TBD

Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default.

Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default..

Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default.

Can be overridden to intercept calls to `PreStart`. Calls `PreStart` by default.

TBD

Changes the actor's command behavior and replaces the current receive handler with the specified handler.

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

Cancel a named Timer, ensuring that the message is not subsequently delivered (no race.)

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.

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.

Deletes the snapshot identified by sequenceNr. The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotSuccess or DeleteSnapshotFailure message.

Deletes all snapshots matching criteria. The PersistentActor will be notified about the status of the deletion via an DeleteSnapshotsSuccess or DeleteSnapshotsFailure message.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Serves as the default hash function.

Gets the Type of the current instance.

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.

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.

Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.

By default, Failure is logged at error level and other reason types are not logged. It is possible to override this behavior.

Creates a shallow copy of the current Object.

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.

Called when the journal rejected PersistTEvent(TEvent, ActionTEvent) of an event. The event was not stored. By default this method logs the problem as a warning, and the actor continues. The callback handler that was passed to the PersistTEvent(TEvent, ActionTEvent) method will not be invoked.

Called whenever a message replay fails. By default it log the errors.

Called whenever a message replay succeeds.

Set the 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 each state transition, i.e. not when staying in the same state.

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.

Asynchronously persists series of events in specified order. This is equivalent of multiple calls of PersistTEvent(TEvent, ActionTEvent) calls with the same handler, except that events are persisted atomically with this method.

Asynchronously persists series of events in specified order. This is equivalent of multiple calls of PersistAsyncTEvent(TEvent, ActionTEvent) calls with the same handler, except that events are persisted atomically with this method.

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.

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.

Call the OnTermination(ActionFSMBaseStopEventTState, TData) hook if you want to retain this behavior. When overriding make sure to call base.PostStop(); Please note that this method is called by default from PreRestart(Exception, Object) so override that one if OnTermination(ActionFSMBaseStopEventTState, TData) shall not be called during restart.

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.

User overridable callback.

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

TBD

Processor for user defined messages.

TBD

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.

Saves snapshot of current ISnapshotter state. The PersistentActor will be notified about the success or failure of this via an SaveSnapshotSuccess or SaveSnapshotFailure message.

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

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.

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

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

Produce change descriptor to stop this FSM actor with FSMBaseReasonFSMBaseNormal

Produce change descriptor to stop this FSM actor with the specified FSMBaseReason.

TBD

TBD

TBD

Returns a string that represents the current object.

TBD

Reverts the Actor behavior to the previous one on the behavior stack.

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

Insert a new PersistentFSMBaseTState, TData, TEventStateFunction 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 FSMBaseStateTimeout.

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

FSM state data and current timeout handling

TBD

TBD

TBD

Timer handling

Can be set to enable debugging on certain actions taken by the FSM

TBD

Matches the specified target.

Matches the specified target and return a result of target processing.