ConsoleLifetime.StopAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting.Internal

Assembly:: Microsoft.Extensions.Hosting.dll

Package:: Microsoft.Extensions.Hosting v8.0.0

Package:: Microsoft.Extensions.Hosting v9.0.0-preview.3.24172.9

Source:: ConsoleLifetime.cs

Source:: ConsoleLifetime.cs

Source:: ConsoleLifetime.cs

Source:: ConsoleLifetime.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.

Called from StopAsync(CancellationToken) to indicate that the host is stopping and it's time to shut down.

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

Used to indicate when stop should no longer be graceful.

Returns

Task

A Task.

Implements

StopAsync(CancellationToken)

Exceptions

OperationCanceledException

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

Remarks

This API supports the .NET infrastructure and is not intended to be used directly from your code.

Applies to