HostingAbstractionsHostExtensions.RunAsync(IHost, CancellationToken) Method

Definition

Runs an application and returns a Task that only completes when the token is triggered or shutdown is triggered and all IHostedService instances are stopped.

public static System.Threading.Tasks.Task RunAsync (this Microsoft.Extensions.Hosting.IHost host, System.Threading.CancellationToken token = default);
static member RunAsync : Microsoft.Extensions.Hosting.IHost * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function RunAsync (host As IHost, Optional token As CancellationToken = Nothing) As Task

Parameters

host
IHost

The IHost to run.

token
CancellationToken

The token to trigger shutdown.

Returns

The Task that represents the asynchronous operation.

Exceptions

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 Run(IHost).

Applies to