Class FireInstanceProgress

Namespace

Quartz.Extensibility

Assembly

Quartz.dll

What a running firing last reported about how far it has got: the value UpdateFireInstanceProgress(string, FireInstanceProgress, CancellationToken) is handed.

public sealed class FireInstanceProgress

Inheritance

object

FireInstanceProgress

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A job reports it through ReportProgress(int, string?), and the scheduler hands it to the store at most once a second per firing, and only when it has changed. A store keeps it beside the firing and answers it on Progress and ProgressMessage.

A context object rather than two parameters, so that the next thing a report carries is a property rather than a new overload.

Fields

MaxMessageLength

The longest Message the scheduler hands on, in UTF-16 code units. A longer one is cut to this, which is what the ADO.NET store's PROGRESS_MESSAGE column holds.

public const int MaxMessageLength = 250

Field Value

int

Remarks

On Firebird, whose PROGRESS_MESSAGE is VARCHAR(250) and counts bytes in a database created without a character set, the ADO.NET store also cuts it to 250 bytes of UTF-8, at a whole character.

Properties

Message

What the job said beside the percentage, or null when it said nothing.

public string? Message { get; init; }

Property Value

string

Percent

How far the firing has got, from 0 to 100.

public required int Percent { get; init; }

Property Value

int