Table of Contents

Namespace Excalibur.Dispatch.Transport

Classes

AccessRule

Represents an access control rule for a destination.

AwsSnsMappingContext

AWS SNS mapping context implementation.

AwsSqsMappingContext

AWS SQS mapping context implementation.

AzureServiceBusMappingContext

Azure Service Bus mapping context implementation.

BatchCollectionOptions

Options controlling how messages are collected into batches before processing.

BatchProcessingMetrics

Metrics for batch processing.

BatchProcessingOptions

Options for batch processing.

BatchProcessingResult

Result of batch processing.

BatchSendResult

Represents the result of a batch send operation. Replaces BatchPublishResult with cleaner naming aligned to the ITransportSender contract.

ChannelStatistics

Represents statistics for a message channel.

CloudEventBinding

The CloudEvents protocol binding a transport speaks, which decides how binary-mode attributes are named on the wire.

CloudEventDecodingReceiverExtensions

Applies inbound CloudEvents decoding to a transport receiver.

CloudEventEncodingSenderExtensions

Applies outbound CloudEvents encoding to a transport sender.

CloudEventTransportMessageExtensions

Attaches a CloudEvent to an outbound message so the transport publishes it as a CloudEvent.

ConfiguredMessageMapper

Message mapper that applies configured mappings from the fluent API.

CronTimerTransportAdapter

Cron timer transport adapter that generates synthetic messages on a schedule.

CronTimerTransportAdapterOptions

Configuration options for the cron timer transport adapter.

CronTimerTriggerMessage

Synthetic message generated by the cron timer transport when a scheduled trigger fires.

CronTimerTriggerMessage<TTimer>

Generic cron timer trigger message that includes timer type information for type-safe routing.

DeadLetterAlertThresholds

Alert thresholds for dead letter queue monitoring.

DeadLetterException

Exception that wraps dead letter error information.

DeadLetterMessage

Represents a message in the dead letter queue.

DeadLetterStatistics

Statistics about the dead letter queue.

DefaultMappingBuilderTransportExtensions

Transport-specific extension methods for IDefaultMappingBuilder.

DefaultMessageMapper

Default message mapper that copies context properties between transports.

DelegatingTransportReceiver

Base class for transport receiver decorators that delegate to an inner receiver. Follows the DelegatingChatClient pattern from Microsoft.Extensions.AI — all virtual methods forward to the inner receiver. Subclasses override specific methods to add behavior (telemetry, dead-letter routing, etc.).

DelegatingTransportSender

Base class for transport sender decorators that delegate to an inner sender. Follows the DelegatingChatClient pattern from Microsoft.Extensions.AI — all virtual methods forward to the inner sender. Subclasses override specific methods to add behavior (telemetry, ordering, deduplication, etc.).

DelegatingTransportSubscriber

Base class for ITransportSubscriber decorators. All virtual methods forward to the inner subscriber. Subclasses override to add behavior. Follows the DelegatingChatClient pattern from Microsoft.Extensions.AI.

GooglePubSubMappingContext

Google Pub/Sub mapping context implementation.

GrpcMappingContext

gRPC mapping context implementation.

HealthCheckResult

Result of a message bus adapter health check operation.

InMemoryTransportAdapter

In-memory transport adapter for testing and development scenarios.

InMemoryTransportOptions

Configuration options for the in-memory transport adapter.

KafkaMappingContext

Kafka mapping context implementation.

KafkaMessageContext

Kafka-specific message context providing access to Kafka partitioning and offset properties.

KafkaToRabbitMqMapper

Message mapper for converting Kafka messages to RabbitMQ format.

MessageBatch

Represents a batch of messages for processing.

MessageBusOptions

Base class for message bus configuration options, providing common settings for message bus instances.

MessageBusProviderExtensions

Extension methods for IMessageBusProvider.

MessageBusPublishing

Provides common IMessageBus publishing method implementations.

MessageBusRegistration

Default implementation of IMessageBusRegistration.

MessageContextSerializer

Provides serialization and deserialization of message context fields for cloud transport.

MessageMappingBuilderExtensions

Extension methods for IMessageMappingBuilder providing fluent message mapping configuration.

MessageProcessingResult

Result of processing a single message within a batch.

MessageTypeMappingBuilderTransportExtensions

Transport-specific extension methods for IMessageTypeMappingBuilder<TMessage>.

MultiTransportHealthCheckOptions

Configuration options for Excalibur.Dispatch.Transport.MultiTransportHealthCheck.

ProcessingError

Represents a processing error.

ProviderOptions

Base configuration options for cloud providers.

ProviderOptionsValidator

