BackgroundService Class

Definition

Namespace:

Microsoft.Extensions.Hosting

Assembly:

Microsoft.Extensions.Hosting.Abstractions.dll

Package:

Microsoft.Extensions.Hosting.Abstractions v9.0.0

Source:

BackgroundService.cs

Base class for implementing a long running IHostedService.

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 BackgroundService
Implements IDisposable, IHostedService

Inheritance

Object

BackgroundService

Implements

IHostedService IDisposable

Constructors

BackgroundService()

Initializes a new instance of the BackgroundService class.

Properties

ExecuteTask

Gets the Task that executes the background operation.

Methods

Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
ExecuteAsync(CancellationToken)	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.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
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.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

StartAndStopAsync(IHostedService, CancellationToken)

Starts and immediately stops the service.