Base interface for one-time background tasks that do not have a return value.
interface
|
ITaskVoid
|
with
|
<TInput>
|
||
extends
|
ITaskBase
|
||||
base of
|
TaskVoid
|
The task flags.
property
|
Flags
{
get
}
|
||
type
|
TaskFlags
|
||
value
|
The task flags. | ||
inherited
|
ITaskBase.Flags
|
The group this task belongs to.
property
|
Group
{
get
set
}
|
||
type
|
TaskGroup
|
||
value
|
The
task
group
or
null
to
use
the
default
task
group. |
||
inherited
|
ITaskBase.Group
|
Human-readable name of this task.
property
|
Name
{
get
}
|
||
type
|
string
|
||
value
|
|
The task name. | |
inherited
|
ITaskBase.Name
|
Remarks:
The name is primarily used for error reporting.
The task cancel delegate to use.
property
|
OnCancel
{
get
set
}
|
||
type
|
TaskCancelDelegate<TInput>
|
||
value
|
The
task
cancel
delegate
or
null . |
Remarks:
This is the default cancel delegate. It can optionally be overwritten when this task is scheduled.
The task exception delegate to use.
property
|
OnException
{
get
set
}
|
||
type
|
TaskExceptionDelegate<TInput>
|
||
value
|
The
task
exception
delegate
or
null . |
Remarks:
This is the default exception delegate. It can optionally be overwritten when this task is scheduled.
Performs the actual task work.
method
|
PerformTask
(TInput input)
|
||
params
|
input
|
The input data. | |
returns
|
The task output data object. |
Schedules this task for execution using the given input data.
[ThreadSafe]
|
||||
method
|
Schedule
(TInput input,
TaskGroup group = null,
TaskCancelDelegate<TInput> onCancel = null,
TaskExceptionDelegate<TInput> onException = null)
|
|||
type
|
TaskResultVoid
|
|||
params
|
input
|
The input data object. | ||
group
|
Optional
task
group
(will
override
Group
if
not
null ).
Defaults
to
null .
|
|||
onCancel
|
Optional
delegate
to
call
when
the
task
is
cancelled
(will
override
OnCancel
if
not
null ).
Defaults
to
null .
|
|||
onException
|
Optional
task
exception
callback
delegate
(will
override
OnException
if
not
null ).
Defaults
to
null .
|
|||
returns
|
|
The task result object. |
Schedules this task for execution using the given input data.
[ThreadSafe]
|
||||
method
|
ScheduleNoResult
(TInput input,
TaskGroup group = null,
TaskCancelDelegate<TInput> onCancel = null,
TaskExceptionDelegate<TInput> onException = null)
|
|||
params
|
input
|
The input data object. | ||
group
|
Optional
task
group
(will
override
Group
if
not
null ).
Defaults
to
null .
|
|||
onCancel
|
Optional
delegate
to
call
when
the
task
is
cancelled
(will
override
OnCancel
if
not
null ).
Defaults
to
null .
|
|||
onException
|
Optional
task
exception
callback
delegate
(will
override
OnException
if
not
null ).
Defaults
to
null .
|