BackgroundService.ExecuteAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Microsoft.Extensions.Hosting.Abstractions.dll

Package:

Microsoft.Extensions.Hosting.Abstractions v8.0.0

Source:

BackgroundService.cs

This method is called when the IHostedService starts. The implementation should return a task that represents the lifetime of the long running operation(s) being performed.

protected:
 abstract System::Threading::Tasks::Task ^ ExecuteAsync(System::Threading::CancellationToken stoppingToken);

protected abstract System.Threading.Tasks.Task ExecuteAsync (System.Threading.CancellationToken stoppingToken);

abstract member ExecuteAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected MustOverride Function ExecuteAsync (stoppingToken As CancellationToken) As Task

Parameters

stoppingToken

CancellationToken

Triggered when StopAsync(CancellationToken) is called.

Returns

Task

A Task that represents the long running operations.

Exceptions

OperationCanceledException

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

Remarks

For implementation guidelines, see Worker Services in .NET.