Table of Contents

Class TimeAwareSchedulerOptions

Namespace
Excalibur.Dispatch.Options.Scheduling
Assembly
Excalibur.Dispatch.dll

Enhanced scheduler options with integrated TimePolicy configuration for time-aware scheduled message processing. Configurable timeout handling with adaptive capabilities for scheduled message operations.

public sealed class TimeAwareSchedulerOptions
Inheritance
TimeAwareSchedulerOptions
Inherited Members
Extension Methods

Fields

SectionName

The configuration section name for time-aware scheduler options.

public const string SectionName = "Dispatch:TimeAwareScheduler"

Field Value

string

Properties

Adaptive

Gets or sets adaptive and escalation configuration for timeout behavior.

public SchedulerAdaptiveOptions Adaptive { get; set; }

Property Value

SchedulerAdaptiveOptions

The adaptive sub-options.

ComplexOperationMultiplier

Gets or sets the complexity multiplier for complex scheduling operations. Default: 1.5.

[Range(1, 3)]
public double ComplexOperationMultiplier { get; set; }

Property Value

double

The complexity multiplier for complex scheduling operations.

HeavyOperationMultiplier

Gets or sets the complexity multiplier for heavy scheduling operations. Default: 2.0.

[Range(1, 5)]
public double HeavyOperationMultiplier { get; set; }

Property Value

double

The complexity multiplier for heavy scheduling operations.

MessageTypeSchedulingTimeouts

Gets custom timeout overrides for specific message types during scheduling. Key format: "Namespace.MessageTypeName".

public Dictionary<string, TimeSpan> MessageTypeSchedulingTimeouts { get; }

Property Value

Dictionary<string, TimeSpan>

The current MessageTypeSchedulingTimeouts value.

PastScheduleBehavior

Gets or sets determines how messages scheduled in the past are handled.

public PastScheduleBehavior PastScheduleBehavior { get; set; }

Property Value

PastScheduleBehavior

The current PastScheduleBehavior value.

PollInterval

Gets or sets how often the scheduler checks for messages to dispatch.

public TimeSpan PollInterval { get; set; }

Property Value

TimeSpan

How often the scheduler checks for messages to dispatch.

Timeouts

Gets or sets timeout configuration for scheduling operations.

public SchedulerTimeoutOptions Timeouts { get; set; }

Property Value

SchedulerTimeoutOptions

The timeout sub-options.

Methods

ApplyComplexityMultiplier(TimeSpan, OperationComplexity)

Applies complexity multiplier to the base timeout for scheduling operations.

public TimeSpan ApplyComplexityMultiplier(TimeSpan baseTimeout, OperationComplexity complexity)

Parameters

baseTimeout TimeSpan

The base timeout value.

complexity OperationComplexity

The operation complexity level.

Returns

TimeSpan

The timeout adjusted for complexity.

GetTimeoutFor(TimeoutOperationType)

Gets the timeout configuration for a specific operation type in scheduling context.

public TimeSpan GetTimeoutFor(TimeoutOperationType operationType)

Parameters

operationType TimeoutOperationType

The timeout operation type.

Returns

TimeSpan

The configured timeout for the operation type.

GetTimeoutForMessageType(Type, TimeoutOperationType)

Gets the timeout for a specific message type during scheduling, applying message-specific overrides if configured.

public TimeSpan GetTimeoutForMessageType(Type messageType, TimeoutOperationType operationType)

Parameters

messageType Type

The message type.

operationType TimeoutOperationType

The operation type.

Returns

TimeSpan

The timeout for the message type during scheduling.

Validate()

Validates the time-aware scheduler configuration options.

public IEnumerable<ValidationResult> Validate()

Returns

IEnumerable<ValidationResult>

A collection of validation results.