Excalibur.Dispatch API Reference

Welcome to the API reference documentation for the Excalibur.Dispatch framework.

Overview

Excalibur.Dispatch is a comprehensive .NET framework providing:

  • Message Dispatching - Alternative to MediatR with middleware pipelines
  • Event Sourcing - Patterns for aggregate persistence and event stores
  • Outbox Pattern - Reliable messaging with at-least-once delivery
  • Domain-Driven Design - Building blocks for DDD implementations
  • Compliance - Encryption, audit logging, and data protection

Framework Packages

Dispatch (Messaging Framework)

The messaging framework handles how messages flow through the system.

Package Description
Dispatch Core dispatcher, pipelines, middleware
Excalibur.Dispatch.Abstractions IDomainEvent, IIntegrationEvent, serialization
Excalibur.Compliance Encryption, data protection
Excalibur.Dispatch.Observability OpenTelemetry metrics, tracing
Excalibur.Dispatch.Caching Caching infrastructure
Dispatch.EventSourcing Event sourcing patterns

Excalibur (Application Framework)

The application framework handles what gets persisted and domain modeling.

Package Description
Excalibur.Domain Aggregates, entities, domain building blocks
Excalibur.Data.Abstractions IDataRequest, IDb, data access patterns
Excalibur.EventSourcing Event stores, repositories, snapshots
Excalibur.EventSourcing.SqlServer SQL Server event store
Excalibur.Saga Saga/Process manager abstractions

Key Interfaces

Messaging

  • IDispatcher - Message dispatch orchestration
  • IDispatchMiddleware - Pipeline middleware
  • IDomainEvent - Domain event contract
  • IIntegrationEvent - Integration event contract

Event Sourcing

  • IAggregateRoot - Aggregate root interface
  • IEventStore - Event persistence
  • ISnapshotStore - Snapshot persistence
  • IProjection - Read model projections

Data Access

  • IDataRequest<TResult> - Type-safe data requests
  • IPersistenceProvider - Database connection factory
  • IEventSourcedRepository<T> - Event-sourced aggregate persistence

Observability

  • IDispatchTelemetryProvider - Telemetry provider
  • IDispatchMetrics - Metrics collection

Generating Documentation

The API reference is generated using DocFX from XML documentation comments.

Prerequisites

dotnet tool install -g docfx

Build Documentation

cd eng/docs/api
docfx docfx.json

Serve Locally

docfx docfx.json --serve

See Also