Class WaitTask

Namespace

NanoByte.Common.Threading

Assembly

NanoByte.Common.dll

Waits for a WaitHandle to become available or the CancellationToken to be triggered.

public sealed class WaitTask : TaskBase, ITask

Inheritance

object

MarshalByRefObject

TaskBase

WaitTask

Implements

ITask

Inherited Members

TaskBase.Tag

TaskBase.CanCancel

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

WaitTask(string, WaitHandle?, int)

Waits for a WaitHandle to become available or the CancellationToken to be triggered.

public WaitTask(string name, WaitHandle? waitHandle = null, int millisecondsTimeout = -1)

Parameters

name string

A name describing the task in human-readable form.

waitHandle WaitHandle

The WaitHandle to wait for; null to wait for CancellationToken.

millisecondsTimeout int

The number of milliseconds to wait before raising TimeoutException; Infinite to wait indefinitely.

Properties

Name

A name describing the task in human-readable form.

public override string Name { get; }

Property Value

string

PreventIdle

Indicates whether this task should prevent the system from entering idle mode.

protected override bool PreventIdle { get; }

Property Value

bool

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.