Pilgaard.BackgroundJobs 7.2.2

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.