HostingAbstractionsHostExtensions.WaitForShutdownAsync Method

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Microsoft.Extensions.Hosting.Abstractions.dll

Package:

Microsoft.Extensions.Hosting.Abstractions v8.0.0

Source:

HostingAbstractionsHostExtensions.cs

Returns a Task that completes when shutdown is triggered via the given token.

public static System.Threading.Tasks.Task WaitForShutdownAsync (this Microsoft.Extensions.Hosting.IHost host, System.Threading.CancellationToken token = default);

static member WaitForShutdownAsync : Microsoft.Extensions.Hosting.IHost * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function WaitForShutdownAsync (host As IHost, Optional token As CancellationToken = Nothing) As Task

Parameters

host

IHost

The running IHost.

token

CancellationToken

The token to trigger shutdown.

Returns

Task

The Task that represents the asynchronous operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by WaitForShutdown(IHost).