TenantBackgroundService<TKey> class

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

Base class for a hosted service that performs work for every tenant once, then completes. Each tenant is processed inside its own combined DI + tenant scope, and a failure processing one tenant is logged and isolated so it never aborts the sweep of the remaining tenants.

Override TenantBackgroundService<TKey>.ExecuteForTenantAsync with the per-tenant work; resolve scoped services (your DbContext, repositories, …) from the scope's ServiceProvider, which is already bound to the tenant. Register the subclass with builder.Services.AddHostedService<MySweep>(). For recurring work, derive from PeriodicTenantBackgroundService<TKey> instead.

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

Type parametersCopy Anchor Link

• TKey: The tenant identifier type.

Inherits BackgroundService.

Implements IHostedService, IDisposable.

Derived types: PeriodicTenantBackgroundService<TKey>.

ConstructorsCopy Anchor Link

TenantBackgroundService(ITenantScopeFactory<TKey>, ITenantLookup<TKey>, ILogger)Copy Anchor Link

Base class for a hosted service that performs work for every tenant once, then completes. Each tenant is processed inside its own combined DI + tenant scope, and a failure processing one tenant is logged and isolated so it never aborts the sweep of the remaining tenants.

protected TenantBackgroundService(ITenantScopeFactory<TKey> scopeFactory, ITenantLookup<TKey> tenantLookup, ILogger logger)

Parameters:

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

Override TenantBackgroundService<TKey>.ExecuteForTenantAsync with the per-tenant work; resolve scoped services (your DbContext, repositories, …) from the scope's ServiceProvider, which is already bound to the tenant. Register the subclass with builder.Services.AddHostedService<MySweep>(). For recurring work, derive from PeriodicTenantBackgroundService<TKey> instead.

PropertiesCopy Anchor Link

LoggerCopy Anchor Link

The logger passed to the constructor, for the subclass's own messages.

protected ILogger Logger { get; }

Value: ILogger

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.

ExecuteForTenantAsync(ITenantScope<TKey>, CancellationToken)Copy Anchor Link

Performs the work for a single tenant. Called inside that tenant's scope, so scoped services resolved from its ServiceProvider see the tenant.

protected abstract Task ExecuteForTenantAsync(ITenantScope<TKey> scope, CancellationToken cancellationToken)

Parameters:

• scope ITenantScope<TKey>: The tenant's scope: Tenant is the tenant being processed. The base class disposes it when this method returns.
• cancellationToken CancellationToken: A cancellation token tied to host shutdown.

Returns: Task

RunForAllTenantsAsync(CancellationToken)Copy Anchor Link

Runs TenantBackgroundService<TKey>.ExecuteForTenantAsync for every tenant in the store, one at a time, with per-tenant failure isolation. Exposed so PeriodicTenantBackgroundService<TKey> can invoke it on each tick.

protected Task RunForAllTenantsAsync(CancellationToken cancellationToken)

Parameters:

• cancellationToken CancellationToken: Stops the run: no tenant starts after it is cancelled.

Returns: Task