BackgroundService.StartAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

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

Package:: Microsoft.Extensions.Hosting.Abstractions v6.0.0

Package:: Microsoft.Extensions.Hosting.Abstractions v7.0.0

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

Package:: Microsoft.Extensions.Hosting.Abstractions v9.0.0-preview.2.24128.5

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 ready to start the service.

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

public virtual System.Threading.Tasks.Task StartAsync (System.Threading.CancellationToken cancellationToken);

abstract member StartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.StartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function StartAsync (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken: CancellationToken

Indicates that the start process has been aborted.

Returns

Task

A Task that represents the asynchronous Start operation.

Implements

StartAsync(CancellationToken)

Exceptions

OperationCanceledException

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

Applies to