Validates ProviderOptions at startup via the ValidateOnStart pipeline.

RabbitMqMappingContext

RabbitMQ mapping context implementation.

RabbitMqMessageContext

RabbitMQ-specific message context providing access to RabbitMQ routing and delivery properties.

RabbitMqToKafkaMapper

Message mapper for converting RabbitMQ messages to Kafka format.

ReprocessFailure

Represents a failure during reprocessing.

ReprocessOptions

Options for reprocessing dead letter messages.

ReprocessResult

Result of a reprocessing operation.

ScheduleInfo

Represents information about a scheduled message.

SendError

Represents an error that occurred during a message send operation. Replaces PublishError + PublishErrorCategory with a simpler model using IsRetryable and Code instead of an enum.

SendResult

Represents the result of a message send operation. Replaces PublishResult with cleaner naming aligned to the ITransportSender contract.

TransportAdapterHostedService

Hosted service that manages the lifecycle of transport adapters.

TransportAdapterHostedServiceOptions

Configuration options for the transport adapter hosted service.

TransportAdapterRouter

Default implementation of transport adapter router that routes messages through the dispatcher pipeline.

TransportBinding

Default implementation of a transport binding.

TransportConfigurationValidator

Default implementation of ITransportConfigurationValidator that validates transport registrations before startup.

TransportConnectionBase

Abstract base class for transport connections providing TLS security verification.

TransportFactoryRegistration

Registration record for factory-based transport creation.

TransportHealthCheckContext

Context for transport health check operations.

TransportHealthCheckResult

Result of a transport health check operation.

TransportHealthMetrics

Metrics for transport health monitoring.

TransportMessage

Represents a message to be sent via a transport. This is the slim replacement for CloudMessage, following the Microsoft.Extensions.AI minimal-type pattern.

TransportMessageContext

Base implementation of ITransportMessageContext providing transport-agnostic message context.

TransportMeter

Provides OpenTelemetry-compatible metrics for transport adapter operations using System.Diagnostics.Metrics.

TransportOrderingMetadata

Well-known ProviderData keys that carry a transport's native monotonic ordering sequence. They are the one convention a consumer's receive-to-dispatch bridge reads from to stamp the ordering-validation context.

TransportReceivedMessage

Represents a message received from a transport. This is the slim replacement for MessageEnvelope in the transport layer, following the Microsoft.Extensions.AI minimal-type pattern.

TransportRegistration

Represents a transport registration.

TransportRetryPolicyOptions

Retry policy configuration options.

TransportRouterMiddleware

Middleware that validates transport messages and ensures message kinds are accepted by the binding.

TransportSecurityException

Exception thrown when a transport security requirement is not met.

TransportSecurityOptions

Configuration options for transport security.

TransportSettlementException

Exception thrown when message settlement failed or its outcome could not be determined.

TransportValidationOptions

Configuration options for transport startup validation.

Structs

LongPollingStatistics

Statistics for long polling strategy performance.

Interfaces

IAsyncInitializable

Defines a component that supports asynchronous initialization.

IAwsSnsMappingContext

AWS SNS-specific mapping context for configuring message properties.

IAwsSqsMappingContext

AWS SQS-specific mapping context for configuring message properties.

IAzureServiceBusMappingContext

Azure Service Bus-specific mapping context for configuring message properties.

IChannelMessagePump

Defines the contract for a message pump that processes messages from channels.

IChannelReceiver

Defines a channel receiver for consuming messages.

IChannelSender

Defines a channel sender for publishing messages.

ICloudEventEncoder<TOutbound>

Maps a CloudEvent into a provider-specific outbound transport message.

ICronTimerMarker

Marker interface for typed cron timer messages.

IDeadLetterQueueManager

Manages dead letter queue operations for failed messages.

IDefaultMappingBuilder

Builder for configuring default mapping behavior.

IGooglePubSubMappingContext

Google Pub/Sub-specific mapping context for configuring message properties.

IGrpcMappingContext

gRPC-specific mapping context for configuring message properties.

IHealthCheckable

Defines a component that supports health checking.

IKafkaMappingContext

Kafka-specific mapping context for configuring message properties.

ILongPollingStrategy

Defines the contract for long polling strategies that adapt wait times based on message patterns.

ILongPollingStrategyAdmin

Provides administrative operations for a long polling strategy.

IMessageBus

Provides an abstraction for publishing messages to the underlying messaging infrastructure.

IMessageBusAdapter

Interface for message bus adapters that provide transport-specific message delivery capabilities.

IMessageBusAdapterCapabilities

Provides capability metadata for a message bus adapter.

IMessageBusAdapterLifecycle

