Pilgaard.BackgroundJobs
7.1.2
Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Pilgaard.BackgroundJobs --version 7.1.2
NuGet\Install-Package Pilgaard.BackgroundJobs -Version 7.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Pilgaard.BackgroundJobs" Version="7.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Pilgaard.BackgroundJobs --version 7.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Pilgaard.BackgroundJobs, 7.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Pilgaard.BackgroundJobs as a Cake Addin
#addin nuget:?package=Pilgaard.BackgroundJobs&version=7.1.2
// Install Pilgaard.BackgroundJobs as a Cake Tool
#tool nuget:?package=Pilgaard.BackgroundJobs&version=7.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Pilgaard.BackgroundJobs
Easily create jobs that run in the background, with multiple different scheduling methods:
- Cron Expressions
- Recurringly at a set interval
- Absolute time
Installing
With the dotnet CLI:
dotnet add package Pilgaard.BackgroundJobs
Or through Visual Studio or Rider.
Usage
Make BackgroundJobs by implementing one of these interfaces:
ICronJob
IRecurringJob
IOneTimeJob
public class CronJob : ICronJob
{
public Task RunJobAsync(CancellationToken cancellationToken = default)
{
Console.WriteLine("Time to backup your databases!");
return Task.CompletedTask;
}
public CronExpression CronExpression => CronExpression.Parse("0 3 * * *");
}
public class RecurringJob : IRecurringJob
{
public Task RunJobAsync(CancellationToken cancellationToken = default)
{
Console.WriteLine("This is your hourly reminder to stay hydrated.");
return Task.CompletedTask;
}
public TimeSpan Interval => TimeSpan.FromHours(1);
}
public class OneTimeJob : IOneTimeJob
{
public Task RunJobAsync(CancellationToken cancellationToken = default)
{
Console.WriteLine("Happy New Year!");
return Task.CompletedTask;
}
public DateTime ScheduledTimeUtc => new(year: 2023, month: 12, day: 31, hour: 23, minute: 59, second: 59);
}
Registration
Call AddBackgroundJobs()
on an IServiceCollection
, and then add jobs:
builder.Services.AddBackgroundJobs()
.AddJob<SampleCronJob>()
.AddJob<SampleRecurringJob>()
.AddJob<SampleScheduledJob>();
You can also register jobs in-line for simple use-cases:
builder.Services.AddBackgroundJobs()
.AddJob(
name: "basic-cronjob",
job: () => {},
cronExpression: CronExpression.Parse("* * * * *"))
.AddJob(
name: "basic-recurringjob",
job: () => {},
interval: TimeSpan.FromSeconds(3))
.AddJob(
name: "basic-onetimejob",
job: () => {},
scheduledTimeUtc: DateTime.UtcNow.AddHours(1))
.AddAsyncJob(
name: "async-cronjob",
job: cancellationToken => Task.CompletedTask,
cronExpression: CronExpression.Parse("* * * * *"))
.AddAsyncJob(
name: "async-recurringjob",
job: cancellationToken => Task.CompletedTask,
interval: TimeSpan.FromSeconds(3))
.AddAsyncJob(
name: "async-onetimejob",
job: cancellationToken => Task.CompletedTask,
scheduledTimeUtc: DateTime.UtcNow.AddHours(1));
Thanks to
The developers of Cronos for their excellent Cron expression library.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Cronos (>= 0.7.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 3.1.18)
- Microsoft.Extensions.Hosting (>= 3.1.18)
- Microsoft.Extensions.Hosting.Abstractions (>= 3.1.18)
- Microsoft.Extensions.Logging.Abstractions (>= 3.1.18)
- System.Diagnostics.DiagnosticSource (>= 7.0.2)
-
net7.0
- Cronos (>= 0.7.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 7.0.0)
- Microsoft.Extensions.Hosting (>= 7.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 7.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 7.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.