MinimalConsoleHostedService Class

Definition

Namespace

Codebelt.Bootstrapper.Console

Assemblies

Codebelt.Bootstrapper.Console.dll

Source

src/Codebelt.Bootstrapper.Console/MinimalConsoleHostedService.cs

Provides a console application that is managed by its host.

public class MinimalConsoleHostedService : IHostedService

Inheritance

object

MinimalConsoleHostedService

Implements

IHostedService

Examples

The following example shows how MinimalConsoleHostedService is registered by UseMinimalConsoleProgram on a HostApplicationBuilder. When the host starts, the service subscribes to IHostLifetimeEvents.OnApplicationStartedCallback, runs the MinimalConsoleProgram.RunAsync task, and then calls IHostApplicationLifetime.StopApplication to begin a graceful shutdown. The example resolves the hosted service from the host's service collection to confirm the registration.

using System;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Codebelt.Bootstrapper.Console;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace MinimalConsoleHostedServiceDemo;

public class MyProgram : MinimalConsoleProgram
{
    public override Task RunAsync(IServiceProvider serviceProvider, CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }
}

public static class Program
{
    public static void Main()
    {
        var builder = Host.CreateApplicationBuilder();
        builder.UseBootstrapperProgram(typeof(MyProgram));
        builder.UseMinimalConsoleProgram();

        using var host = builder.Build();
        var hosted = host.Services.GetServices<IHostedService>().OfType<MinimalConsoleHostedService>().Single();
    }
}

Constructors

Name	Description
MinimalConsoleHostedService(IProgramFactory, IHostApplicationLifetime, IServiceProvider, IHostLifetimeEvents)	Initializes a new instance of the MinimalConsoleHostedService class.

Methods

Name	Description
StartAsync(CancellationToken)	Triggered when the application host is ready to start the service.
StopAsync(CancellationToken)	Triggered when the application host is performing a graceful shutdown.

See Also

IHostedService