ITaskVoid

Description

interface Tinman.Core.Threading.Pooling.ITaskVoid → <TInput>

Base interface for one-time background tasks that do not have a return value.

[ThrowAny]
public method PerformTask → (1)

Performs the actual task work.

If this method throws an exception, it will be wrapped; a PoolingException will then be thrown when TaskResultVoid.Finish is called.

[ThreadSafe]
public method Schedule → (4)

input ⁱⁿ : TInput: The input data object.
group ^opt : TaskGroup = null: Optional task group (will override ITaskBase.Group if not null).
onCancel ^opt : TaskCancelDelegate<TInput> = null: Optional delegate to call when the task is cancelled (will override OnCancel if not null).
onException ^opt : TaskExceptionDelegate<TInput> = null: Optional task exception callback delegate (will override OnException if not null).
returns → TaskResultVoid: The task result object.

Schedules this task for execution using the given input data.

[ThreadSafe]
public method ScheduleNoResult → (4)

input ⁱⁿ : TInput: The input data object.
group ^opt : TaskGroup = null: Optional task group (will override ITaskBase.Group if not null).
onCancel ^opt : TaskCancelDelegate<TInput> = null: Optional delegate to call when the task is cancelled (will override OnCancel if not null).
onException ^opt : TaskExceptionDelegate<TInput> = null: Optional task exception callback delegate (will override OnException if not null).

Schedules this task for execution using the given input data.

public attribute OnCancel → (get,set)

The task cancel delegate to use.

This is the default cancel delegate. It can optionally be overwritten when this task is scheduled.

public attribute OnException → (get,set)

value : TaskExceptionDelegate<TInput>: The task exception delegate or null.

The task exception delegate to use.

This is the default exception delegate. It can optionally be overwritten when this task is scheduled.