Class ApplicationBackgroundService

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Base class for implementing background tasks in Kentico.

public abstract class ApplicationBackgroundService : BackgroundService

Inheritance

object

BackgroundService

ApplicationBackgroundService

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

This class extends the native Microsoft.Extensions.Hosting.BackgroundService class and ensures that background tasks are executed only after the application is initialized. It provides the ability to override all methods from the Microsoft.Extensions.Hosting.BackgroundService class, but doing so may change the behavior of the service. Additionally, it includes a mechanism for restarting the service in case of an uncaught exception. The desired logic of a background service should be implemented in the ExecuteInternal(CancellationToken) method. If there is a need to make the logic recurring, it must be handled also in the body of the ExecuteInternal(CancellationToken) method. This base class does not provide any recurring logic by default. Furthermore, it maintains thread context separation by ensuring a fresh context scope for each background service instance. This means that each background service instance is assigned its own connection scope.

Properties

RestartDelay

Gets or sets the delay in milliseconds, after that the service restarts in case of an uncaught exception. 0 by default.

protected int RestartDelay { get; set; }

Property Value

int

ShouldRestart

Gets or sets the flag, whether the service should restart in case of an uncaught exception. False by default.

protected bool ShouldRestart { get; set; }

Property Value

bool

Methods

ExecuteAsync(CancellationToken)

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

protected override sealed Task ExecuteAsync(CancellationToken stoppingToken)

Parameters

stoppingToken CancellationToken

Triggered when Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken) is called.

Returns

Task

A System.Threading.Tasks.Task that represents the long running operations.

Remarks

See Worker Services in .NET for implementation guidelines.

ExecuteInternal(CancellationToken)

Called after the application is initialized. Contains the work that the service executes.

protected abstract Task ExecuteInternal(CancellationToken stoppingToken)

Parameters

stoppingToken CancellationToken

Triggered when Microsoft.Extensions.Hosting.BackgroundService.StopAsync(System.Threading.CancellationToken) is called.

Returns

Task