M_CodeJam_Threading_TaskHelper_WaitAll_5

TaskHelper.WaitAll Method (IEnumerable(Task), TimeSpan, CancellationToken)

Waits for all of the provided Task objects to complete execution within a specified TimeSpan or until the wait is cancelled.

Namespace: CodeJam.Threading
Assembly: CodeJam (in CodeJam.dll) Version: 2.1.0.0

Syntax

C#

public static bool WaitAll(
	this IEnumerable<Task> tasks,
	TimeSpan timeout,
	CancellationToken cancellation
)

VB

<ExtensionAttribute>
Public Shared Function WaitAll ( 
	tasks As IEnumerable(Of Task),
	timeout As TimeSpan,
	cancellation As CancellationToken
) As Boolean

F#

[<ExtensionAttribute>]
static member WaitAll : 
        tasks : IEnumerable<Task> * 
        timeout : TimeSpan * 
        cancellation : CancellationToken -> bool 

Parameters

 

tasks

Type: System.Collections.Generic.IEnumerable(Task)
Task instances on which to wait.

timeout

Type: System.TimeSpan
A TimeSpan to wait, or TimeSpan that represents -1 milliseconds to wait indefinitely.

cancellation

Type: System.Threading.CancellationToken
A CancellationToken to observe while waiting for the tasks to complete.

Return Value

Type: Boolean
true if all of the Task instances completed execution within the allotted time; otherwise, false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(Task). When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

See Also

Reference

TaskHelper Class
WaitAll Overload
CodeJam.Threading Namespace