Table of Contents

Interface IDispatchBuilder

Namespace
Excalibur.Dispatch.Configuration
Assembly
Excalibur.Dispatch.Abstractions.dll

Fluent builder interface for configuring the Excalibur framework.

public interface IDispatchBuilder
Extension Methods

Properties

Services

Gets the service collection for dependency registration.

IServiceCollection Services { get; }

Property Value

IServiceCollection

The DI service collection used to register Dispatch services.

Methods

AddBinding(Action<IBindingConfigurationBuilder>)

Adds a transport binding.

IDispatchBuilder AddBinding(Action<IBindingConfigurationBuilder> configure)

Parameters

configure Action<IBindingConfigurationBuilder>

Configuration action for the binding.

Returns

IDispatchBuilder

The builder for fluent configuration.

ConfigureOptions<TOptions>(Action<TOptions>)

Configures options for the Excalibur framework.

IDispatchBuilder ConfigureOptions<TOptions>(Action<TOptions> configure) where TOptions : class

Parameters

configure Action<TOptions>

Configuration action for options.

Returns

IDispatchBuilder

The builder for fluent configuration.

Type Parameters

TOptions

The options type.

ConfigurePipeline(string, Action<IPipelineBuilder>)

Configures a pipeline with the specified name.

IDispatchBuilder ConfigurePipeline(string name, Action<IPipelineBuilder> configure)

Parameters

name string

The pipeline name.

configure Action<IPipelineBuilder>

Configuration action for the pipeline.

Returns

IDispatchBuilder

The builder for fluent configuration.

RegisterProfile(IPipelineProfile)

Registers a pipeline profile.

IDispatchBuilder RegisterProfile(IPipelineProfile profile)

Parameters

profile IPipelineProfile

The profile to register.

Returns

IDispatchBuilder

The builder for fluent configuration.

UseMiddleware<TMiddleware>()

Adds global middleware to all pipelines.

IDispatchBuilder UseMiddleware<TMiddleware>() where TMiddleware : IDispatchMiddleware

Returns

IDispatchBuilder

The builder for fluent configuration.

Type Parameters

TMiddleware

The middleware type.

Examples

// Simple configuration - creates a default pipeline automatically
builder.Services.AddDispatch(dispatch =>
{
    dispatch.AddHandlersFromAssembly(typeof(Program).Assembly);
    dispatch.UseMiddleware<LoggingMiddleware>();
    dispatch.UseMiddleware<ValidationMiddleware>();
});

Remarks

Global middleware registered via this method is added to all pipelines, including any auto-created default pipeline.

If no explicit pipelines are configured via ConfigurePipeline(string, Action<IPipelineBuilder>), Dispatch automatically creates a "Default" pipeline containing all middleware registered through this method. This allows simple configurations without explicit pipeline setup.