WhileAsync Method

Definition

Namespace

Cuemon.Threading

Assemblies

Cuemon.Threading.dll

Source

src/Cuemon.Threading/AdvancedParallelFactory.WhileAsync.cs

WhileAsync<TReader, TElement>(TReader, Func<Task<bool>>, Func<TReader, TElement>, Func<TElement, CancellationToken, Task>, Action<AsyncWorkloadOptions>)

Executes a parallel while loop.

public static Task WhileAsync<TReader, TElement>(TReader reader, Func<Task<bool>> condition, Func<TReader, TElement> provider, Func<TElement, CancellationToken, Task> worker, Action<AsyncWorkloadOptions> setup = null)

Parameters

reader TReader

The reader that provides forward-only access to data.

condition Func<Task<bool>>

The function delegate that is responsible for the while loop condition.

provider Func<TReader, TElement>

The function delegate that provides data from the specified reader.

worker Func<TElement, CancellationToken, Task>

The delegate that will perform work while condition evaluates true.

setup Action<AsyncWorkloadOptions>

The AsyncWorkloadOptions which may be configured.

Returns

Task

A Task that represents the asynchronous operation.

Type Parameters

TReader

The type of the reader that provides forward-only access to data.

TElement

The type of the result provided by reader.

WhileAsync<TReader, TElement, T>(TReader, Func<Task<bool>>, Func<TReader, TElement>, Func<TElement, T, CancellationToken, Task>, T, Action<AsyncWorkloadOptions>)

Executes a parallel while loop.

public static Task WhileAsync<TReader, TElement, T>(TReader reader, Func<Task<bool>> condition, Func<TReader, TElement> provider, Func<TElement, T, CancellationToken, Task> worker, T arg, Action<AsyncWorkloadOptions> setup = null)

Parameters

reader TReader

The reader that provides forward-only access to data.

condition Func<Task<bool>>

The function delegate that is responsible for the while loop condition.

provider Func<TReader, TElement>

The function delegate that provides data from the specified reader.

worker Func<TElement, T, CancellationToken, Task>

The delegate that will perform work while condition evaluates true.

arg T

The parameter of the delegate worker.

setup Action<AsyncWorkloadOptions>

The AsyncWorkloadOptions which may be configured.

Returns

Task

A Task that represents the asynchronous operation.

Type Parameters

TReader

The type of the reader that provides forward-only access to data.

TElement

The type of the result provided by reader.

T

The type of the parameter of the delegate worker.

WhileAsync<TReader, TElement, T1, T2>(TReader, Func<Task<bool>>, Func<TReader, TElement>, Func<TElement, T1, T2, CancellationToken, Task>, T1, T2, Action<AsyncWorkloadOptions>)

Executes a parallel while loop.

public static Task WhileAsync<TReader, TElement, T1, T2>(TReader reader, Func<Task<bool>> condition, Func<TReader, TElement> provider, Func<TElement, T1, T2, CancellationToken, Task> worker, T1 arg1, T2 arg2, Action<AsyncWorkloadOptions> setup = null)

Parameters

reader TReader

The reader that provides forward-only access to data.

condition Func<Task<bool>>

The function delegate that is responsible for the while loop condition.

provider Func<TReader, TElement>

The function delegate that provides data from the specified reader.

worker Func<TElement, T1, T2, CancellationToken, Task>

The delegate that will perform work while condition evaluates true.

arg1 T1

The first parameter of the delegate worker.

arg2 T2

The second parameter of the delegate worker.

setup Action<AsyncWorkloadOptions>

The AsyncWorkloadOptions which may be configured.

Returns

Task

A Task that represents the asynchronous operation.

Type Parameters

TReader

The type of the reader that provides forward-only access to data.

TElement

The type of the result provided by reader.

T1

The type of the first parameter of the delegate worker.

T2

The type of the second parameter of the delegate worker.

WhileAsync<TReader, TElement, T1, T2, T3>(TReader, Func<Task<bool>>, Func<TReader, TElement>, Func<TElement, T1, T2, T3, CancellationToken, Task>, T1, T2, T3, Action<AsyncWorkloadOptions>)

Executes a parallel while loop.

public static Task WhileAsync<TReader, TElement, T1, T2, T3>(TReader reader, Func<Task<bool>> condition, Func<TReader, TElement> provider, Func<TElement, T1, T2, T3, CancellationToken, Task> worker, T1 arg1, T2 arg2, T3 arg3, Action<AsyncWorkloadOptions> setup = null)

