IHostLifetime.WaitForStartAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Microsoft.Extensions.Hosting.Abstractions.dll

Package:

Microsoft.Extensions.Hosting.Abstractions v9.0.0

Source:

IHostLifetime.cs

Called at the start of StartAsync(CancellationToken) which will wait until it's complete before continuing. This can be used to delay startup until signaled by an external event.

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

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

abstract member WaitForStartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function WaitForStartAsync (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken

CancellationToken

Used to abort program start.

Returns

Task

A Task.

Exceptions

OperationCanceledException

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