WindowsServiceLifetime.WaitForStartAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.Extensions.Hosting.WindowsServices

Assembly:

Microsoft.Extensions.Hosting.WindowsServices.dll

Package:

Microsoft.Extensions.Hosting.WindowsServices v9.0.0-rc.2.24473.5

Source:

WindowsServiceLifetime.cs

Asynchronously waits until start is complete before continuing. This method is called at the beginning of StartAsync(CancellationToken). This can be used to delay startup until signaled by an external event.

public:
 virtual 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
override this.WaitForStartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function WaitForStartAsync (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken

CancellationToken

A cancellation token that indicates when stop should no longer be graceful.

Returns

Task

A task that represents the asynchronous waiting for start operation.

Implements

WaitForStartAsync(CancellationToken)

Exceptions

OperationCanceledException

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