Class DispatchBuilder
- Namespace
- Excalibur.Dispatch.Configuration
- Assembly
- Excalibur.Dispatch.dll
Fluent builder for configuring the Excalibur framework.
public sealed class DispatchBuilder : IDispatchBuilder, IDisposable
- Inheritance
-
DispatchBuilder
- Implements
- Inherited Members
- Extension Methods
-
DispatchBuilderAwsSqsExtensions.UseAwsSqs(IDispatchBuilder, string, Action<IAwsSqsTransportBuilder>)DispatchBuilderExtensions.AddHandlersFromAssembly(IDispatchBuilder, Assembly, ServiceLifetime, bool)
Constructors
DispatchBuilder(IServiceCollection)
Initializes a new instance of the DispatchBuilder class. Creates a new Dispatch builder.
public DispatchBuilder(IServiceCollection services)
Parameters
servicesIServiceCollection
Properties
Services
Gets the service collection for dependency registration.
public IServiceCollection Services { get; }
Property Value
- IServiceCollection
The DI service collection used to register Dispatch services.
Methods
AddBinding(Action<IBindingConfigurationBuilder>)
Adds a transport binding.
public IDispatchBuilder AddBinding(Action<IBindingConfigurationBuilder> configure)
Parameters
configureAction<IBindingConfigurationBuilder>Configuration action for the binding.
Returns
- IDispatchBuilder
The builder for fluent configuration.
ConfigureOptions<TOptions>(Action<TOptions>)
Configures options for the Excalibur framework.
public IDispatchBuilder ConfigureOptions<TOptions>(Action<TOptions> configure) where TOptions : class
Parameters
configureAction<TOptions>Configuration action for options.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Type Parameters
TOptionsThe options type.
ConfigurePipeline(string, Action<IPipelineBuilder>)
Configures a pipeline with the specified name.
public IDispatchBuilder ConfigurePipeline(string name, Action<IPipelineBuilder> configure)
Parameters
namestringThe pipeline name.
configureAction<IPipelineBuilder>Configuration action for the pipeline.
Returns
- IDispatchBuilder
The builder for fluent configuration.
Dispose()
Disposes the builder and releases the binding registry.
public void Dispose()
RegisterProfile(IPipelineProfile)
Registers a pipeline profile.
public IDispatchBuilder RegisterProfile(IPipelineProfile profile)
Parameters
profileIPipelineProfileThe profile to register.
Returns
- IDispatchBuilder
The builder for fluent configuration.
UseMiddleware<TMiddleware>()
Adds global middleware to all pipelines.
public IDispatchBuilder UseMiddleware<TMiddleware>() where TMiddleware : IDispatchMiddleware
Returns
- IDispatchBuilder
The builder for fluent configuration.
Type Parameters
TMiddlewareThe 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.
WithOptions(Action<DispatchOptions>)
Configures dispatch options using a fluent API.
public IDispatchBuilder WithOptions(Action<DispatchOptions> configure)
Parameters
configureAction<DispatchOptions>Configuration action for dispatch options.
Returns
- IDispatchBuilder
The builder for chaining.
WithPipelineProfiles(Action<IPipelineProfilesConfigurationBuilder>)
Configures pipeline profiles using a fluent API.
public IDispatchBuilder WithPipelineProfiles(Action<IPipelineProfilesConfigurationBuilder> configure)
Parameters
configureAction<IPipelineProfilesConfigurationBuilder>Configuration action for pipeline profiles.
Returns
- IDispatchBuilder
The builder for chaining.