Sub-interface for message bus adapter lifecycle operations including start, stop, and health checking.

IMessageBusProvider

Provides access to registered message bus instances, both local and remote.

IMessageBusRegistration

Represents a message bus registration that can be resolved at runtime.

IMessageMapper

Defines a mapper that transforms messages between different transport formats.

IMessageMapperRegistry

Registry for message mappers that enables lookup by transport combination.

IMessageMapper<TSource, TTarget>

Defines a typed mapper that transforms messages between specific source and target types.

IMessageMappingBuilder

Fluent builder for configuring message mapping between transports.

IMessageMappingConventions

Provides the conventions context for configuring message mappings.

IMessageScheduler

Defines a service for scheduling messages to be delivered at a future time.

IMessageTypeMappingBuilder<TMessage>

Builder for configuring transport-specific mappings for a message type.

IRabbitMqMappingContext

RabbitMQ-specific mapping context for configuring message properties.

IRemoteMessageBusProvider

Provides access to remote message bus instances. Implementations that support remote buses should implement this interface alongside IMessageBusProvider.

ITransportAdapter

Adapter interface that routes transport messages through the dispatcher pipeline rather than directly to handlers, ensuring all messages flow through IDispatcher.

ITransportAdapterLifecycle

Provides lifecycle management for a transport adapter. Implementations should implement this alongside ITransportAdapter.

ITransportAdapterRouter

Defines the interface for routing messages from transport adapters through the dispatcher.

ITransportBinding

Binding between a transport endpoint and a pipeline profile.

ITransportBindingRouting

Provides routing and matching operations for transport bindings. Implementations should implement this alongside ITransportBinding.

ITransportContextProvider

Provides transport context for incoming messages, enabling pipeline profile selection based on message origin before the pipeline is constructed.

ITransportHealthChecker

Interface for transport health checking.

ITransportHealthMetrics

Provides detailed health metrics for a transport. Implementations should implement this alongside ITransportHealthChecker.

ITransportLifecycleManager

Manages the lifecycle of transport adapters, providing runtime control over individual transports.

ITransportMessageContext

Provides transport-level context for messages being transformed between different message transports.

ITransportReceiver

Defines the minimal interface for receiving messages from a transport source. Replaces the bloated ICloudMessageConsumer (11 methods) with a focused contract (3 methods + GetService).

ITransportRegistry

Registry for managing transport adapters and their configurations.

ITransportSender

Defines the minimal interface for sending messages to a transport destination. Replaces the bloated ICloudMessagePublisher (10 methods) with a focused contract (3 methods + GetService).

ITransportSubscriber

Push-based transport subscription interface.

Unlike ITransportReceiver (pull-based, returns TransportReceivedMessage), this interface pushes messages to a callback handler. Transports with native push semantics (Kafka consumer groups, RabbitMQ BasicConsume, Azure Event Hubs, Google PubSub streaming pull) implement this interface directly.

Follows the same minimal-interface pattern as ITransportSender and ITransportReceiver.

Enums

AccessPermissions

Specifies access permissions for a destination.

AcknowledgmentMode

Defines when messages should be acknowledged.

BatchErrorSeverity

Error severity levels for batch processing operations.

BatchPriority

Batch priority levels.

CloudProviderType

Cloud provider types.

CronTimerCatchUpPolicy

Controls how a CronTimerTransportAdapter handles scheduled occurrences that elapse while a previous execution is still running, or while the host process is paused.

DeadLetterStrategy

Defines strategies for handling messages that cannot be processed.

DestinationType

Specifies the type of messaging destination.

EntityStatus

Represents the status of a messaging entity.

HealthCheckStatus

Health check status enumeration.

MessageAction

Action to take after processing a received message in an ITransportSubscriber handler.

MessagePriority

Message priority levels for publishing operations.

OversizedMessageBehavior

Specifies the behavior when a message is too large for a batch.

PollingStatus

Represents the status of a polling operation.

ScheduleStatus

Represents the status of a scheduled message.

SettlementRetryability

Specifies whether retrying a failed settlement could succeed.

TransportHealthCheckCategory

Categories of health checks for transport components.

TransportHealthStatus

Represents the health status of a transport component.

TransportLocality

Declares whether a registered transport delivers messages within the current process or across a network boundary. The locality is intrinsic registration metadata, supplied explicitly at registration time and validated fail-closed at startup, so an application that requires a network transport cannot silently start with only in-process transports.

TransportRedeliveryExpectation

Specifies whether a message is expected to be redelivered after a failed settlement.

TransportSecurityFailureReason

Specifies the reason for a transport security failure.