Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

BackgroundService.StopAsync(CancellationToken) Method

Definition

Namespace:
Microsoft.Extensions.Hosting
Assembly:
Microsoft.Extensions.Hosting.Abstractions.dll
Package:
Microsoft.Extensions.Hosting.Abstractions v11.0.0-preview.5.26302.115
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

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


Feedback

Was this page helpful?