Centeva.Hangfire.HangfireScheduler 1.0.4

Centeva.Hangfire.HangfireScheduler

Provides abstractions and base implementations for configuring, scheduling, and managing Hangfire background tasks in .NET 8+ applications. Includes support for dependency injection and customizable task registration for both web and background processing scenarios.

Features

• Base class for defining and registering Hangfire background tasks
• Extension methods for easy DI registration
• Support for custom Hangfire task implementations
• Designed for .NET 8 and modern dependency injection patterns

Installation

Add the NuGet package to your project:

dotnet add package Centeva.Hangfire.HangfireScheduler

Usage

1. Register Services in Dependency Injection

In your application's startup code (e.g., Program.cs or Startup.cs), register the scheduler and your custom tasks as singleton services:

using Centeva.Hangfire.HangfireScheduler;
// Register the HangfireScheduler as a singleton services.AddHangfireScheduler();
// Register your concrete HangfireTasks implementation as a singleton services.AddHangfireTasks<MyHangfireTasks>();

Note: Most applications will register both HangfireScheduler and their own implementation of IHangfireTasks as singletons using the provided extension methods (AddHangfireScheduler and AddHangfireTasks<T>). If you do not use these extension methods, you must register these services manually in your dependency injection setup.

2. Implement Your Hangfire Tasks

Create a class that inherits from HangfireTasks and implements the required RegisterTasks method:

public class MyHangfireTasks : HangfireTasks
{
    public MyHangfireTasks(IServiceProvider sp, IOptions<IHangfireConfig> config) : base(sp, config) { }
    public override void RegisterTasks()
    {
        // Register your recurring or background jobs here
    }
}

3. Configuration

Implement the IHangfireConfig interface to provide configuration options for Hangfire, such as enabling/disabling jobs and dashboard access.

public class MyHangfireConfig : IHangfireConfig
{
    public bool Enabled { get; init; }
    public string[] DashboardAccess { get; init; }
    public string ConfigurationKey => "Hangfire"; 
}

Note: The ConfigurationKey property in your IHangfireConfig implementation determines which section of your appsettings.json is used for Hangfire configuration. By default, it is set to "Hangfire", but you can override this property if your configuration section uses a different name.

Extension Methods

• AddHangfireScheduler()
  Registers the HangfireScheduler as a singleton.

• AddHangfireTasks<T>()
  Registers your concrete implementation of HangfireTasks and IHangfireTasks as singletons.

Best Practices

• Always register HangfireScheduler and your IHangfireTasks implementation as singletons.
• Use the provided extension methods for consistent and easy DI setup.
• Use the configuration interface to control job enablement and dashboard access.

Dependencies

• Hangfire.Core
• Microsoft.Extensions.DependencyInjection
• Microsoft.Extensions.Options
• Centeva.PrincipalProvider

License

See LICENSE for details.