ITaskVoid

Description

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

Derived from

ITaskBase

Extended by

TaskVoid abstract

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

Public / Methods

Perform​Task


[ThrowAny]
public method PerformTask → (1)

input in : TInput

The input data.

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.

Schedule


[ThreadSafe]
public method Schedule → (4)

input in : 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.

Schedule​No​Result


[ThreadSafe]
public method ScheduleNoResult → (4)

input in : 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 / Attributes

On​Cancel


public attribute OnCancel → (get,set)

value : TaskCancelDelegate<TInput>

The task cancel delegate or null.

The task cancel delegate to use.

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

On​Exception


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.