Class RecurringDistributedBackgroundService

Extends the DistributedBackgroundService calling the execute method at regular intervals. The distributed lock mechanism prevents concurrent executions.

Inheritance

System.Object

Microsoft.Extensions.Hosting.BackgroundService

DistributedBackgroundService

RecurringDistributedBackgroundService

OutboxWorkerService

Implements

Microsoft.Extensions.Hosting.IHostedService

System.IDisposable

Inherited Members

DistributedBackgroundService.Lock

DistributedBackgroundService.ExecuteAsync(CancellationToken)

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 RecurringDistributedBackgroundService : DistributedBackgroundService, IHostedService, IDisposable

Constructors

| Improve this doc View source

RecurringDistributedBackgroundService(TimeSpan, DistributedLockSettings, IDistributedLockManager, ISilverbackLogger<RecurringDistributedBackgroundService>)

Initializes a new instance of the RecurringDistributedBackgroundService class.

Declaration

protected RecurringDistributedBackgroundService(TimeSpan interval, DistributedLockSettings distributedLockSettings, IDistributedLockManager distributedLockManager, ISilverbackLogger<RecurringDistributedBackgroundService> logger)

Parameters

Type	Name	Description
System.TimeSpan	interval	The System.TimeSpan interval between each execution.
DistributedLockSettings	distributedLockSettings	Customizes the lock mechanism settings.
IDistributedLockManager	distributedLockManager	The IDistributedLockManager.
ISilverbackLogger<RecurringDistributedBackgroundService>	logger	The ISilverbackLogger.

| Improve this doc View source

RecurringDistributedBackgroundService(TimeSpan, IDistributedLockManager, ISilverbackLogger<RecurringDistributedBackgroundService>)

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

Declaration

protected RecurringDistributedBackgroundService(TimeSpan interval, IDistributedLockManager distributedLockManager, ISilverbackLogger<RecurringDistributedBackgroundService> logger)

Parameters

Type	Name	Description
System.TimeSpan	interval	The interval between each execution.
IDistributedLockManager	distributedLockManager	The IDistributedLockManager.
ISilverbackLogger<RecurringDistributedBackgroundService>	logger	The ISilverbackLogger.

Methods

| Improve this doc View source

ExecuteLockedAsync(CancellationToken)

Declaration

protected override async Task ExecuteLockedAsync(CancellationToken stoppingToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	stoppingToken

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

DistributedBackgroundService.ExecuteLockedAsync(CancellationToken)

| Improve this doc View source

ExecuteRecurringAsync(CancellationToken)

This method is called at regular intervals after 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 ExecuteRecurringAsync(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.

| Improve this doc View source

Pause()

Pauses the execution of the recurring task.

Declaration

public void Pause()

| Improve this doc View source

Resume()

Resumes the execution of the previously paused recurring task.

Declaration

public void Resume()

Implements

Microsoft.Extensions.Hosting.IHostedService

System.IDisposable