class TaskResultBase in Tinman.Core.Threading.Pooling

Abstract base class for all classes that represent the result of a pending task execution.

abstract class	TaskResultBase	base of	TaskResult
			TaskResultVoid

Public / Attributes

Exception

Error information about the exception that has occurred during the task execution.

public property	Exception { get }
type	TinmanError
value		The error information object or null if the task has finished without errors.

HasFinished

Has the task finished?

public property	HasFinished { get }
type	bool
value		true if the task has finished, false if it is still pending.

TimePerform

Time span of actual task execution.

public property	TimePerform { get }
type	float32
value	[>=0]	The time span, in seconds.

TimeSchedule

Time span between scheduling and finishing.

public property	TimeSchedule { get }
type	float32
value	[>=0]	The time span, in seconds.

Public / Methods

Wait

Waits for the task to finish.

[ThreadSafe]
public method	Wait (int32 timeout = 0)
type	bool
params	timeout	[>=0]	The timeout in milliseconds. If 0, the method immediately returns.
returns			true if the task has finished, false if it is still pending.

Remarks:

For properly ending a task, the Finish method (see below) must be called. The task result object and exception information can be obtained then. When Wait returns true, calling the Finish method will not block; it will otherwise.

See also:

TaskResultVoid.Finish
TaskResult.Finish

Protected / Constants

ErrorCancel

Special TinmanError object that is used when a task has been cancelled by the user.

protected static readonly field	ErrorCancel
type	TinmanError

Protected / Attributes

exception

Error information about the exception that has occurred during the task execution.

protected field	exception
type	TinmanError

Protected / Methods

NotifyFinished

protected virtual method

NotifyFinished ()