NanoByte.Common
2.6.1
|
Abstract base class for ITask implementations. More...
Public Member Functions | |
void | Run (CancellationToken cancellationToken=default, ICredentialProvider? credentialProvider=null, IProgress< TaskSnapshot >? progress=null) |
Runs the task and blocks until it is complete. | |
Protected Member Functions | |
abstract void | Execute () |
The actual code to be executed. More... | |
Protected Attributes | |
CancellationToken | CancellationToken |
Signaled when the user wishes to cancel the task execution. More... | |
ICredentialProvider? | CredentialProvider |
Used to retrieve credentials for specific Uris on demand; can be null . More... | |
Properties | |
abstract string | Name [get] |
object? | Tag [get, set] |
virtual bool | CanCancel [get] |
TaskState | State [get, protected set] |
The current State of the task. More... | |
abstract bool | UnitsByte [get] |
true if UnitsProcessed and UnitsTotal are measured in bytes; false if they are measured in generic units. More... | |
long | UnitsProcessed [get, set] |
The number of units that have been processed so far. More... | |
long | UnitsTotal [get, set] |
The total number of units that are to be processed; -1 for unknown. More... | |
![]() | |
string | Name [get] |
A name describing the task in human-readable form. More... | |
object? | Tag [get, set] |
An object used to associate the task with a specific process; can be null . More... | |
bool | CanCancel [get] |
Indicates whether this task can be canceled once it has been started. More... | |
Abstract base class for ITask implementations.
|
protectedpure virtual |
The actual code to be executed.
State is automatically set to TaskState.Started before calling this method, to TaskState.Complete after a successful exit and to an appropriate error state in case on an exception. You can set additional TaskStates during execution.
OperationCanceledException | The operation was canceled. |
IOException | The task ended with TaskState.IOError. |
WebException | The task ended with TaskState.WebError. |
Implemented in NanoByte.Common.Tasks.WaitTask, NanoByte.Common.Tasks.SimpleTask, NanoByte.Common.Tasks.SimplePercentTask, NanoByte.Common.Tasks.ForEachTask< T >, NanoByte.Common.Storage.MoveDirectory, NanoByte.Common.Storage.CopyDirectory, and NanoByte.Common.Net.DownloadTask.
|
protected |
Signaled when the user wishes to cancel the task execution.
|
protected |
Used to retrieve credentials for specific Uris on demand; can be null
.
|
getprotected setpackage |
The current State of the task.
|
getprotected |
true
if UnitsProcessed and UnitsTotal are measured in bytes; false
if they are measured in generic units.
|
getsetprotected |
The number of units that have been processed so far.
|
getsetprotected |
The total number of units that are to be processed; -1 for unknown.