Class ActionTask

Namespace

NanoByte.Common.Tasks

Assembly

NanoByte.Common.dll

A task that executes an System.Action that can be canceled. Only completion is reported, no intermediate progress.

public sealed class ActionTask : TaskBase, ITask

Inheritance

object

MarshalByRefObject

TaskBase

ActionTask

Implements

ITask

Inherited Members

TaskBase.Tag

TaskBase.Run(CancellationToken, ICredentialProvider, IProgress<TaskSnapshot>)

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

UpdateUtils.To<T>(T, ref T, Action)

UpdateUtils.To<T>(T, ref T, ref bool)

UpdateUtils.To<T>(T, ref T, ref bool, ref bool)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

Constructors

ActionTask(string, Action)

A task that executes an System.Action that cannot be canceled. Only completion is reported, no intermediate progress.

public ActionTask(string name, Action work)

Parameters

name string

A name describing the task in human-readable form.

work Action

The code to be executed by the task. May throw System.Net.WebException, System.IO.IOException or System.OperationCanceledException.

ActionTask(string, Action<CancellationToken>)

A task that executes an System.Action that can be canceled. Only completion is reported, no intermediate progress.

public ActionTask(string name, Action<CancellationToken> work)

Parameters

name string

A name describing the task in human-readable form.

work Action<CancellationToken>

The code to be executed by the task. May throw System.Net.WebException, System.IO.IOException or System.OperationCanceledException.

ActionTask(string, Func<CancellationToken, Task>)

A task that executes an async System.Threading.Tasks.Task that can be canceled. Only completion is reported, no intermediate progress.

public ActionTask(string name, Func<CancellationToken, Task> work)

Parameters

name string

A name describing the task in human-readable form.

work Func<CancellationToken, Task>

The code to be executed and awaited. May throw System.Net.WebException, System.IO.IOException or System.OperationCanceledException.

ActionTask(string, Func<Task>)

A task that executes an async System.Threading.Tasks.Task that cannot be canceled. Only completion is reported, no intermediate progress.

public ActionTask(string name, Func<Task> work)

Parameters

name string

A name describing the task in human-readable form.

work Func<Task>

The code to be executed and awaited. May throw System.Net.WebException, System.IO.IOException or System.OperationCanceledException.

Properties

CanCancel

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

public override bool CanCancel { get; }

Property Value

bool

Name

A name describing the task in human-readable form.

public override string Name { get; }

Property Value

string

UnitsByte

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

protected override bool UnitsByte { get; }

Property Value

bool

Methods

Execute()

The actual code to be executed.

protected override void Execute()

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

OperationCanceledException

The operation was canceled.

IOException

The task ended with IOError.

WebException

The task ended with WebError.