Table of Contents

Class DispatchOptions

Namespace
Excalibur.Dispatch.Options.Configuration
Assembly
Excalibur.Dispatch.dll

Configuration options for the Excalibur framework.

public sealed class DispatchOptions
Inheritance
DispatchOptions
Inherited Members
Extension Methods

Properties

Consumer

Gets or sets consumer configuration options.

public ConsumerOptions Consumer { get; set; }

Property Value

ConsumerOptions

Consumer configuration options.

CrossCutting

Gets or sets cross-cutting concern configuration (security, observability, resilience, caching, performance).

public DispatchCrossCuttingOptions CrossCutting { get; set; }

Property Value

DispatchCrossCuttingOptions

The cross-cutting sub-options.

DefaultTimeout

Gets or sets the default timeout for message processing.

public TimeSpan DefaultTimeout { get; set; }

Property Value

TimeSpan

The default timeout for message processing.

EnablePipelineSynthesis

Gets or sets a value indicating whether to synthesize pipeline profiles from the enabled feature set when no profile has been registered.

This setting currently has no observable effect, in either position. Profile synthesis is guarded on no profile being registered, and the profile registry registers six default profiles in its constructor, so that condition never holds and synthesis does not run whether this is true or false. Setting it changes nothing about the pipelines your host builds. It is documented here rather than silently, because the property is part of the shipped surface and reads as a feature switch.

public bool EnablePipelineSynthesis { get; set; }

Property Value

bool

The current EnablePipelineSynthesis value.

Features

Gets or sets feature flag configuration for optional Dispatch capabilities.

public DispatchFeatureOptions Features { get; set; }

Property Value

DispatchFeatureOptions

The feature flag sub-options.

Inbox

Gets or sets inbox configuration options.

public InboxConfigurationOptions Inbox { get; set; }

Property Value

InboxConfigurationOptions

Inbox configuration options.

MaxConcurrency

Gets or sets the maximum concurrent messages to process.

[Range(1, 2147483647)]
public int MaxConcurrency { get; set; }

Property Value

int

The current MaxConcurrency value.

MessageBufferSize

Gets or sets the message buffer size for pooling.

[Range(1, 2147483647)]
public int MessageBufferSize { get; set; }

Property Value

int

The current MessageBufferSize value.

Outbox

Gets or sets outbox configuration options.

public OutboxConfigurationOptions Outbox { get; set; }

Property Value

OutboxConfigurationOptions

Outbox configuration options.

UseLightMode

Gets or sets a value indicating whether to use light mode (no persistence).

public bool UseLightMode { get; set; }

Property Value

bool

The current UseLightMode value.