Parameters

reader TReader

The reader that provides forward-only access to data.

condition Func<Task<bool>>

The function delegate that is responsible for the while loop condition.

provider Func<TReader, TElement>

The function delegate that provides data from the specified reader.

worker Func<TElement, T1, T2, T3, CancellationToken, Task>

The delegate that will perform work while condition evaluates true.

arg1 T1

The first parameter of the delegate worker.

arg2 T2

The second parameter of the delegate worker.

arg3 T3

The third parameter of the delegate worker.

setup Action<AsyncWorkloadOptions>

The AsyncWorkloadOptions which may be configured.

Returns

Task

A Task that represents the asynchronous operation.

Type Parameters

TReader

The type of the reader that provides forward-only access to data.

TElement

The type of the result provided by reader.

T1

The type of the first parameter of the delegate worker.

T2

The type of the second parameter of the delegate worker.

T3

The type of the third parameter of the delegate worker.

WhileAsync<TReader, TElement, T1, T2, T3, T4>(TReader, Func<Task<bool>>, Func<TReader, TElement>, Func<TElement, T1, T2, T3, T4, CancellationToken, Task>, T1, T2, T3, T4, Action<AsyncWorkloadOptions>)

Executes a parallel while loop.

public static Task WhileAsync<TReader, TElement, T1, T2, T3, T4>(TReader reader, Func<Task<bool>> condition, Func<TReader, TElement> provider, Func<TElement, T1, T2, T3, T4, CancellationToken, Task> worker, T1 arg1, T2 arg2, T3 arg3, T4 arg4, Action<AsyncWorkloadOptions> setup = null)

Parameters

reader TReader

The reader that provides forward-only access to data.

condition Func<Task<bool>>

The function delegate that is responsible for the while loop condition.

provider Func<TReader, TElement>

The function delegate that provides data from the specified reader.

worker Func<TElement, T1, T2, T3, T4, CancellationToken, Task>

The delegate that will perform work while condition evaluates true.

arg1 T1

The first parameter of the delegate worker.

arg2 T2

The second parameter of the delegate worker.

arg3 T3

The third parameter of the delegate worker.

arg4 T4

The fourth parameter of the delegate worker.

setup Action<AsyncWorkloadOptions>

The AsyncWorkloadOptions which may be configured.

Returns

Task

A Task that represents the asynchronous operation.

Type Parameters

TReader

The type of the reader that provides forward-only access to data.

TElement

The type of the result provided by reader.

T1

The type of the first parameter of the delegate worker.

T2

The type of the second parameter of the delegate worker.

T3

The type of the third parameter of the delegate worker.

T4

The type of the fourth parameter of the delegate worker.

WhileAsync<TReader, TElement, T1, T2, T3, T4, T5>(TReader, Func<Task<bool>>, Func<TReader, TElement>, Func<TElement, T1, T2, T3, T4, T5, CancellationToken, Task>, T1, T2, T3, T4, T5, Action<AsyncWorkloadOptions>)

Executes a parallel while loop.

public static Task WhileAsync<TReader, TElement, T1, T2, T3, T4, T5>(TReader reader, Func<Task<bool>> condition, Func<TReader, TElement> provider, Func<TElement, T1, T2, T3, T4, T5, CancellationToken, Task> worker, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, Action<AsyncWorkloadOptions> setup = null)

Parameters

reader TReader

The reader that provides forward-only access to data.

condition Func<Task<bool>>

The function delegate that is responsible for the while loop condition.

provider Func<TReader, TElement>

The function delegate that provides data from the specified reader.

worker Func<TElement, T1, T2, T3, T4, T5, CancellationToken, Task>

The delegate that will perform work while condition evaluates true.

arg1 T1

The first parameter of the delegate worker.

arg2 T2

The second parameter of the delegate worker.

arg3 T3

The third parameter of the delegate worker.

arg4 T4

The fourth parameter of the delegate worker.

arg5 T5

The fifth parameter of the delegate worker.

setup Action<AsyncWorkloadOptions>

The AsyncWorkloadOptions which may be configured.

Returns

Task

A Task that represents the asynchronous operation.

Type Parameters

TReader

The type of the reader that provides forward-only access to data.

TElement

The type of the result provided by reader.

T1

The type of the first parameter of the delegate worker.

T2

The type of the second parameter of the delegate worker.

T3

The type of the third parameter of the delegate worker.

T4

The type of the fourth parameter of the delegate worker.

T5

The type of the fifth parameter of the delegate worker.