WindowsServiceLifetime.StopAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting.WindowsServices

Assembly:: Microsoft.Extensions.Hosting.WindowsServices.dll

Package:: Microsoft.Extensions.Hosting.WindowsServices v9.0.0

Source:: WindowsServiceLifetime.cs

Source:: WindowsServiceLifetime.cs

Source:: WindowsServiceLifetime.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to

Jaa