class TaskResultVoid in Tinman.Core.Threading.Pooling

abstract class

TaskResultVoid

extends

TaskResultBase

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.
inherited	TaskResultBase.Exception

HasFinished

Has the task finished?

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

TimePerform

Time span of actual task execution.

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

TimeSchedule

Time span between scheduling and finishing.

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

Public / Methods

Finish

Waits for the task to finish.

public abstract method	Finish (bool throwOnCancel = true)
params	throwOnCancel		Throw a PoolingException if the task has been cancelled? Defaults to true.

Remarks:

For properly ending a task, the Finish method must be called exactly once, because after the call the TaskResultVoid object is recycled and might be used again for another task.

If the task has already finished, the method immediately returns (in case of success) or throws a PoolingException (in case of failure).

See also:

TaskResultBase.Wait

Exceptions:

• PoolingException:
  If the task has thrown an exception.

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.
inherited	TaskResultBase.Wait

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:

Finish
TaskResult.Finish

Protected / Attributes

exception

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

protected field	exception
type	TinmanError
inherited	TaskResultBase.exception

Protected / Methods

NotifyFinished

protected virtual method	NotifyFinished ()
inherited	TaskResultBase.NotifyFinished

Logging

Logger

The logger object of this class.

public static readonly field	Logger
type	ILogger