Class InitializationService

Represents an abstract base class for a service that must complete its initialization before other services can start. This service ensures all setup tasks are completed and signals other dependent services when it is safe to begin their processes.

Inheritance

object

InitializationService

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 InitializationService : 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");
}
}

Properties

ExecuteTask

Gets the task that is executing the initialization logic, or null if no task has been started.

Declaration

public virtual Task? ExecuteTask { get; }

Property Value

Type	Description
Task

Methods

Dispose()

Releases all resources used by the service. This method should be called to clean up any resources when the service is no longer needed.

Declaration

public virtual void Dispose()

ExecuteAsync(CancellationToken)

When overridden in a derived class, executes the initialization logic as an asynchronous operation.

Declaration

protected abstract Task ExecuteAsync(CancellationToken stoppingToken)

Parameters

Type	Name	Description
CancellationToken	stoppingToken	A cancellation token that should be used to request cancellation of the initialization task.

Returns

Type	Description
Task	A task that represents the asynchronous initialization operation.

ReleaseHold()

Signals that the initialization is complete and dependent services can start. This method should be called once the initialization tasks are finished.

Declaration

public static void ReleaseHold()

StartAsync(CancellationToken)

Starts the service initialization process.

Declaration

public virtual Task StartAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token to monitor for cancellation requests. The cancellation token should cancel the initialization process.

Returns

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

StopAsync(CancellationToken)

Stops the service. This method should cancel the initialization task and ensure the service is properly cleaned up.

Declaration

public virtual Task StopAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token to monitor for cancellation requests. The token should request the service to stop.

Returns

Type	Description
Task

WaitForRelease()

Waits for the initialization to complete. This method blocks until the initialization service signals that it is ready.

Declaration

public static void WaitForRelease()

Implements

IHostedService

IDisposable