Table of Contents

Class CronTimerTransportAdapterOptions

Namespace
Excalibur.Dispatch.Transport
Assembly
Excalibur.Dispatch.dll

Configuration options for the cron timer transport adapter.

public sealed class CronTimerTransportAdapterOptions
Inheritance
CronTimerTransportAdapterOptions
Inherited Members
Extension Methods

Properties

CatchUpPolicy

Gets or sets the policy controlling how occurrences that elapse while an execution is running (or while the host is paused) are handled.

public CronTimerCatchUpPolicy CatchUpPolicy { get; set; }

Property Value

CronTimerCatchUpPolicy

The catch-up policy. Default is Skip, which drops missed occurrences and resumes at the next future occurrence.

CronExpression

Gets or sets the cron expression for scheduling.

public string CronExpression { get; set; }

Property Value

string

The cron expression string.

Remarks

Supports both 5-field (minute-level) and 6-field (second-level) cron expressions. Examples:

  • "0 * * * *" - Every hour at minute 0
  • "*/5 * * * *" - Every 5 minutes
  • "0 0 * * *" - Daily at midnight
  • "0 0 0 * * *" - Daily at midnight (6-field with seconds)

MaxCatchUpOccurrences

Gets or sets the maximum number of missed occurrences fired in a single catch-up pass when CatchUpPolicy is FireAll.

public int MaxCatchUpOccurrences { get; set; }

Property Value

int

The upper bound on catch-up fires per pass. Default is 100. Bounding prevents a thundering herd of triggers after a long pause.

Name

Gets or sets the name of this transport adapter instance.

public string? Name { get; set; }

Property Value

string

The transport name. Default is "CronTimer".

PreventOverlap

Gets or sets a value indicating whether to prevent overlapping executions.

public bool PreventOverlap { get; set; }

Property Value

bool

true to skip runs when a previous execution is still active. Default is true.

RunOnStartup

Gets or sets a value indicating whether to run the timer immediately on startup.

public bool RunOnStartup { get; set; }

Property Value

bool

true to trigger on startup; otherwise, false.

TimeZone

Gets or sets the time zone for the cron expression.

public TimeZoneInfo TimeZone { get; set; }

Property Value

TimeZoneInfo

The time zone used when evaluating the cron schedule. Default is UTC.