Class TriggerFiredResult

Namespace

Quartz.Extensibility

Assembly

Quartz.dll

What became of one trigger in a TriggersFired(IReadOnlyCollection<IOperableTrigger>, CancellationToken) batch.

public sealed class TriggerFiredResult

Inheritance

object

TriggerFiredResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Exactly one of four things happened to each trigger the scheduler asked the store to fire, and the four factories are the only way to say so: it fired and there is a bundle to run (Fired(TriggerFiredBundle)), it turned out not to be firable after all — paused, blocked, removed, or the scheduler halted underneath it — and there is nothing to run and nothing wrong (NotFired), its overlap policy declined the firing and the store settled the trigger itself (Declined), or firing it failed (Failed(Exception)). A result carrying both a bundle and an exception, or claiming a failure with no exception, cannot be constructed.

Properties

Declined

The trigger did not fire, and the store has already put it where it belongs: it skipped the firing, or held the trigger back until an earlier firing of it ends. The scheduler neither runs nor releases anything.

public static TriggerFiredResult Declined { get; }

Property Value

TriggerFiredResult

Remarks

The answer to a firing its trigger's OverlapPolicy declined. Unlike NotFired, the store has released the acquisition itself, and a release by the scheduler would undo what it decided.

Exception

Why firing failed; null when it did not.

public Exception? Exception { get; }

Property Value

Exception

IsDeclined

Whether this is Declined: not fired, and already settled by the store.

public bool IsDeclined { get; }

Property Value

bool

NotFired

The trigger did not fire, and nothing went wrong. The scheduler releases it and carries on.

public static TriggerFiredResult NotFired { get; }

Property Value

TriggerFiredResult

Remarks

This is the answer for a trigger that was paused, blocked by a DisallowConcurrentExecutionAttribute sibling, or removed between acquisition and firing, and for every trigger in a batch a halted scheduler never got to.

TriggerFiredBundle

What to run, when the trigger fired; null otherwise.

public TriggerFiredBundle? TriggerFiredBundle { get; }

Property Value

TriggerFiredBundle

Methods

Failed(Exception)

Firing the trigger failed. The scheduler releases the trigger, reporting the exception.

public static TriggerFiredResult Failed(Exception exception)

Parameters

exception Exception

Returns

TriggerFiredResult

Fired(TriggerFiredBundle)

The trigger fired: triggerFiredBundle is what the scheduler is to run.

public static TriggerFiredResult Fired(TriggerFiredBundle triggerFiredBundle)

Parameters

triggerFiredBundle TriggerFiredBundle

Returns

TriggerFiredResult