Unidevel.Extensions.Hosting
0.9.3
Install-Package Unidevel.Extensions.Hosting -Version 0.9.3
dotnet add package Unidevel.Extensions.Hosting --version 0.9.3
<PackageReference Include="Unidevel.Extensions.Hosting" Version="0.9.3" />
paket add Unidevel.Extensions.Hosting --version 0.9.3
#r "nuget: Unidevel.Extensions.Hosting, 0.9.3"
// Install Unidevel.Extensions.Hosting as a Cake Addin
#addin nuget:?package=Unidevel.Extensions.Hosting&version=0.9.3
// Install Unidevel.Extensions.Hosting as a Cake Tool
#tool nuget:?package=Unidevel.Extensions.Hosting&version=0.9.3
Synopsis
Provides full-flavour implementation of reliable background service with Serilog logging and environment dependent configuration.
Code Example
Hosting SafeBackgroundService (and other IHostServices)
class SafeProgram : SafeProgramBase<HostedServiceLikeSafeBackgroundService>
{
protected override void ConfigureServices(HostBuilderContext hostContext, IServiceCollection services)
{
services
.AddSingleton<ISomeService, SomeServiceImpl>();
// do not add HostedService to services, it has already been added
}
public static void Main(string[] args)
{
new SafeProgram().run();
}
}
Implementing SafeBackgroundService
To use this class you should override at least one of following methods:
protected abstract Task ConnectAsync(CancellationToken cancellationToken);
protected abstract Task DisconnectAsync();
protected abstract Task ExecuteIterationAsync(CancellationToken cancellationToken);
You also need to provide ISafeBackgroundServicePanicHandler to the constructor if you don't use SafeProgramBase. If you do use SafeProgramBase, it will be automatically provided and will stop all services when one of them raised panic event.
Motivation
When creating long-running background services you have to deal with failures caused by environment like network failure, SQL timeout or other. Most of those conditions are temporary and should not cause service failure.
This implementation separates small failures (wait and try again) and big failures (stop, wait, initialize and try again).
Installation
Use NuGet.
API Reference
Look at code example should be enough.
Tests
Not included in this release (but be patient, I'll migrate it later)
Contributors
Every contributor is welcome here. But keep it simple.
License
I like MIT licence for my work, so this one will be used.
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows |
.NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETStandard 2.0
- Microsoft.Extensions.Configuration.CommandLine (>= 3.0.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 3.0.0)
- Microsoft.Extensions.Configuration.Json (>= 3.0.0)
- Microsoft.Extensions.Hosting (>= 3.0.0)
- Microsoft.Extensions.Logging (>= 3.0.0)
- Serilog (>= 2.8.0)
- Serilog.Extensions.Logging (>= 3.0.1)
- Serilog.Settings.Configuration (>= 3.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.