Class ActionTask

A task that executes an Action. Only completion is reported, no intermediate progress.

Inheritance
Object
TaskBase
ActionTask
Implements
Inherited Members
Namespace: NanoByte.Common.Tasks
Assembly: NanoByte.Common.dll
Syntax
public sealed class ActionTask : TaskBase, ITask

Constructors

ActionTask(String, Action, Action)

Creates a new that executes an Action.

Declaration
public ActionTask(string name, Action work, Action cancellationCallback = null)
Parameters
Type Name Description
String name

A name describing the task in human-readable form.
Action work

The code to be executed by the task. May throw WebException, IOException or OperationCanceledException.
Action cancellationCallback

An optional callback to be called when cancellation is requested via a CancellationToken.

Properties

CanCancel

Indicates whether this task can be canceled once it has been started.

Declaration
public override bool CanCancel { get; }
Property Value
Type Description
Boolean
Overrides

Name

A name describing the task in human-readable form.

Declaration
public override string Name { get; }
Property Value
Type Description
String
Overrides

UnitsByte

true if UnitsProcessed and UnitsTotal are measured in bytes; false if they are measured in generic units.

Declaration
protected override bool UnitsByte { get; }
Property Value
Type Description
Boolean
Overrides

Methods

Execute()

The actual code to be executed.

Declaration
protected override void Execute()
Overrides
Remarks

State is automatically set to Started before calling this method, to Complete after a successful exit and to an appropriate error state in case on an exception. You can set additional TaskStates during execution.

Exceptions
Type Condition
OperationCanceledException

The operation was canceled.
IOException

The task ended with IOError.
WebException

The task ended with WebError.

Implements

Extension Methods