BackgroundService Class

Definition

Namespace:: Microsoft.Extensions.Hosting

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

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

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.

Base class for implementing a long runningIHostedService.

public ref class BackgroundService abstract : IDisposable, Microsoft::Extensions::Hosting::IHostedService

public abstract class BackgroundService : IDisposable, Microsoft.Extensions.Hosting.IHostedService

type BackgroundService = class    interface IHostedService    interface IDisposable

Public MustInherit Class BackgroundServiceImplements IDisposable, IHostedService

Inheritance: Object
BackgroundService

Implements: IHostedServiceIDisposable

Constructors

Name	Description
BackgroundService()	Initializes a new instance of theBackgroundService class.

Properties

Name	Description
ExecuteTask	Gets the Task that executes the background operation.

Methods

Name	Description
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
ExecuteAsync(CancellationToken)	This method is called when theIHostedService starts. The implementation should return a task that representsthe lifetime of the long running operation(s) being performed.
StartAsync(CancellationToken)	Triggered when the application host is ready to start the service.
StopAsync(CancellationToken)	Triggered when the application host is performing a graceful shutdown.

Extension Methods

Name	Description
StartAndStopAsync(IHostedService, CancellationToken)	Starts and immediately stops the service.

Applies to

Movatterモバイル変換

Share via