Class CronTimerTriggerMessage<TTimer>
Generic cron timer trigger message that includes timer type information for type-safe routing.
[MessageName("Excalibur.Dispatch.CronTimerTriggerMessage")]
public record CronTimerTriggerMessage<TTimer> : CronTimerTriggerMessage, IDispatchEvent, IDispatchMessage, IEquatable<CronTimerTriggerMessage>, IEquatable<CronTimerTriggerMessage<TTimer>> where TTimer : ICronTimerMarker
Type Parameters
TTimerThe timer marker type.
- Inheritance
-
CronTimerTriggerMessage<TTimer>
- Implements
-
IEquatable<CronTimerTriggerMessage<TTimer>>
- Inherited Members
- Extension Methods
Examples
// Define a timer marker
public struct HourlyCleanupTimer : ICronTimerMarker { }
// Register the timer
services.AddCronTimerTransport<HourlyCleanupTimer>("0 * * * *");
// Handler receives ONLY HourlyCleanupTimer events
public class HourlyCleanupHandler : IMessageHandler<CronTimerTriggerMessage<HourlyCleanupTimer>>
{
public Task HandleAsync(
CronTimerTriggerMessage<HourlyCleanupTimer> message,
IDispatchContext context,
CancellationToken cancellationToken)
{
// No need to check TimerName - this handler only gets HourlyCleanupTimer events
Console.WriteLine($"Timer type: {message.TimerType.Name}"); // "HourlyCleanupTimer"
return Task.CompletedTask;
}
}
Remarks
This generic message type enables type-safe handler routing. When you register
a cron timer with AddCronTimerTransport<TTimer>, the dispatcher
automatically routes messages only to handlers of CronTimerTriggerMessage<TTimer>.
This eliminates the need for manual timer name filtering in handlers.
Properties
TimerType
Gets the marker type for this timer.
public Type TimerType { get; }
Property Value
Remarks
This property provides runtime access to the timer marker type, useful for logging, diagnostics, or generic processing scenarios.