Philiprehberger.BackgroundTaskQueue
v0.1.8932 downloadsMIT
Simple in-memory background job queue for ASP.NET Core with concurrency control.
$
dotnet add package Philiprehberger.BackgroundTaskQueueREADME
Philiprehberger.BackgroundTaskQueue
Simple in-memory background job queue for ASP.NET Core with concurrency control.
Installation
dotnet add package Philiprehberger.BackgroundTaskQueue
Usage
Register the queue
using Philiprehberger.BackgroundTaskQueue;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddBackgroundTaskQueue(options =>
{
options.MaxConcurrency = 4;
options.MaxQueueSize = 100;
options.OnError = ex => Console.Error.WriteLine($"Background task failed: {ex}");
});
var app = builder.Build();
app.Run();
Enqueue work from a controller
using Microsoft.AspNetCore.Mvc;
using Philiprehberger.BackgroundTaskQueue;
[ApiController]
[Route("api/[controller]")]
public class ReportsController : ControllerBase
{
private readonly IBackgroundTaskQueue _queue;
public ReportsController(IBackgroundTaskQueue queue) => _queue = queue;
[HttpPost]
public IActionResult Generate()
{
_queue.Enqueue(async ct =>
{
// Long-running work here
await Task.Delay(5000, ct);
}, name: "generate-report");
return Accepted();
}
}
Default options (sequential, unbounded)
builder.Services.AddBackgroundTaskQueue();
API
IBackgroundTaskQueue
| Member | Description |
|---|---|
Enqueue(Func<CancellationToken, Task>) | Adds a work item to the queue |
Enqueue(Func<CancellationToken, Task>, string?) | Adds a named work item to the queue |
DequeueAsync(CancellationToken) | Waits for and returns the next work item |
Count | Number of items currently in the queue |
BackgroundQueueOptions
| Property | Default | Description |
|---|---|---|
MaxConcurrency | 1 | Maximum concurrent work items |
MaxQueueSize | 0 | Max queue capacity (0 = unbounded) |
OnError | null | Callback invoked when a work item throws |
ServiceCollectionExtensions
| Method | Description |
|---|---|
AddBackgroundTaskQueue(Action<BackgroundQueueOptions>?) | Registers queue and hosted service |
Development
dotnet build src/Philiprehberger.BackgroundTaskQueue.csproj --configuration Release
Support
If you find this project useful: