UntypedPersistentActor Class |
Namespace: Akka.Persistence
The UntypedPersistentActor type exposes the following members.
Name | Description | |
---|---|---|
UntypedPersistentActor | Initializes a new instance of the UntypedPersistentActor class |
Name | Description | |
---|---|---|
Context |
TBD
| |
Extension |
TBD
(Inherited from Eventsourced.) | |
InternalStashOverflowStrategy |
TBD
(Inherited from Eventsourced.) | |
IsRecovering |
Returns true if this persistent entity is currently recovering.
(Inherited from Eventsourced.) | |
IsRecoveryFinished |
Returns true if this persistent entity has successfully finished recovery.
(Inherited from Eventsourced.) | |
Journal |
TBD
(Inherited from Eventsourced.) | |
JournalPluginId |
TBD
(Inherited from Eventsourced.) | |
LastSequenceNr |
Highest received sequence number so far or `0L` if this actor
hasn't replayed or stored any persistent events yet.
(Inherited from Eventsourced.) | |
Log |
TBD
(Inherited from Eventsourced.) | |
PersistenceId |
Id of the persistent entity for which messages should be replayed.
(Inherited from Eventsourced.) | |
Recovery |
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.) | |
Self |
Gets the self ActorRef
(Inherited from ActorBase.) | |
Sender |
Gets the sending ActorRef of the current message
(Inherited from ActorBase.) | |
SnapshotPluginId |
TBD
(Inherited from Eventsourced.) | |
SnapshotSequenceNr |
Returns LastSequenceNr (Inherited from Eventsourced.) | |
SnapshotStore |
TBD
(Inherited from Eventsourced.) | |
SnapshotterId |
Returns PersistenceId.
(Inherited from Eventsourced.) | |
Stash |
TBD
(Inherited from Eventsourced.) |
Name | Description | |
---|---|---|
AroundPostRestart |
Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default.
(Inherited from Eventsourced.) | |
AroundPostStop |
Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default..
(Inherited from Eventsourced.) | |
AroundPreRestart |
Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default.
(Inherited from Eventsourced.) | |
AroundPreStart |
Can be overridden to intercept calls to `PreStart`. Calls `PreStart` by default.
(Inherited from Eventsourced.) | |
AroundReceive |
TBD
(Inherited from Eventsourced.) | |
Become(Receive) |
Changes the actor's command behavior and replaces the current receive handler with the specified handler.
(Inherited from ActorBase.) | |
Become(UntypedReceive) |
Changes the actor's behavior and replaces the current receive handler with the specified handler.
| |
BecomeStacked(Receive) |
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 (Inherited from ActorBase.)Remarks Please note, that in order to not leak memory, make sure every call to BecomeStacked(Receive)
is matched with a call to UnbecomeStacked. | |
BecomeStacked(UntypedReceive) |
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(UntypedReceive)
is matched with a call to UnbecomeStacked. | |
DeferAsyncTEvent |
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.) | |
DeleteMessages |
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.) | |
DeleteSnapshot |
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.) | |
DeleteSnapshots |
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.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
LoadSnapshot |
Instructs the snapshot store to load the specified snapshot and send it via an
SnapshotOffer to the running PersistentActor.
(Inherited from Eventsourced.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnCommand |
TBD
| |
OnPersistFailure |
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.) | |
OnPersistRejected |
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.
(Inherited from Eventsourced.) | |
OnRecover |
TBD
| |
OnRecoveryFailure |
Called whenever a message replay fails. By default it log the errors.
(Inherited from Eventsourced.) | |
OnReplaySuccess |
Called whenever a message replay succeeds.
(Inherited from Eventsourced.) | |
PersistTEvent |
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.) | |
PersistAllTEvent |
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.
(Inherited from Eventsourced.) | |
PersistAllAsyncTEvent |
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.
(Inherited from Eventsourced.) | |
PersistAsyncTEvent |
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.) | |
PostRestart |
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.) | |
PostStop |
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked.
Empty default implementation.
(Inherited from ActorBase.) | |
PreRestart |
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.) | |
PreStart |
User overridable callback.
Is called when an Actor is started.
Actors are automatically started asynchronously when created.
Empty default implementation.
(Inherited from ActorBase.) | |
Receive |
Processor for user defined messages.
(Overrides ActorBaseReceive(Object).) | |
ReceiveCommand |
Command handler. Typically validates commands against current state - possibly by communicating with other actors.
On successful validation, one or more events are derived from command and persisted.
(Overrides EventsourcedReceiveCommand(Object).) | |
ReceiveRecover |
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.
(Overrides EventsourcedReceiveRecover(Object).) | |
SaveSnapshot |
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.) | |
SetReceiveTimeout | 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. | |
SupervisorStrategy |
TBD
(Inherited from ActorBase.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
UnbecomeStacked |
Reverts the Actor behavior to the previous one on the behavior stack.
(Inherited from ActorBase.) | |
Unhandled |
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.) |
Name | Description | |
---|---|---|
AsInstanceOfT |
TBD
(Defined by Extensions.) | |
Match | Overloaded.
Matches the specified target.
(Defined by PatternMatch.) | |
MatchT | Overloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.) |