Codebelt.Bootstrapper.Worker
3.0.0
dotnet add package Codebelt.Bootstrapper.Worker --version 3.0.0
NuGet\Install-Package Codebelt.Bootstrapper.Worker -Version 3.0.0
<PackageReference Include="Codebelt.Bootstrapper.Worker" Version="3.0.0" />
paket add Codebelt.Bootstrapper.Worker --version 3.0.0
#r "nuget: Codebelt.Bootstrapper.Worker, 3.0.0"
// Install Codebelt.Bootstrapper.Worker as a Cake Addin #addin nuget:?package=Codebelt.Bootstrapper.Worker&version=3.0.0 // Install Codebelt.Bootstrapper.Worker as a Cake Tool #tool nuget:?package=Codebelt.Bootstrapper.Worker&version=3.0.0
About
An open-source family of assemblies (MIT license) that provide a uniform and consistent way of bootstraping your code with Program.cs
paired with Startup.cs
.
Also, common for all, is the implementation of the IHostedService
interface; this means that all project types, including the traditional console
, now have option for graceful shutdown should your application require this (cronjob scenarios or similar).
It is, by heart, free, flexible and built to extend and boost your agile codebelt.
Codebelt.Bootstrapper.Worker
An implementation optimized for worker
services.
Related Packages
- Codebelt.Bootstrapper 📦
- Codebelt.Bootstrapper.Console 📦
- Codebelt.Bootstrapper.Web 📦
- Codebelt.Bootstrapper.Worker 📦
CSharp Example
An example on how to use Codebelt.Bootstrapper.Worker
in C#:
// --- Program.cs ---
public class Program : WorkerProgram<Startup>
{
static async Task Main(string[] args)
{
await CreateHostBuilder(args)
.Build()
.RunAsync()
.ConfigureAwait(false);
}
}
// --- Startup.cs ---
public class Startup : WorkerStartup
{
public Startup(IConfiguration configuration, IHostEnvironment environment) : base(configuration, environment)
{
}
public override void ConfigureServices(IServiceCollection services)
{
services.AddHostedService<FakeHostedService>();
}
}
// --- FakeHostedService.cs ---
public class FakeHostedService : BackgroundService
{
private readonly ILogger<FakeHostedService> _logger;
private bool _gracefulShutdown;
public FakeHostedService(ILogger<FakeHostedService> logger)
{
_logger = logger;
BootstrapperLifetime.OnApplicationStartedCallback = () => logger.LogInformation("Started");
BootstrapperLifetime.OnApplicationStoppingCallback = () =>
{
_gracefulShutdown = true;
logger.LogWarning("Stopping and cleaning ..");
Thread.Sleep(TimeSpan.FromSeconds(5)); // simulate graceful shutdown
logger.LogWarning(".. done!");
};
BootstrapperLifetime.OnApplicationStoppedCallback = () => logger.LogCritical("Stopped");
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
while (!stoppingToken.IsCancellationRequested)
{
if (_gracefulShutdown) { return; }
_logger.LogInformation("Worker running at: {time}", DateTimeOffset.UtcNow.ToString("O"));
await Task.Delay(TimeSpan.FromSeconds(2), stoppingToken);
}
}
}
And the minimal equivalent example on how to use Codebelt.Bootstrapper.Worker
in C#:
// --- Program.cs ---
public class Program : MinimalWorkerProgram
{
static Task Main(string[] args)
{
var builder = CreateHostBuilder(args);
builder.Services.AddHostedService<FakeHostedService>();
var host = builder.Build();
return host.RunAsync();
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
-
net8.0
- Codebelt.Bootstrapper (>= 3.0.0)
-
net9.0
- Codebelt.Bootstrapper (>= 3.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
3.0.0 | 78 | 11/13/2024 |
3.0.0-rc.1 | 48 | 11/11/2024 |
3.0.0-preview.2 | 49 | 10/13/2024 |
3.0.0-preview.1 | 45 | 10/7/2024 |
2.0.0 | 97 | 9/8/2024 |
1.3.0 | 185 | 2/11/2024 |
1.2.0 | 200 | 12/15/2023 |
1.1.0 | 640 | 11/9/2022 |
1.0.1 | 335 | 12/29/2021 |
1.0.0 | 422 | 5/7/2021 |
Version 3.0.0
Availability: .NET 9 and .NET 8
# ALM
- CHANGED Dependencies to latest and greatest with respect to TFMs
- REMOVED Support for TFM .NET 6 (LTS)
# New Features
- ADDED MinimalWorkerProgram class in the Codebelt.Bootstrapper.Worker namespace that is the entry point of an application optimized for worker applications
Version: 2.0.0
Availability: .NET 6.0 and .NET 8.0
# ALM
- REMOVED TFM for net7.0
- CHANGED Dependencies to latest and greatest with respect to TFMs
Version: 1.3.0
Availability: .NET 6.0, .NET 7.0, .NET 8.0
# ALM
- CHANGED Dependencies to latest and greatest
Version: 1.2.0
Availability: .NET 6.0, .NET 7.0, .NET 8.0
# ALM
- ADDED TFM for net8.0
- CHANGED Dependencies to latest and greatest with respect to TFMs
Version: 1.1.0
Availability: .NET 6.0, .NET 7.0
# ALM
- ADDED TFM for .NET 7
- CHANGED Dependencies to latest and greatest with respect to TFM
Version: 1.0.1
Availability: .NET 5.0, .NET 6.0
# ALM
- ADDED TFM for .NET 6
- CHANGED Dependencies to latest and greatest with respect to TFM
Version: 1.0.0
Availability: .NET 5.0
# New Features
- ADDED HostBuilderExtensions class in the Codebelt.Bootstrapper.Worker namespace that consist of extension methods for the IHostBuilder interface: UseWorkerStartup
- ADDED WorkerProgram class in the Codebelt.Bootstrapper.Worker namespace that is the base entry point of an application responsible for registering its WorkerStartup partner
- ADDED WorkerStartup interface in the Codebelt.Bootstrapper.Worker namespace that provides the base class of a conventional based Startup class for a console application