Class InitializationDependentServices

Provides an abstract base class for services that must wait for the completion of an initialization process before starting their operations.

Inheritance

object

InitializationDependentServices

Implements

IHostedService

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Coree.NETStandard.Abstractions.InitializationService

Assembly: Coree.NETStandard.dll

Syntax

public abstract class InitializationDependentServices : IHostedService, IDisposable

Remarks

Example usage:

services.AddHostedService<MyStartup>();
services.AddHostedService<MyDependend>();
public class MyStartup : InitializationService
{
private readonly ILogger<MyStartup> _logger;
public MyStartup(ILogger<MyStartup> logger) { _logger = logger; }
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
_logger.LogInformation("Start MyStartup");
try { await Task.Delay(5000, stoppingToken); }
catch (TaskCanceledException) { _logger.LogInformation("MyStartup was canceled."); return; }
_logger.LogInformation("End MyStartup");
}
}
public class MyDependend : InitializationDependentServices
{
private readonly ILogger<MyDependend> _logger;
public MyDependend(ILogger<MyDependend> logger) { _logger = logger; }
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
_logger.LogInformation("Start MyDependend");
try { await Task.Delay(5000, stoppingToken); }
catch (TaskCanceledException) { _logger.LogInformation("MyDependend was canceled."); return; }
_logger.LogInformation("End MyDependend");
}
}

Methods

Dispose()

Disposes of the resources used by the service, specifically the cancellation token source.

Declaration

public void Dispose()

ExecuteAsync(CancellationToken)

When overridden in a derived class, performs the operational tasks once the service is started. This method is intended to contain the core logic for the dependent service, which should execute only after the initialization is complete.

Declaration

protected abstract Task ExecuteAsync(CancellationToken stoppingToken)

Parameters

Type	Name	Description
CancellationToken	stoppingToken	A cancellation token that can be used to observe cancellation requests.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

StartAsync(CancellationToken)

Starts the service asynchronously, waiting for an initialization signal before beginning execution. This method ensures that the service does not proceed until the initialization process has been completed and signaled accordingly.

Declaration

public Task StartAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token to monitor for cancellation requests, which might come from the host application.

Returns

Type	Description
Task	A task that represents the asynchronous operation of starting the service.

StopAsync(CancellationToken)

Stops the service asynchronously. This method cancels the execution task and awaits its completion, ensuring a clean shutdown.

Declaration

public Task StopAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token to monitor for cancellation requests, allowing for a graceful service stop.

Returns

Type	Description
Task

Implements

IHostedService

IDisposable