NanoByte.Common 2.11.0
NanoByte.Common.Tasks.SimplePercentTask Class Reference

A delegate-driven task. Progress is reported in percent. More...

Inheritance diagram for NanoByte.Common.Tasks.SimplePercentTask:
NanoByte.Common.Tasks.TaskBase NanoByte.Common.Tasks.ITask

Public Member Functions

 SimplePercentTask ([Localizable(true)] string name, Action< PercentProgressCallback > work, Action? cancellationCallback=null)
 Creates a new simple task. More...
- Public Member Functions inherited from NanoByte.Common.Tasks.TaskBase
void Run (CancellationToken cancellationToken=default, ICredentialProvider? credentialProvider=null, IProgress< TaskSnapshot >? progress=null)
 Runs the task and blocks until it is complete. More...

Protected Member Functions

override void Execute ()
 The actual code to be executed. More...


override string Name [get]
override bool CanCancel [get]
override bool UnitsByte [get]
- Properties inherited from NanoByte.Common.Tasks.TaskBase
abstract string Name [get]
object? Tag [getset]
virtual bool CanCancel [get]
TaskState State [getprotected set]
 The current State of the task.
abstract bool UnitsByte [get]
 true if UnitsProcessed and UnitsTotal are measured in bytes; false if they are measured in generic units.
long UnitsProcessed [getset]
 The number of units that have been processed so far.
long UnitsTotal [getset]
 The total number of units that are to be processed; -1 for unknown.
- Properties inherited from NanoByte.Common.Tasks.ITask
string Name [get]
 A name describing the task in human-readable form.
object? Tag [getset]
 An object used to associate the task with a specific process; can be null.
bool CanCancel [get]
 Indicates whether this task can be canceled once it has been started.

Additional Inherited Members

- Protected Attributes inherited from NanoByte.Common.Tasks.TaskBase
CancellationToken CancellationToken
 Signaled when the user wishes to cancel the task execution.
 Used to retrieve credentials for specific Uris on demand; can be null.

Detailed Description

A delegate-driven task. Progress is reported in percent.

Constructor & Destructor Documentation

◆ SimplePercentTask()

NanoByte.Common.Tasks.SimplePercentTask.SimplePercentTask ( [Localizable(true)] string  name,
Action< PercentProgressCallback work,
Action?  cancellationCallback = null 

Creates a new simple task.

nameA name describing the task in human-readable form.
workThe code to be executed by the task. Is given a callback to report progress in percent. May throw WebException, IOException or OperationCanceledException.
cancellationCallbackA callback to be called when cancellation is requested via a CancellationToken.

Member Function Documentation

◆ Execute()

override void NanoByte.Common.Tasks.SimplePercentTask.Execute ( )

The actual code to be executed.

Implements NanoByte.Common.Tasks.TaskBase.

The documentation for this class was generated from the following file: