QuartzSchedulerInterrupt Method (String, CancellationToken)

Quartz.NET 3.0 API Documentation
Interrupt all instances of the identified InterruptableJob executing in this Scheduler instance.

Namespace:  Quartz.Core
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
Copy
public Task<bool> Interrupt(
	string fireInstanceId,
	CancellationToken cancellationToken = null
)

Parameters

fireInstanceId
Type: SystemString
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation instruction.

Return Value

Type: TaskBoolean

[Missing <returns> documentation for "M:Quartz.Core.QuartzScheduler.Interrupt(System.String,System.Threading.CancellationToken)"]

Implements

IRemotableQuartzSchedulerInterrupt(String, CancellationToken)
Remarks
This method is not cluster aware. That is, it will only interrupt instances of the identified InterruptableJob currently executing in this Scheduler instance, not across the entire cluster.
See Also

Reference

QuartzScheduler Class
Interrupt Overload
Quartz.Core Namespace
IRemotableQuartzSchedulerInterrupt(JobKey, CancellationToken)