BackgroundService.StopAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

Assembly:: Microsoft.Extensions.Hosting.Abstractions.dll

Package:: Microsoft.Extensions.Hosting.Abstractions v8.0.1

Package:: Microsoft.Extensions.Hosting.Abstractions v9.0.0-rc.2.24473.5

Source:: BackgroundService.cs

Source:: BackgroundService.cs

Source:: BackgroundService.cs

Source:: BackgroundService.cs

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

Triggered when the application host is performing a graceful shutdown.

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

public virtual 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 Overridable Function StopAsync (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken: CancellationToken

Indicates that the shutdown process 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

Dela via