WindowsServiceLifetime.StopAsync(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 stops and shuts down the host. This method is called from StopAsync(CancellationToken).

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

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

abstract member StopAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.StopAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function StopAsync (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 stop operation.

Implements

StopAsync(CancellationToken)

Exceptions

OperationCanceledException

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