FSharp.Eventsourced(Command, Event, State) Interface

FSharpEventsourcedCommand, Event, State Interface

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

Namespace: Akka.Persistence
Assembly: Akka.Persistence.FSharp (in Akka.Persistence.FSharp.dll) Version: 0.0.0.0

Syntax

public interface Eventsourced<Command, Event, State> : FSharpSnapshotter<State>, 
	ICanWatch, IActorRefFactory

[<SerializableAttribute>]
type Eventsourced<'Command, 'Event, 'State> =  
    interface
        interface FSharpSnapshotter<'State>
        interface ICanWatch
        interface IActorRefFactory
    end

Type Parameters

Command: [Missing <typeparam name="Command"/> documentation for "T:Akka.Persistence.FSharp.Eventsourced`3"]
Event: [Missing <typeparam name="Event"/> documentation for "T:Akka.Persistence.FSharp.Eventsourced`3"]
State: [Missing <typeparam name="State"/> documentation for "T:Akka.Persistence.FSharp.Eventsourced`3"]

The FSharpEventsourcedCommand, Event, State type exposes the following members.

Properties

	Name	Description
	Context	Gets the current actor context.
	Log	Lazy logging adapter. It won't be initialized until logging function will be called.
	Self	Gets [IActorRef] for the current actor.

Top

Methods

	Name	Description
	ActorOf	Create new actor as child of this context with the given name, which must not start with "$". If the given name is already in use, and InvalidActorNameException is thrown. See Props for details on how to obtain a Props object. (Inherited from IActorRefFactory.)
	ActorSelection(String)	Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors. (Inherited from IActorRefFactory.)
	ActorSelection(ActorPath)	Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors. (Inherited from IActorRefFactory.)
	AsyncPersistEvent	Asynchronously persists sequence of events in the event journal. Use second argument to define function which will update state depending on events.
	Defer	Defers a function execution to the moment, when actor is suposed to end it's lifecycle. Provided function is guaranteed to be invoked no matter of actor stop reason.
	DeferEvent	Defers a second argument (update state callback) to be called after persisting target event will be confirmed.
	DeleteSnapshot	(Inherited from FSharpSnapshotterState.)
	DeleteSnapshots	(Inherited from FSharpSnapshotterState.)
	IsRecovering	Returns value determining if current persistent view is actually recovering.
	Journal	Returns currently attached journal actor reference.
	LastSequenceNr	Returns last sequence number attached to latest persisted event.
	LoadSnapshot	(Inherited from FSharpSnapshotterState.)
	PersistenceId	Persistent actor's identifier that doesn't change across different actor incarnations.
	PersistEvent	Persists sequence of events in the event journal. Use second argument to define function which will update state depending on events.
	SaveSnapshot	(Inherited from FSharpSnapshotterState.)
	Sender	Returns a sender of current message or [ActorRefs.NoSender], if none could be determined.
	SnapshotStore	Returns currently attached snapshot store actor reference.
	Unhandled	Explicit signalization of unhandled message.
	Unwatch	Stops monitoring the subject for termination. (Inherited from ICanWatch.)
	Watch	Monitors the specified actor for termination. When the subject terminates the instance watching will receive a Terminated message. Remarks Note that if the Terminated message isn't handled by the actor, by default the actor will crash by throwing a DeathPactException. To change the default behavior, override Unhandled(Object). (Inherited from ICanWatch.)

Top

Extension Methods

	Name	Description
	ActorOf(ActionIActorDsl, String)	Overloaded. TBD (Defined by ActExtensions.)
	ActorOf(ActionIActorDsl, IActorContext, String)	Overloaded. TBD (Defined by ActExtensions.)
	ActorOfTActor(String)	Overloaded. TBD (Defined by ActorRefFactoryExtensions.)
	ActorSelection	Construct an ActorSelection from the given string representing a path relative to the given target. This operation has to create all the matching magic, so it is preferable to cache its result if the intention is to send messages frequently. (Defined by ActorRefFactoryExtensions.)
	Materializer	Creates a ActorMaterializer which will execute every step of a transformation pipeline within its own ActorBase. The required IActorRefFactory (which can be either an ActorSystem or an IActorContext) will be used to create one actor that in turn creates actors for the transformation steps. The materializer's ActorMaterializerSettings will be obtained from the configuration of the context's underlying ActorSystem. The namePrefix is used as the first part of the names of the actors running the processing steps. The default namePrefix is "flow". The actor names are built up of namePrefix-flowNumber-flowStepNumber-stepName. (Defined by ActorMaterializerExtensions.)

Top

Reference

Akka.Persistence Namespace