PeriodicTenantBackgroundService<TKey> class

Namespace: Tenantry.Pro.BackgroundServices · Package: Tenantry.Pro · API reference

Base class for a hosted service that performs work for every tenant on a recurring interval. The first sweep runs at startup, then again every PeriodicTenantBackgroundService<TKey>.Interval. Each tenant is processed inside its own scope with per-tenant failure isolation (see TenantBackgroundService<TKey>); a failure in one sweep does not stop later sweeps.

Override TenantBackgroundService<TKey>.ExecuteForTenantAsync with the per-tenant work and PeriodicTenantBackgroundService<TKey>.Interval with the cadence, then register with builder.Services.AddHostedService<MySweep>().

public abstract class PeriodicTenantBackgroundService<TKey> : TenantBackgroundService<TKey>, IHostedService, IDisposable where TKey : IEquatable<TKey>, IParsable<TKey>

Type parametersCopy Anchor Link

• TKey: The tenant identifier type.

Inherits BackgroundService → TenantBackgroundService<TKey>.

Implements IHostedService, IDisposable.

ConstructorsCopy Anchor Link

PeriodicTenantBackgroundService(ITenantScopeFactory<TKey>, ITenantStoreAccessor<TKey>, ILogger)Copy Anchor Link

Base class for a hosted service that performs work for every tenant on a recurring interval. The first sweep runs at startup, then again every PeriodicTenantBackgroundService<TKey>.Interval. Each tenant is processed inside its own scope with per-tenant failure isolation (see TenantBackgroundService<TKey>); a failure in one sweep does not stop later sweeps.

protected PeriodicTenantBackgroundService(ITenantScopeFactory<TKey> scopeFactory, ITenantStoreAccessor<TKey> storeAccessor, ILogger logger)

Parameters:

• scopeFactory ITenantScopeFactory<TKey>: Creates a scope per tenant for each run.
• storeAccessor ITenantStoreAccessor<TKey>: Lists the tenants to run for.
• logger ILogger: Logs each tenant's failures, which do not stop the other tenants.

Override TenantBackgroundService<TKey>.ExecuteForTenantAsync with the per-tenant work and PeriodicTenantBackgroundService<TKey>.Interval with the cadence, then register with builder.Services.AddHostedService<MySweep>().

PropertiesCopy Anchor Link

IntervalCopy Anchor Link

How long to wait between sweeps. Must be greater than zero.

protected abstract TimeSpan Interval { get; }

Value: TimeSpan

MethodsCopy Anchor Link

ExecuteAsync(CancellationToken)Copy Anchor Link

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.

protected override Task ExecuteAsync(CancellationToken stoppingToken)

Parameters:

• stoppingToken CancellationToken: Triggered when StopAsync(CancellationToken) is called.

Returns: Task: A Task that represents the long running operations.

See Worker Services in .NET for implementation guidelines.