Class DistributedBackgroundService

Extends the Microsoft.Extensions.Hosting.BackgroundService adding a distributed lock mechanism to prevent concurrent executions.

Inheritance

System.Object

Microsoft.Extensions.Hosting.BackgroundService

DistributedBackgroundService

RecurringDistributedBackgroundService

Implements

Microsoft.Extensions.Hosting.IHostedService

System.IDisposable

Inherited Members

Microsoft.Extensions.Hosting.BackgroundService.StartAsync(System.Threading.CancellationToken)

Microsoft.Extensions.Hosting.BackgroundService.StopAsync(System.Threading.CancellationToken)

Microsoft.Extensions.Hosting.BackgroundService.Dispose()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Silverback.Background

Assembly: Silverback.Core.dll

Syntax

public abstract class DistributedBackgroundService : BackgroundService, IHostedService, IDisposable

Constructors

| Improve this doc View source

DistributedBackgroundService(DistributedLockSettings, IDistributedLockManager, ISilverbackLogger<DistributedBackgroundService>)

Initializes a new instance of the DistributedBackgroundService class.

Declaration

protected DistributedBackgroundService(DistributedLockSettings distributedLockSettings, IDistributedLockManager distributedLockManager, ISilverbackLogger<DistributedBackgroundService> logger)

Parameters

Type	Name	Description
DistributedLockSettings	distributedLockSettings	Customizes the lock mechanism settings.
IDistributedLockManager	distributedLockManager	The IDistributedLockManager.
ISilverbackLogger<DistributedBackgroundService>	logger	The ISilverbackLogger.

| Improve this doc View source

DistributedBackgroundService(IDistributedLockManager, ISilverbackLogger<DistributedBackgroundService>)

Initializes a new instance of the DistributedBackgroundService class using the default settings for the lock mechanism.

Declaration

protected DistributedBackgroundService(IDistributedLockManager distributedLockManager, ISilverbackLogger<DistributedBackgroundService> logger)

Parameters

Type	Name	Description
IDistributedLockManager	distributedLockManager	The IDistributedLockManager.
ISilverbackLogger<DistributedBackgroundService>	logger	The ISilverbackLogger.

Properties

| Improve this doc View source

Lock

Gets the acquired DistributedLock.

Declaration

protected DistributedLock Lock { get; }

Property Value

Type	Description
DistributedLock

Methods

| Improve this doc View source

ExecuteAsync(CancellationToken)

Declaration

protected override Task ExecuteAsync(CancellationToken stoppingToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	stoppingToken

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Microsoft.Extensions.Hosting.BackgroundService.ExecuteAsync(System.Threading.CancellationToken)

| Improve this doc View source

ExecuteLockedAsync(CancellationToken)

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

Declaration

protected abstract Task ExecuteLockedAsync(CancellationToken stoppingToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	stoppingToken	A System.Threading.CancellationToken to observe while waiting for the task to complete.

Returns

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

Implements

Microsoft.Extensions.Hosting.IHostedService

System.IDisposable