Class Options

Options for configuring the command system

Inheritance

System.Object

Options

Implements

IOptions

Namespace: AzureFromTheTrenches.Commanding

Assembly: AzureFromTheTrenches.Commanding.dll

Syntax

public class Options : object, IOptions

Constructors

Options()

Sets defaults

Declaration

public Options()

Properties

AuditItemEnricherFactoryFunc

By default audit item enrichers are created through the dependency resolver but if a function is assigned to the AuditItemEnricherFactoryFunc property then that function will be used to instantiate an enricher

Declaration

public Func<Type, IAuditItemEnricher> AuditItemEnricherFactoryFunc { get; set; }

Property Value

Type	Description
Func<Type, IAuditItemEnricher>

CommandExecutionExceptionHandler

Can be used to register a type that implements the ICommandExecutionExceptionHandler interface that will be invoked in the event of an execution error

Declaration

public Type CommandExecutionExceptionHandler { get; set; }

Property Value

Type	Description
Type

CommandHandlerContainerRegistration

Unless an alternative implementation of ICommandHandlerFactory is supplied or the CommandHandlerFactoryFunc in this options class is set then actors are created through the dependency resolver but not all IoC containers can resolve unregistered concrete types (for example the built in ASP.Net Core IServiceCollection and IServiceProvider IoC cannot). Where this is the case supply an implementation for the CommandHandlerContainerRegistration action that registers the actors in the container. For example using an IServiceCollection instance of serviceCollection: var options = new Options() { CommandHandlerContainerRegistration = type => services.AddTransient(type, type) };

Declaration

public Action<Type> CommandHandlerContainerRegistration { get; set; }

Property Value

Type	Description
Action<Type>

CommandHandlerFactoryFunc

By default actors are created through the dependency resolver but if a function is assigned to the CommandHandlerFactoryFunc property then that function will be called to instantiate an handler.

Declaration

public Func<Type, object> CommandHandlerFactoryFunc { get; set; }

Property Value

Type	Description
Func<Type, System.Object>

DisableCorrelationIds

Setting this to true will disable all correlatin ID generation which can give a small performance boost in super-low latency situations.

Declaration

public bool DisableCorrelationIds { get; set; }

Property Value

Type	Description
System.Boolean

Enrichers

It can be useful to include additional properties in the command context, for example the Application Insights Operation ID. This can be done by setting this property to a set of enrichment objects - these are called in sequence and are passed the current state of the command contexts enriched properties and can return a dictionary of properties to insert. If the returned dictionary contains a property that already exists it will be replaced in the command context property bag.

Declaration

public IEnumerable<ICommandDispatchContextEnricher> Enrichers { get; set; }

Property Value

Type	Description
IEnumerable<ICommandDispatchContextEnricher>

MetricCollectionEnabled

Set to true to gather timing metrics around command dispatch and execution. Note this has a minor performance implication in high throughput environments.

Declaration

public bool MetricCollectionEnabled { get; set; }

Property Value

Type	Description
System.Boolean

Reset

The commanding system maintains command registrations, command context enrichers, and auditors between calls to UseCommanding to enable sub-modules to extend the system without any awareness / tight coupling between them. If you want to force a reset of the shared state then set this property to true (generally this is only useful in sample apps where you might repeatedly recreate and reconfigure an IoC container as the included samples do.

Declaration

public bool Reset { get; set; }

Property Value

Type	Description
System.Boolean

UseLocallyUniqueCorrelationIds

By default correlation IDs will be generated as GUIDs so that they are unique across as distributed system however if performance is key a local;y unique (incrementing long, thread safe) correlation ID can be used by setting this to true

Declaration

public bool UseLocallyUniqueCorrelationIds { get; set; }

Property Value

Type	Description
System.Boolean

Implements

IOptions