class RunningOperation in Tinman.Core.Threading.Operations

Represents a running operation.

sealed class

RunningOperation

extends

Disposable

See also:

IOperation
IProgressMonitor

Public / Attributes

Error

The error that has occurred most recently.

public property	Error { get }
type	TinmanError
value		The error or null.

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Progress

The current progress, in percent.

public property	Progress { get }
type	int32
value	[0..100]	The current progress, in percent.

Thread

Returns the background thread that executes the operation.

public property	Thread { get }
type	Thread
value	[not-null]	The background thread.

TimeElapsed

The elapsed time of the operation, in seconds.

public property	TimeElapsed { get }
type	float64
value		The elapsed time, in seconds.

TimeRemaining

The estimated remaining time of the operation, in seconds.

public property	TimeRemaining { get }
type	float64
value		The remaining time, in seconds.

TimeTotal

The estimated total time of the operation, in seconds.

public property	TimeTotal { get }
type	float64
value		The total time, in seconds.

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Cancel

Calls Cancel on the running background operation, signalling it to stop as soon as possible.

public method

Cancel ()

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Update

Updates the progress values.

public method	Update ()
type	bool
returns			true if the operation is running, false if the operation has finished or an error has occurred.