Soenneker.Utils.BackgroundQueue

A bounded, single-consumer background queue for Task and ValueTask work items in hosted .NET applications.

Installation

dotnet add package Soenneker.Utils.BackgroundQueue

Registration

builder.Services.AddBackgroundQueueAsSingleton();

Registration adds the queue, its counters, and its processor as singletons, and also registers the processor as a hosted service. A normal application host starts and stops it automatically; the manual start helpers are intended for test service providers that do not run hosted services.

Optional configuration:

{
  "Background": {
    "QueueLength": 5000,
    "LockCounts": true,
    "Log": false
  }
}

• QueueLength is the bounded channel capacity. Values below 2 use the default of 5000.
• LockCounts enables per-kind counts returned by GetCountsOfProcessing(). Overall processing state and WaitUntilEmpty() remain available either way.
• Log enables per-item debug logging.

Queue work

public sealed class ImportScheduler(IBackgroundQueue queue)
{
    public ValueTask QueueImport(string path, CancellationToken cancellationToken = default)…