API Reference
FCQRS
No description available.
Actor
No description available.
Connection
Represents a database connection configuration
DBType
Represents the type of database connection
ActorSerialization
No description available.
ConditionalCommandSerializer
Serializes the transient expected-version protocol separately from persisted messages.
STJSerializer
No description available.
AkkaTimeProvider
No description available.
Internal
No description available.
CSharp
C# interoperability helpers for FCQRS Provides simpler APIs for consuming FCQRS from C#
ActorApi
C#-friendly Actor API
ActorWiring
Low-level wiring over an IActor: register the saga-starter, aggregates and actors, and send commands.
Aggregate<'TState, 'TCommand, 'TEvent>
C#-friendly abstract base for an event-sourced aggregate.
AggregateFactory
C# delegate for an aggregate's entity-ref factory: an id -> its sharded actor ref.
AggregateRefs<'TCommand, 'TEvent>
The two C#-facing pieces of a wired aggregate: a Factory for entity refs (used by sagas to target the aggregate) and a Handler to send a command and await its event (used by the delivery layer).
Describe
Diagnostics helper: a short, readable case name for logging.
EventActions
C#-friendly factory methods for EventAction
Expectations
C#-friendly factory for saga expectations
FSharpResults
C#-friendly factory methods for constructing an F# Result (Ok/Error) from C#.
Handler<'TCmd, 'TEvent>
C# delegate for command handlers - returns Task<Event<TEvent>>
JournalTypeMapBuilder
Fluent registrar for stable journal type names (see JournalTypes).
PrefixConversions
C#-friendly factory for PrefixConversion
QueryApi
C#-friendly Query API
RetrySchedules
C#-friendly factories for saga expectation retry schedules
Saga<'TEvent, 'TSagaData, 'TState>
C#-friendly abstract base for a saga.
SagaApi
Low-level C# saga API (mirrors ActorApi/QueryApi).
SagaCommands
C#-friendly saga command targeting
SagaDefinition
C#-friendly class for defining saga starters (uses class for C# object initializer syntax)
SagaEventActions
C#-friendly factory methods for saga EventAction
SagaSideEffectResult<'TState>
C#-friendly result type for saga side effects (uses class for C# object initializer syntax)
SagaStates
C#-friendly helpers for SagaState
SagaTransitions
C#-friendly factory methods for SagaTransition
TestEnvelope
C#-friendly builders for the Command/Event envelopes that the pure handleCommand/applyEvent functions expect.
Values
Factory methods for creating FCQRS's strongly-typed value/identifier types (CID, AggregateId, MessageId, ShortString, LongString, Version) from C#.
Common
Contains common types like Events and Commands
CommandHandler
(Internal) Contains the implementation for command subscriptions.
Internal
No description available.
State<'Command, 'Event>
No description available.
Command<'Command, 'Event>
Represents the message sent to the internal subscription mechanism.
CommandDetails<'Command, 'Event>
No description available.
SagaBuilder
Contains types and functions for building and initializing sagas
SagaStateWrapper<'UserState, 'TEvent>
Standard wrapper for saga states that includes NotStarted/Started
SagaStarter
Contains types and functions related to the Saga Starter actor (internal implementation detail).
Internal
No description available.
SagaStartingEvent<'T>
Wraps an event that is intended to start a saga.
AggregateVersionConflictException
The aggregate rejected a conditional command before running its handler because its persisted version differed from the caller's expected version.
AkkaLogLevel
Akka's internal log verbosity.
Command<'CommandDetails>
Represents a command to be processed by an aggregate actor.
Event<'EventDetails>
Represents an event generated by an aggregate actor as a result of processing a command.
EventAction<'T>
Defines the possible actions an aggregate or saga actor can take after processing a command or event.
ExecuteCommand
Represents a command to be executed, often scheduled or triggered by a saga.
Expectation
A declared expectation attached to a saga's waiting state via <c>StayExpecting</c>: the framework sends <c>Resend</c> on state entry, re-sends exactly those commands on the schedule while no state transition is persisted, and past <c>Deadline</c> (measured from the persisted state-entry time, so crash loops cannot postpone it) delivers an <see cref="T:FCQRS.Common.ExpectationExhausted"/> message to the saga's event handler.
ExpectationExhausted
Delivered to the saga's event handler when an expectation's deadline has passed without a state transition.
FactoryAndName
Represents the information needed to locate or create a target actor, typically used within sagas.
IActor
Defines the core functionalities and context provided by the FCQRS environment to actors.
IConfigurationWrapper
No description available.
IEnvelope
Non-generic access to a Command<_>/Event<_> payload, so a boxed message can be unwrapped to its details without knowing the concrete payload type.
ILoggerFactoryWrapper
No description available.
ISerializable
Marker interface for types that can be serialized by Akka.NET.
JournalTypes
Stable logical names for journal payload types.
Notify
Decision returned by a filtered projection handler: whether the event it just handled should be published to subscribers as-is.
PassivationPolicy
Idle passivation for an aggregate type, set per entity at registration.
PrefixConversion
Default shard name used if no specific sharding strategy is provided.
RetrySchedule
Retry cadence for a saga expectation (see <see cref="T:FCQRS.Common.Expectation"/>).
SagaState<'SagaData, 'State>
Represents the state of a saga instance.
SagaTransition<'State>
Represents the next state transition for a saga after processing an event or timeout.
SnapshotPolicy
Snapshot cadence for an aggregate or saga, set per entity at registration.
TargetActor
Represents the target of a command execution triggered by a saga.
TargetName
Represents the name identifying a target actor for a command, typically used within sagas.
Telemetry
FCQRS's ActivitySource names — register them with your tracing pipeline (e.g.
DynamicConfig
No description available.
Internal
No description available.
ConfigExtension
No description available.
EventUpcasting
Conversions of historical event payloads at FCQRS journal-read boundaries.
FSharp
Idiomatic-F# functional facade for FCQRS.
Fcqrs
No description available.
Projection
Constructors for the two projection-handler shapes.
Aggregate<'State, 'Command, 'Event>
A pure aggregate definition: the four things that define an event-sourced aggregate.
AggregateFactory
An aggregate's entity-ref factory: an id -> its sharded actor ref.
AggregateHandle<'Command, 'Event>
What you get back after registering an aggregate.
Handler<'Command, 'Event>
An application command handler: event filter, correlation id, aggregate id, then command.
Projection
A read-model projection definition.
Saga<'Data, 'State, 'OriginatorEvent>
A pure saga definition.
SagaHandle
What you get back after registering a saga.
ProjectionStorage
SQL storage for journal-wide, transactional projection catch-up.
ProjectionSqlDialect
Database SQL syntax supported by the transactional projection store.
SqlProjectionStore
Stores one durable, contiguous sequence position per projection and persistence ID.
Projections
Transactional projections with a journal-wide, durable catch-up boundary.
IProjection
A transactional projection and its request-scoped notification subscriptions.
TransactionalProjectionOptions
Options for a named transactional projection.
Query
No description available.
IAwaitable
No description available.
IAwaitableDisposable
A subscription whose Task succeeds after the requested callbacks complete.
ISubscribe<'TDataEvent>
No description available.
ISubscribe
The canonical subscription stream: a non-generic shorthand for ISubscribe<IMessageWithCID> — the type every FCQRS projection / read-your-writes subscription actually uses (cf.
Saga
No description available.
Scheduler
No description available.
ObservingScheduler
Scheduler wrapper that exposes enqueue/cancel events with optional names
SchedulerController
No description available.
AsyncTaskExtensions
Top-level Async->Task conversion, discoverable from C# as `someAsync.AsTask()` (`using FCQRS;`).
FcqrsBuilder
Fluent registration builder.
FcqrsBuilderExtensions
Single-type-argument forms of AddAggregate / AddSaga.
FcqrsRuntime
Runtime registry, populated once at host startup.
FcqrsServiceCollectionExtensions
`services.AddFcqrs(...)` and `serviceProvider.Aggregate<T>()`.
SubscribeExtensions
Top-level C# extension methods for ISubscribe.
Model
No description available.
Aether
No description available.
Compose
No description available.
AsyncValidatedLens
No description available.
ValidatedLens
No description available.
ValidatedPrism
No description available.
Lens
Static overloads of the composition function for lenses (>->).
Prism
Static overloads of the composition function for prisms (>?>).
Lens
No description available.
Operators
No description available.
Optic
No description available.
Get
Static overloads of the optic get function (^.).
Map
Static overloads of the optic map function (%=).
Set
Static overloads of the optic set function (^=).
Optics
Various optics implemented for common types such as tuples, lists and maps, along with an identity lens.
Array
No description available.
Choice
No description available.
List
No description available.
Map
No description available.
Option
No description available.
Result
No description available.
Prism
No description available.
AsyncValidatedLens<'a, 'b, 'e>
Async Validated Lens from 'a -> 'b with error type 'e.
Epimorphism<'a, 'b>
Epimorphism between 'a and 'b.
Isomorphism<'a, 'b>
Isomorphism between 'a and 'b.
Lens<'a, 'b>
Lens from 'a -> 'b.
Prism<'a, 'b>
Prism from 'a -> 'b.
ValidatedLens<'a, 'b, 'e>
Validated Lens from 'a -> 'b with error type 'e.
ValidatedPrism<'a, 'b, 'e>
Validated Prism from 'a -> 'b with error type 'e.
CSharp
C# interoperability helpers for FCQRS.Model Provides simpler APIs for consuming FCQRS types from C#
Helpers
Helper methods for creating FCQRS.Model types from C#
Results
C#-friendly factory methods for FSharpResult
StringTypes
C#-friendly string type creation with simple error handling
Data
No description available.
Result
No description available.
AggregateId
No description available.
CID
CorrelationID for commands and Sagas
IMessage
Interface for messages with common properties shared by Commands and Events.
IMessageWithCID
Interface for messages that carry a Correlation ID (CID).
LongString
Represents any string at least 1 chars
MessageId
Message Id , generally not much use case.
ModelError
No description available.
Predicate
Used to for queries
ShortString
Validated non-blank string up to 255 chars inclusive.
ValueLens
No description available.
ValueLensResultType<'Wrapped, 'Inner, 'Error>
Helper types for ValueLens for static resolution
ValueLensType<'Wrapped, 'Inner>
Helper types for ValueLens for static resolution
Version
Aggregate Version
FreeMonad
No description available.
Eff
No description available.
Free
No description available.
Free<'Instruction, 'Result>
No description available.
FreeBuilder
No description available.
FreeResultBuilder
No description available.
Validation
No description available.
ValidateRegexes
No description available.
FieldInfo<'T, 'T0, 'E>
No description available.
ValidateResult<'T>
No description available.
Validator<'E>
No description available.
Serialization
No description available.
Serialization
Provides JSON serialization and deserialization functionality for FCQRS.
UnionConverter<'T>
System.Text.Json converter for a single C# 15 union type.
UnionConverterFactory
Factory that supplies <see cref="T:FCQRS.Serialization.Serialization.UnionConverter`1"/> for any C# 15 discriminated union type.
SQLProvider
No description available.
Query
No description available.
ExpectoTickSpec
No description available.
FeatureTest
TickSpec -> Expecto bridge.