Click or drag to resize
Akka.NETFSharpFunPersistentViewEvent, State Class

[Missing <summary> documentation for "T:Akka.Persistence.FSharp.FunPersistentView`2"]

Inheritance Hierarchy
SystemObject
  Akka.ActorActorBase
    Akka.PersistencePersistentView
      Akka.PersistenceFSharpFunPersistentViewEvent, State

Namespace:  Akka.Persistence
Assembly:  Akka.Persistence.FSharp (in Akka.Persistence.FSharp.dll) Version: 0.0.0.0
Syntax
Copy
[SerializableAttribute]
public class FunPersistentView<Event, State> : PersistentView

Type Parameters

Event

[Missing <typeparam name="Event"/> documentation for "T:Akka.Persistence.FSharp.FunPersistentView`2"]

State

[Missing <typeparam name="State"/> documentation for "T:Akka.Persistence.FSharp.FunPersistentView`2"]

The FSharpFunPersistentViewEvent, State type exposes the following members.

Constructors
  NameDescription
Public methodFSharpFunPersistentViewEvent, State
Initializes a new instance of the FSharpFunPersistentViewEvent, State class
Top
Properties
  NameDescription
Public propertyAutoUpdateInterval
Time interval to automatic updates. Used only when IsAutoUpdate value is true.
(Inherited from PersistentView.)
Public propertyAutoUpdateReplayMax
The maximum number of messages to replay per update.
(Inherited from PersistentView.)
Public propertyIsAutoUpdate
If true, this view will update itself automatically within an interval specified by AutoUpdateInterval. If false, application must update this view explicitly with Update requests.
(Inherited from PersistentView.)
Public propertyIsPersistent
If true, the currently processed message was persisted - it sent from the Journal. If false, the currently processed message comes from another actor ('/user/*' path).
(Inherited from PersistentView.)
Public propertyIsRecovering
Returns true if this persistent view is currently recovering.
(Inherited from PersistentView.)
Public propertyIsRecoveryFinished
Returns true if this persistent view has successfully finished recovery.
(Inherited from PersistentView.)
Public propertyJournal
TBD
(Inherited from PersistentView.)
Public propertyJournalPluginId
TBD
(Inherited from PersistentView.)
Public propertyLastSequenceNr
Highest received sequence number so far or 0 it none persistent event has been replayed yet.
(Inherited from PersistentView.)
Public propertyPersistenceId (Overrides PersistentViewPersistenceId.)
Public propertyRecovery
Called when the persistent view 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 PersistentView.)
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 PersistentView.)
Public propertySnapshotSequenceNr
Gets last sequence number.
(Inherited from PersistentView.)
Public propertySnapshotStore
TBD
(Inherited from PersistentView.)
Public propertySnapshotterId
Gets the ViewId.
(Inherited from PersistentView.)
Public propertyStash
TBD
(Inherited from PersistentView.)
Public propertyViewId (Overrides PersistentViewViewId.)
Top
Methods
  NameDescription
Public methodAroundPostRestart
Can be overridden to intercept calls to `PostRestart`. Calls `PostRestart` by default.
(Inherited from ActorBase.)
Public methodAroundPostStop
Can be overridden to intercept calls to `PostStop`. Calls `PostStop` by default..
(Inherited from ActorBase.)
Public methodAroundPreRestart
Can be overridden to intercept calls to `PreRestart`. Calls `PreRestart` by default.
(Inherited from ActorBase.)
Public methodAroundPreStart
TBD
(Inherited from PersistentView.)
Protected methodAroundReceive
TBD
(Inherited from PersistentView.)
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 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 PersistentView.)
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 PersistentView.)
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 methodLoadSnapshot
Instructs the snapshot store to load the specified snapshot and send it via an SnapshotOffer to the running PersistentActor.
(Inherited from PersistentView.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnReplayError
Called whenever a message replay fails. By default it logs the error. Subclass may override to customize logging. The PersistentView will not stop or throw exception due to this. It will try again on next update.
(Inherited from PersistentView.)
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.)
Public methodPostStop (Overrides PersistentViewPostStop.)
Protected methodPreRestart
TBD
(Inherited from PersistentView.)
Protected methodPreStart
TBD
(Inherited from PersistentView.)
Public methodReceive (Overrides ActorBaseReceive(Object).)
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 PersistentView.)
Public methodSender
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.)
Protected methodSupervisorStrategy
TBD
(Inherited from ActorBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodUnbecomeStacked
Reverts the Actor behavior to the previous one on the behavior stack.
(Inherited from ActorBase.)
Public methodUnhandled
Top
Fields
  NameDescription
Protected fieldExtension
TBD
(Inherited from PersistentView.)
Top
Extension Methods
See Also