interface IProgressMonitor in Tinman.Core.Threading.Operations

A IProgressMonitor object tracks the progress of a running operation.

interface

IProgressMonitor

base of

ProgressMonitor

Methods

Error

Signals that a critical error has occurred and the operation has stopped.

method	Error (TinmanError errorInfo)
params	errorInfo	[not-null]	The error info object.

TicksFinished

The running operation has finished ticks tick units.

method	TicksFinished (int64 ticks)
params	ticks	[>=0]	The number of finished tick units.

Remarks:

Finished ticks should be reported only from within Run method.

TicksPending

The running operation will last for another ticks tick units.

method	TicksPending (int64 ticks)
params	ticks	[>=0]	The number of upcoming tick units.

Remarks:

Upcoming ticks should be reported as soon as possible in order to provide a believable progress indication.

Extensions

Normalize

Returns a progress monitor that will report its progress as a normalized value to this progress monitor.

method	Normalize (int32 ticks)
type	IProgressMonitor
params	ticks	[>=0]	The total number of ticks to report to this progress monitor.
returns		[not-null]	The normalizing progress monitor.