OxCore.QuantumQueue.Core 9.0.8

🌀 OxCore.QuantumQueue

OxCore.QuantumQueue is a lightweight, CRON-based job scheduler for .NET applications. Designed to be modular and developer-friendly, it lets you easily run background tasks with precise control over execution timing.

📦 Installation

Install the NuGet package:

.NET CLI

dotnet add package OxCore.QuantumQueue.Core --version 9.0.8

Package Manager

Install-Package OxCore.QuantumQueue.Core --version 9.0.8

⚙️ Getting Started

To start using OxCore.QuantumQueue, follow these steps in your .NET Core app.

1⃣ Register Services

Add the following in your Program.cs:

builder.Services.OxCoreService(builder.Configuration);

This registers all required services and job dependencies into the DI container.

2⃣ Configure Jobs in appsettings.json

Use a simplified format to declare CRON intervals:

"SchedulerSettings": {
  "Enabled": true,
  "Jobs": {
    "SampleJob": {
      "Enabled": true,
      "Expression": "*/1 * * * *"
    },
    "DataSyncJob": {
      "Enabled": true,
      "Expression": "*/2 * * * *"
    }
  }
}

3⃣ Create a Job

Implement the ConfigurableJobBase<T> and IJob interface to define a recurring background task:

using OxCore.QuantumQueue;

public class SampleJob : ConfigurableJobBase<SampleJob>, IJob
{
    public SampleJob(Func<string, ILogger> getLogger, IOptionsMonitor<SchedulerSettings> jobOptions)
        : base(getLogger, jobOptions) { }

    public async Task ExecuteAsync(CancellationToken cancellationToken)
    {
        Logger.LogInformation($"[SampleJob] Executed at: {DateTime.Now} with interval: {Interval}");
        await Task.Delay(30000, cancellationToken);
    }
}

🧪 Example: Data Sync Job

public class DataSyncJob : ConfigurableJobBase<DataSyncJob>, IJob
{
    public DataSyncJob(Func<string, ILogger> getLogger, IOptionsMonitor<SchedulerSettings> jobOptions)
        : base(getLogger, jobOptions) { }

    public async Task ExecuteAsync(CancellationToken cancellationToken)
    {
        Logger.LogInformation($"[DataSyncJob] Executed at: {DateTime.Now} with interval: {Interval}");
        await MySyncService.SynchronizeAsync();
    }
}

4⃣ Register the Job

You do not need to manually register your job; it is automatically discovered and registered by the application.

⏰ CRON Expression Guide

Examples:

• */5 * * * * – every 5 minutes
• 0 0 * * * – every day at midnight
• 0 12 * * 1 – every Monday at 12:00 PM

Use crontab.guru to generate or validate CRON expressions.

🔐 Scoped Job Dependency Support

You can inject services inside your jobs using constructor injection:

public class EmailJob : ConfigurableJobBase<EmailJob>, IJob
{
    private readonly IEmailService _emailService;

    public EmailJob(Func<string, ILogger> getLogger, IOptions<JobSettings> jobOptions, IEmailService emailService)
        : base(getLogger, jobOptions) 
    {
        _emailService = emailService;    
    }

    public async Task ExecuteAsync(CancellationToken cancellationToken)
    {
        await _emailService.SendScheduledEmailsAsync();
    }
}

Make sure to register the dependency in Program.cs:

builder.Services.AddScoped<IEmailService, EmailService>();

🧹 Features

• ✅ Simple setup and lightweight design
• ⏱️ Flexible CRON-based scheduling
• ♻️ Supports scoped DI with ConfigurableJobBase<FirstJob> and IJob
• 🥵 Thread-safe and cancellation-aware
• 🔄 Automatically discovers and runs all registered jobs
• 🧪 Testable architecture with modular components

🛠️ Advanced Configuration (coming soon)

Custom options for:

• Retry policies
• Error handling strategies
• Dynamic job enable/disable
• Job health monitoring

Stay tuned for future releases!

🧼 Best Practices

• Avoid blocking threads (use async/await)
• Use logging to trace job runs
• Wrap your job logic in try-catch blocks to prevent silent failures

📄 License

This project is licensed under the MIT License.

🤝 Contributing

We welcome community contributions! GitHub.

To contribute:

1. Fork the repo
2. Create a new feature branch
3. Submit a pull request

Created with ❤️ by OxCore Team (Prabuddha Jayawardhana)