Represents a job execution context which can be cancelled.
Namespace: Quartz
Assembly: Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
public interface ICancellableJobExecutionContext : IJobExecutionContext
The ICancellableJobExecutionContext type exposes the following members.
Properties
Name | Description | |
---|---|---|
Calendar | (Inherited from IJobExecutionContext.) | |
CancellationToken |
Returns the cancellation token which will be cancelled when the job cancellation has been requested via
Interrupt(JobKey, CancellationToken)
or Interrupt(String, CancellationToken).
(Inherited from IJobExecutionContext.) | |
FireInstanceId |
Get the unique Id that identifies this particular firing instance of the
trigger that triggered this job execution. It is unique to this
JobExecutionContext instance as well.
(Inherited from IJobExecutionContext.) | |
FireTimeUtc |
The actual time the trigger fired. For instance the scheduled time may
have been 10:00:00 but the actual fire time may have been 10:00:03 if
the scheduler was too busy.
(Inherited from IJobExecutionContext.) | |
JobDetail | (Inherited from IJobExecutionContext.) | |
JobInstance |
Get the instance of the IJob that was created for this
execution.
(Inherited from IJobExecutionContext.)Note: The Job instance is not available through remote scheduler interfaces. | |
JobRunTime |
The amount of time the job ran for. The returned
value will be MinValue until the job has actually completed (or thrown an
exception), and is therefore generally only useful to
IJobListeners and ITriggerListeners.
(Inherited from IJobExecutionContext.) | |
MergedJobDataMap |
Get the convenience JobDataMap of this execution context.
(Inherited from IJobExecutionContext.) | |
NextFireTimeUtc |
Gets the next fire time.
(Inherited from IJobExecutionContext.) | |
PreviousFireTimeUtc |
Gets the previous fire time.
(Inherited from IJobExecutionContext.) | |
Recovering |
If the IJob is being re-executed because of a 'recovery'
situation, this method will return .
(Inherited from IJobExecutionContext.) | |
RecoveringTriggerKey |
Returns the TriggerKey of the originally scheduled and now recovering job.
(Inherited from IJobExecutionContext.) | |
RefireCount |
Gets the refire count.
(Inherited from IJobExecutionContext.) | |
Result |
Returns the result (if any) that the IJob set before its
execution completed (the type of object set as the result is entirely up
to the particular job).
(Inherited from IJobExecutionContext.) | |
ScheduledFireTimeUtc |
The scheduled time the trigger fired for. For instance the scheduled
time may have been 10:00:00 but the actual fire time may have been
10:00:03 if the scheduler was too busy.
(Inherited from IJobExecutionContext.) | |
Scheduler |
Get a handle to the IScheduler instance that fired the
IJob.
(Inherited from IJobExecutionContext.) | |
Trigger | (Inherited from IJobExecutionContext.) |
Methods
Name | Description | |
---|---|---|
Cancel |
Cancels the execution of the job. It is the responsibility of the job instance to observe the cancellation token if it can be cancelled.
| |
Get |
Get the value with the given key from the context's data map.
(Inherited from IJobExecutionContext.) | |
Put |
Put the specified value into the context's data map with the given key.
Possibly useful for sharing data between listeners and jobs.
(Inherited from IJobExecutionContext.)NOTE: this data is volatile - it is lost after the job execution completes, and all TriggerListeners and JobListeners have been notified. |
See Also