JoinableTaskCollection.JoinTillEmptyAsync Method

Definition

Namespace:

Microsoft.VisualStudio.Threading

Assembly:

Microsoft.VisualStudio.Threading.dll

Package:

Microsoft.VisualStudio.Threading v17.12.19

Overloads

JoinTillEmptyAsync()	Joins the caller's context to this collection till the collection is empty.
JoinTillEmptyAsync(CancellationToken)	Joins the caller's context to this collection till the collection is empty.

JoinTillEmptyAsync()

Joins the caller's context to this collection till the collection is empty.

public:
 System::Threading::Tasks::Task ^ JoinTillEmptyAsync();

public System.Threading.Tasks.Task JoinTillEmptyAsync ();

member this.JoinTillEmptyAsync : unit -> System.Threading.Tasks.Task

Public Function JoinTillEmptyAsync () As Task

Returns

Task

A task that completes when this collection is empty.

Remarks

Any exceptions thrown by the tasks in this collection are not propagated to the returned task.

JoinTillEmptyAsync(CancellationToken)

Joins the caller's context to this collection till the collection is empty.

public:
 System::Threading::Tasks::Task ^ JoinTillEmptyAsync(System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task JoinTillEmptyAsync (System.Threading.CancellationToken cancellationToken);

member this.JoinTillEmptyAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function JoinTillEmptyAsync (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken

CancellationToken

A cancellation token.

Returns

Task

A task that completes when this collection is empty, or is canceled when cancellationToken is canceled.

Remarks

Any exceptions thrown by the tasks in this collection are not propagated to the returned task.