A task that performs an operation once for each element of a collection. More...

Inheritance diagram for NanoByte.Common.Tasks.ForEachTask< T >:

Public Member Functions
	ForEachTask ([Localizable(true)] string name, IEnumerable< T > target, Action< T > work)
	Creates a new for-each 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.

Static Public Member Functions
static ForEachTask< T >	Create< T > ([Localizable(true)] string name, IEnumerable< T > target, Action< T > work)
	Creates a new for-each task. More...

Protected Member Functions
override void	Execute ()
	The actual code to be executed.

Properties
override string	Name `[get]`

override bool	UnitsByte `[get]`

Properties inherited from NanoByte.Common.Tasks.TaskBase
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...

Properties inherited from NanoByte.Common.Tasks.ITask
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...

Additional Inherited Members
Protected Attributes inherited from NanoByte.Common.Tasks.TaskBase
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...

Detailed Description

A task that performs an operation once for each element of a collection.

Provides a static factory method for ForEachTask<T> as an alternative to calling the constructor to exploit type inference.

Constructor & Destructor Documentation

NanoByte.Common.Tasks.ForEachTask< T >.ForEachTask	(	[Localizable(true)] string	name,
		IEnumerable< T >	target,
		Action< T >	work
	)

inline

Creates a new for-each task.

Parameters

name	A name describing the task in human-readable form.
target	A list of objects to execute work for. Cancellation is possible between two elements.
work	The code to be executed once per element in target . May throw WebException, IOException or OperationCanceledException.

static ForEachTask<T> NanoByte.Common.Tasks.ForEachTask< T >.Create< T >	(	[Localizable(true)] string	name,
		IEnumerable< T >	target,
		Action< T >	work
	)

static

Creates a new for-each task.

Parameters

name	A name describing the task in human-readable form.
target	A list of objects to execute work for. Cancellation is possible between two elements.
work	The code to be executed once per element in target . May throw WebException, IOException or OperationCanceledException.

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