Table of Contents

Namespace Excalibur.Dispatch.Delivery

Classes

AppliesToAttribute

Indicates which message kinds a middleware component applies to.

CompositeMessageUpgradeStrategy

Composite message upgrade strategy that delegates to multiple underlying strategies.

CronExpressionExtensions

Extension methods for ICronExpression.

CronRecurrenceProfile

An explicit immutable declaration of supported local-time cron transition behavior.

CronScheduler

Default implementation of ICronScheduler with timezone awareness.

DeduplicationCapacityExceededException

Transient exception thrown by an in-memory deduplicator when its tracking store is at capacity and a record-producing operation cannot be honored without silently skipping deduplication.

DeliveryMessageEnvelopeExtensions

Extension methods for creating struct-based message envelopes.

DurableScheduleStoreRegistration

Registers an IScheduleStore together with, and inseparably from, its durability attestation, and installs the boot-time gate that refuses a volatile store the host never asked for.

EventStoreMessage<TAggregateKey>

Represents a message stored in an event store.

ExcludeKindsAttribute

Indicates which message kinds a middleware component should exclude from processing.

JobExecutionHistory

Represents a job execution history entry.

MessageMetadataBuilder

Builder for creating message metadata.

ProjectionBase<TKey>

Base class for projections that provides common functionality.

ProjectionEventHandlerBase<TProjection, TKey, TEvent>

Provides the base implementation for strongly-typed projection event handlers in the event sourcing system. This abstract class defines the contract for implementing domain-specific projection logic while maintaining type safety and enabling polymorphic behavior through the projection handling infrastructure.

ScheduleDurabilityOptions

Options governing whether scheduled delivery may run on a schedule store that does not survive a restart.

ScheduleExecutionLease

Bearer authority identifying one admitted occurrence on one logical store.

ScheduleExecutionResult

Bounded progress changes allowed for an admitted execution.

ScheduleExecutionSnapshot

A detached scheduled message paired with its opaque administrative generation.

ScheduleFailureExecutionAdmission

An admitted bearer and the provider-captured automatic budget. Policy fields are observations, not bearer authority.

ScheduleOccurrenceFailure

Bounded requested failure disposition.

ScheduleOccurrenceFailureSnapshot

Detached failure provenance and an optional immutable recovery receipt.

ScheduleQuarantineRecoveryReceipt

Immutable durable result of an explicit recovery command.

ScheduleQuarantineToken

Expected state for one retained quarantine; not an execution lease.

ScheduledMessage

Default implementation of IScheduledMessage with timezone support.

SnapshotEnvelope<TKey>

Default implementation of a snapshot envelope that contains aggregate state.

TimeZoneAwareCronExpression

A timezone-aware wrapper around Cronos CronExpression.

Structs

DocumentProgress

Represents progress information for a document processing operation.

MessageMetadata

Represents message metadata.

Interfaces

IActionHandler<TAction>

Defines a handler for an action with no return value. This is the recommended handler interface for commands.

IActionHandler<TAction, TResult>

Defines a handler for an action that returns a result. This is the recommended handler interface for queries.

ICronExpression

Represents a parsed cron expression with timezone awareness.

ICronExpressionQuery

Provides additional query operations for cron expressions. Implementations should implement this alongside ICronExpression.

ICronScheduler

Provides cron-based scheduling capabilities with timezone awareness.

IDispatchScheduler

Defines the contract for scheduling message dispatch operations with support for both one-time and recurring execution patterns.

IDocumentHandler<TDocument>

Defines a handler for processing document-style messages.

IEventHandler<TEvent>

Defines a handler for processing events in the messaging pipeline.

IMessageContextFactory

Factory for creating message context instances.

IProgressDocumentHandler<TDocument>

Defines a handler that processes a document with progress reporting.

IScheduleExecutionFailureStore

Same-authority admission policy, bounded failure retention and explicit quarantine recovery. Budget capture/grant/count, failure/disable, and recovery/receipt/history each share one atomic boundary. Query tenant IDs are exact partitions supplied by an authorized caller, not authorization credentials.

IScheduleExecutionLeaseRenewal

Optional renewable, expiring occurrence ownership on the configured schedule store.

IScheduleExecutionStore

Optional authoritative occurrence-admission capability on the configured schedule store.

IScheduleSpec

Defines the scheduling specification for a message including cron expression, timezone, interval, next execution time, and enabled state.

IScheduleStore

Defines the contract for storage and retrieval of scheduled messages with lifecycle management.

IScheduledMessage

Represents a persistable scheduled message with comprehensive metadata for timezone-aware execution and tracking.

IScheduledMessageIdentity

Defines the identity and payload properties of a scheduled message including its unique identifier, message type, serialized body, and correlation tracking.

IScheduledMessageMetadata

Defines the execution tracking and operational metadata for a scheduled message including last execution time, missed execution policy, tenant isolation, tracing, and audit identity.

IStreamConsumerHandler<TDocument>

Defines a handler that consumes a stream of documents.

IStreamTransformHandler<TInput, TOutput>

Defines a handler that transforms an input stream into an output stream.

IStreamingDocumentHandler<TDocument, TOutput>

Defines a handler that produces a stream of outputs from a document.

Enums

MessageFlags

Message flags.

MissedExecutionBehavior

Defines how to handle executions that were missed while the scheduler was offline.

PastScheduleBehavior

Controls how Excalibur.Dispatch.Delivery.RecurringDispatchScheduler handles messages scheduled in the past.

ScheduleAdmissionPolicySelection

Origin of the immutable admission policy returned by the authority.

ScheduleExecutionCompletionDisposition

Explicit reason for successful conditional occurrence retirement.

ScheduleFailureDisposition

Persisted disposition of an admitted failure.

ScheduleFailureReason

Bounded reason for an unsuccessful scheduled occurrence.