Table of Contents

Interface ICronTimerMarker

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

Marker interface for typed cron timer messages.

public interface ICronTimerMarker
Extension Methods

Examples

// 1. Define timer markers (empty structs carry no marker state)
public struct CleanupTimer : ICronTimerMarker { }
public struct DailyReportTimer : ICronTimerMarker { }
public struct HealthCheckTimer : ICronTimerMarker { }

// 2. Register timers with their marker types
services.AddCronTimerTransport<CleanupTimer>("*/5 * * * *");
services.AddCronTimerTransport<DailyReportTimer>("0 0 * * *");
services.AddCronTimerTransport<HealthCheckTimer>("*/30 * * * * *"); // Every 30 seconds

// 3. Create handlers for each timer type
public class CleanupHandler : IMessageHandler<CronTimerTriggerMessage<CleanupTimer>>
{
    public Task HandleAsync(CronTimerTriggerMessage<CleanupTimer> message, ...) { }
}

Remarks

Implement this interface with an empty struct or class to create a typed cron timer. This enables strongly-typed handler routing where each handler only receives events from its specific timer.

Why use typed timers?

Without typed timers, all handlers of CronTimerTriggerMessage receive events from ALL registered timers, requiring manual filtering:

// Without typed timers - BAD: must filter manually
public class CleanupHandler : IMessageHandler<CronTimerTriggerMessage>
{
    public Task HandleAsync(CronTimerTriggerMessage message, ...)
    {
        if (message.TimerName != "cleanup") return Task.CompletedTask; // Ugly!
        // actual work...
    }
}

With typed timers, handlers automatically receive only their specific timer events:

// With typed timers - GOOD: automatic routing
public struct CleanupTimer : ICronTimerMarker { }

public class CleanupHandler : IMessageHandler<CronTimerTriggerMessage<CleanupTimer>> { public Task HandleAsync(CronTimerTriggerMessage<CleanupTimer> message, ...) { // This handler ONLY receives CleanupTimer events - no filtering needed! } }

See Also