View Source

Class QueuedHostedService

A queue based hosted service used to executing tasks on a background thread.

Inheritance

System.Object

Namespace: Umbraco.Cms.Infrastructure.HostedServices

Assembly: Umbraco.Infrastructure.dll

Syntax

public class QueuedHostedService : BackgroundService

Remarks

Borrowed from https://docs.microsoft.com/en-us/aspnet/core/fundamentals/host/hosted-services?view=aspnetcore-5.0

Constructors

QueuedHostedService(IBackgroundTaskQueue, ILogger<QueuedHostedService>)

Declaration

public QueuedHostedService(IBackgroundTaskQueue taskQueue, ILogger<QueuedHostedService> logger)

Parameters

Type	Name	Description
IBackgroundTaskQueue	taskQueue
ILogger<QueuedHostedService>	logger

Properties

TaskQueue

Declaration

public IBackgroundTaskQueue TaskQueue { get; }

Property Value

Type	Description
IBackgroundTaskQueue

Methods

ExecuteAsync(CancellationToken)

Declaration

protected override async Task ExecuteAsync(CancellationToken stoppingToken)

Parameters

Type	Name	Description
CancellationToken	stoppingToken

Returns

Type	Description
Task

StopAsync(CancellationToken)

Declaration

public override async Task StopAsync(CancellationToken stoppingToken)

Parameters

Type	Name	Description
CancellationToken	stoppingToken

Returns

Type	Description
Task