Table of Contents

Namespace Excalibur.Dispatch.Messaging

Classes

CacheStatistics

Comprehensive cache statistics for tracking cache performance and usage across the messaging framework.

DispatchContextInitializer

Helper methods for creating MessageContext instances from various sources.

DispatchMessage

Represents a generic dispatch message with serialized payload and metadata.

DispatchMessageExtensions

Provides extension methods for IDispatchMessage instances to determine message types and characteristics.

MemoryMessage

A message implementation that holds its content as Memory<byte> for zero-copy operations.

MemoryMessageExtensions

Extension methods for creating memory messages.

MemoryMessageOfT<T>

A typed message implementation that provides both Memory<byte> and typed access to content.

MessageContext

High-performance implementation of IMessageContext optimized for zero-allocation scenarios. Uses lazy ID generation and direct field storage for the 7 core properties. Cross-cutting concerns (identity, routing, processing state, etc.) are accessed via the Features dictionary.

MessageContextAttribute

Marks a property to be populated from the current IMessageContext.

MessageEnvelope<TMessage>

Generic message envelope for strongly-typed message handling.

MessageMetadata

Default implementation of message metadata containing essential message properties.

SagaDeliveryIdentity

Names an original delivery before a handler or effect preparation runs.

SagaDurableSnapshot

Owns an authoritative durable scope and optional encoded state loaded before handler admission.

SagaInfo

Contains metadata and configuration information for a saga type, including handled events and saga lifecycle. This class manages the registration of event types that can start or continue a saga instance, providing runtime information for saga coordination and event routing.

SagaInstanceSummary

A lightweight, read-only projection of a persisted saga instance for administrative and dashboard listing, carrying identity, type, lifecycle state, and concurrency version without the full state payload.

SagaPreparedTimerMutation

Owns the encoded immutable inputs for one SQL timer mutation.

SagaPreparedTransition

Owns the exact encoded state and ordered effect inputs of one durable transition attempt.

SagaQueryFilter

Filter criteria for querying saga instances via QuerySagasAsync(SagaQueryFilter, CancellationToken).

SagaScopeIdentity

Names the authoritative storage scope before an incarnation or speculative transition is allocated.

SagaState

Base class for saga state management, providing fundamental properties for workflow persistence and tracking. This abstract class serves as the foundation for all saga state implementations, ensuring consistent identity management and completion tracking across different workflow types.

SagaStoreStatistics

Aggregate statistics about the sagas in a store: counts of running and completed instances.

SagaTimeoutDeliveryIdentity

Owns the original scheduled timeout authority carried through claim and delivery.

SagaTimerRecoveryApplyResult

Returns complete per-intent disposition or a non-success authority observation.

SagaTimerRecoveryDomain

Names the public timer cancellation domain, independent of saga state type.

SagaTimerRecoveryFence

Names one exact compact receiver state; it is an observation, not ownership of saga state.

SagaTimerRecoveryIntentResult

Retains a provider-established per-intent result instead of claiming cancelled work applied.

SagaTimerRecoveryJournal

Owns the original encoded timer intents persisted with ordinary saga state and dedup.

SagaTransitionCommitResult

Reports a durable transition result without treating a missing acknowledgement as rollback.

SagaTransitionIdentity

Names one durable transition independently of its expected state version.

TenantIsolationViolationException

Thrown when an operation addresses data belonging to a different tenant than the one in scope.

UpcastingMessageBusDecorator

Decorates IMessageBus to automatically upcast versioned messages before delivery to handlers.

Uuid7Extensions

Provides comprehensive extension methods for generating and working with UUID v7 strings and GUIDs.

WellKnownHeaderNames

Provides constants for common Excalibur-specific HTTP header names.

Structs

MessageEnvelopeBuilder

Builder for creating MessageEnvelopeStruct instances with pooled resources.

MessageEnvelopeStruct

High-performance struct for message envelope with minimal allocations.

Interfaces

IEventStoreMessage

Defines the contract for a message stored in an event store.

IEventStoreMessage<TAggregateKey>

Defines the contract for a message stored in an event store with a specific aggregate key type.

IMessageContextAccessor

Provides access to the current message context during message processing operations.

IMessageContextPool

Defines a pool for reusable message context instances.

ISaga

Defines the contract for event-driven choreography saga instances that manage long-running business processes through event reactions. This is the Process Coordinator pattern where services autonomously react to domain events.

ISagaAtomicTimeoutParticipant

Validates the selected timer backend for a provider-owned atomic saga transaction.

ISagaAtomicTransitionStore

Optionally commits immutable state and effects in one provider-owned durable transaction.

ISagaCoordinator

Defines the contract for saga coordination services that manage the lifecycle and event routing for saga instances within the distributed messaging system. The coordinator is responsible for finding appropriate saga instances, routing events, and managing saga state transitions.

ISagaStore

Defines the contract for saga persistence services that handle loading and saving of saga state across business process boundaries. The saga store provides durable storage for long-running processes, enabling saga recovery and consistency in distributed system environments.

ISagaStoreAdmin

Administrative and query operations over a saga store: enumerate and filter saga instances, fetch a single instance summary, and compute aggregate statistics.

ISagaTimerRecoveryStore

Applies persisted ordinary saga timer intents under retained receiver authority.

ISaga<TSagaState>

Extends the basic saga contract with strongly-typed access to saga state. This generic interface provides type-safe access to saga state while maintaining compatibility with the base saga infrastructure.

Enums

SagaEventOutcome

Whether a saga actually acted on an event it was given.

SagaPreparedTimerAction

Identifies an ordered timer operation in a prepared saga transition.

SagaTimerRecoveryApplyOutcome

Distinguishes known complete receipt, supersession, required state revalidation and uncertainty.

SagaTimerRecoveryIntentOutcome

States the known disposition of one original timer intent.

SagaTransitionCommitOutcome

Describes authoritative outcomes of a store-owned durable transition.

SkipBehavior

Defines the behavior when message processing is skipped due to filtering, conditions, or validation failures. Controls how the messaging system responds to scenarios where normal processing cannot or should not proceed.