BackgroundService.StopAsync(CancellationToken) Method

Definition

Triggered when the application host is performing a graceful shutdown.

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

Parameters

cancellationToken
CancellationToken

Indicates that the shutdown process should no longer be graceful.

Returns

A Task that represents the asynchronous Stop operation.

Implements

Exceptions

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

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided), 2.1 (package-provided)