Click or drag to resize
Akka.NETAkka.Persistence Namespace
The Akka.Persistence namespace contains classes used to save/restore an actor's state into a persist data store.
Public classAsyncHandlerInvocation
Public classAtLeastOnceDeliveryActor
Persistent actor type that sends messages with at-least-once delivery semantics to destinations. It takes care of re-sending messages when they haven't been confirmed withing expected timeout. Use the Deliver(ActorPath, FuncInt64, Object, Boolean) method to send a message to a destination. Call the ConfirmDelivery(Int64) method when destination has replied with a confirmation message. At-least-once delivery implies that the original message send order is not always retained and the destination may receive duplicate messages due to possible resends. The interval between redelivery attempts can be defined with RedeliverInterval. After a number of delivery attempts a UnconfirmedWarning message will be sent to Self. The re-sending will continue, but you may choose ConfirmDelivery(Int64) to cancel re-sending. This actor type has a state consisting of unconfirmed messages and a sequence number. It does not store this state itself. You must persist events corresponding to the Deliver(ActorPath, FuncInt64, Object, Boolean) and ConfirmDelivery(Int64) invocations from your PersistentActor so that the state can be restored by calling the same methods during the recovery phase of the PersistentActor. Sometimes these events can be derived from other business level events, and sometimes you must create separate events. During recovery calls to Deliver(ActorPath, FuncInt64, Object, Boolean) will not send out the message, but it will be sent later if no matching ConfirmDelivery(Int64) was performed. Support for snapshot is provided by GetDeliverySnapshot and SetDeliverySnapshot(AtLeastOnceDeliverySnapshot). The AtLeastOnceDeliverySnapshot contains the full delivery state, including unconfirmed messages. If you need a custom snapshot for other parts of the actor state you must also include the AtLeastOnceDeliverySnapshot. It is serialized using protobuf with the ordinary Akka serialization mechanism. It is easiest to include the bytes of the AtLeastOnceDeliverySnapshot as a blob in your custom snapshot.
Public classAtLeastOnceDeliveryReceiveActor
Receive persistent actor type, that sends messages with at-least-once delivery semantics to it's destinations.
Public classAtLeastOnceDeliverySemantic
Public classAtLeastOnceDeliverySemanticDelivery
Public classAtLeastOnceDeliverySemanticRedeliveryTick
Public classAtLeastOnceDeliverySnapshot
Snapshot of current AtLeastOnceDeliveryActor state. Can be retrieved with GetDeliverySnapshot and saved with SaveSnapshot(Object). During recovery the snapshot received in SnapshotOffer should be sent with SetDeliverySnapshot(AtLeastOnceDeliverySnapshot).
Public classAtomicWrite
Public classDeleteMessagesFailure
Reply message to failed DeleteMessages(Int64) request.
Public classDeleteMessagesSuccess
Reply message to a successful DeleteMessages(Int64) request.
Public classDeleteMessagesTo
Request to delete all persistent messages with sequence numbers up to `toSequenceNr` (inclusive).
Public classDeleteSnapshot
Instructs a snapshot store to delete a snapshot.
Public classDeleteSnapshotFailure
Sent to PersistentActor after failed deletion of a snapshot.
Public classDeleteSnapshots
Instructs a snapshot store to delete all snapshots that match provided criteria.
Public classDeleteSnapshotsFailure
Sent to PersistentActor after failed deletion of a range of snapshots.
Public classDeleteSnapshotsSuccess
Sent to PersistentActor after successful deletion of a specified range of snapshots.
Public classDeleteSnapshotSuccess
Sent to PersistentActor after successful deletion of a snapshot.
Public classDiscardConfigurator
Public classDiscardToDeadLetterStrategy
Discard the message to DeadLetterActorRef
Public classEventsourced
Public classFSharp
Public classFSharpAggregateCommand, Event, State
Public classFSharpDelivererCommand, Event, State
Public classFSharpDeliveryAggregateCommand, Event, State
Public classFSharpFunPersistentActorCommand, Event, State
Public classFSharpFunPersistentViewEvent, State
Public classFSharpLinq
Public classFSharpLinqPersistentExpression
Public classFSharpPerspectiveEvent, State
Public classLoadSnapshot
Instructs a snapshot store to load the snapshot.
Public classLoadSnapshotFailed
Reply message to a failed LoadSnapshot request.
Public classLoadSnapshotResult
Response to a LoadSnapshot message.
Public classLoopMessageSuccess
Reply message to a WriteMessages with a non-persistent message.
Public classMaxUnconfirmedMessagesExceededException
This exception is thrown when the MaxUnconfirmedMessages threshold has been exceeded.
Public classPersistence
Persistence extension.
Public classPersistenceExtension
Launches the Akka.Persistence runtime
Public classPersistenceSettings
Persistence configuration.
Public classPersistenceSettingsAtLeastOnceDeliverySettings
Public classPersistenceSettingsInternalSettings
Public classPersistenceSettingsViewSettings
Public classPersistent
Public classPersistentActor
Persistent actor - can be used to implement command or eventsourcing.
Public classPersistentView
Public classReceivePersistentActor
Public classRecovery
Recovery mode configuration object to be return in Recovery By default recovers from latest snapshot replays through to the last available event (last sequenceNr). Recovery will start from a snapshot if the persistent actor has previously saved one or more snapshots and at least one of these snapshots matches the specified FromSnapshot criteria. Otherwise, recovery will start from scratch by replaying all stored events. If recovery starts from a snapshot, the PersistentActor is offered that snapshot with a SnapshotOffer message, followed by replayed messages, if any, that are younger than the snapshot, up to the specified upper sequence number bound (ToSequenceNr).
Public classRecoveryCompleted
Sent to a PersistentActor when the journal replay has been finished.
Public classRecoverySuccess
Reply message to a successful ReplayMessages request. This reply is sent to the requester after all ReplayedMessage have been sent (if any). It includes the highest stored sequence number of a given persistent actor. Note that the replay might have been limited to a lower sequence number.
Public classRecoveryTick
Message used to detect that recovery timed out.
Public classRecoveryTimedOutException
Public classReplayedMessage
Reply message to a ReplayMessages request. A separate reply is sent to the requester for each replayed message.
Public classReplayMessages
Request to replay messages to the PersistentActor.
Public classReplayMessagesFailure
Reply message to a failed ReplayMessages request. This reply is sent to the requester if a replay could not be successfully completed.
Public classReplyToStrategy
Reply to sender with predefined response, and discard the received message silently.
Public classSaveSnapshot
Instructs a snapshot store to save a snapshot.
Public classSaveSnapshotFailure
Sent to PersistentActor after failed saving a snapshot.
Public classSaveSnapshotSuccess
Sent to PersistentActor after successful saving of a snapshot.
Public classScheduledUpdate
Public classSelectedSnapshot
A selected snapshot matching SnapshotSelectionCriteria.
Public classSnapshotMetadata
Public classSnapshotOffer
Offers a PersistentActor a previously saved snapshot during recovery. This offer is received before any further replayed messages.
Public classSnapshotSelectionCriteria
Selection criteria for loading and deleting a snapshots.
Public classStashingHandlerInvocation
Forces actor to stash incoming commands until all invocations are handled.
Public classThrowExceptionConfigurator
Public classThrowOverflowExceptionStrategy
Public classUnconfirmedDelivery
Contains details about unconfirmed messages. It's included inside UnconfirmedWarning and AtLeastOnceDeliverySnapshot. WarnAfterNumberOfUnconfirmedAttempts
Public classUnconfirmedWarning
Message should be sent after WarnAfterNumberOfUnconfirmedAttempts limit will is reached.
Public classUntypedPersistentActor
Persistent actor - can be used to implement command or eventsourcing.
Public classUpdate
Instructs a PersistentView to update itself. This will run a single incremental message replay with all messages from the corresponding persistent id's journal that have not yet been consumed by the view. To update a view with messages that have been written after handling this request, another Update request must be sent to the view.
Public classWriteMessageFailure
Reply message to a failed WriteMessages request. For each contained IPersistentRepresentation message in the request, a separate reply is sent to the requester.
Public classWriteMessageRejected
Reply message to a rejected WriteMessages request. The write of this message was rejected before it was stored, e.g. because it could not be serialized. For each contained IPersistentRepresentation message in the request, a separate reply is sent to the requester.
Public classWriteMessages
Request to write messages.
Public classWriteMessagesFailed
Reply message to a failed WriteMessages request. This reply is sent to the requester before all subsequent WriteMessageFailure replies.
Public classWriteMessagesSuccessful
Reply message to a successful WriteMessages request. This reply is sent to the requester before all subsequent WriteMessageSuccess replies.
Public classWriteMessageSuccess
Reply message to a successful WriteMessages request. For each contained IPersistentRepresentation message in the request, a separate reply is sent to the requester.
Public interfaceFSharpDeliveryCommand, Event, State
Public interfaceFSharpEventsourcedCommand, Event, State
Public interfaceFSharpSnapshotterState
Public interfaceFSharpViewEvent, State
Public interfaceIJournalMessage
Marker interface for internal journal messages
Public interfaceIJournalPlugin
Public interfaceIJournalRequest
Internal journal command
Public interfaceIJournalResponse
Internal journal acknowledgement
Public interfaceIPendingHandlerInvocation
Public interfaceIPersistenceMessage
Marker interface for internal persistence extension messages. Helps persistence plugin developers to differentiate internal persistence extension messages from their custom plugin messages. Journal messages need not be serialization verified as the Journal Actor should always be a local Actor (and serialization is performed by plugins). One notable exception to this is the shared journal used for testing.
Public interfaceIPersistenceRecovery
Public interfaceIPersistenceStash
Public interfaceIPersistentEnvelope
Internal API Marks messages which can then be resequenced by AsyncWriteJournal. In essence it is either an NonPersistentMessage or AtomicWrite
Public interfaceIPersistentIdentity
Public interfaceIPersistentRepresentation
Representation of a persistent message in the journal plugin API.
Public interfaceISnapshotMessage
Marker interface for internal snapshot messages
Public interfaceISnapshotRequest
Internal snapshot command
Public interfaceISnapshotResponse
Internal snapshot acknowledgement
Public interfaceISnapshotter
Snapshot API on top of the internal snapshot protocol.
Public interfaceIStashOverflowStrategy
This defines how to handle the current received message which failed to stash, when the size of the Stash exceeding the capacity of the Stash.
Public interfaceIStashOverflowStrategyConfigurator
Implement this interface in order to configure the IStashOverflowStrategy for the internal stash of the persistent actor. An instance of this class must be instantiable using a no-args constructor.