NCache.OSS.Hangfire 5.3.6.2

NCache Storage Provider for Hangfire

An NCache implementation of Hangfire job storage, backing queues, job data, state, and server registration with an NCache cluster instead of SQL Server or Redis.

This package plugs into Hangfire's JobStorage abstraction, so it can be used as a drop in storage provider anywhere Hangfire is configured including across multiple worker instances in a web farm, with jobs, queues, and state shared through the NCache cluster.

Features

• Distributed Queues: FIFO job queues backed by NCache, with pub/sub driven wake up so workers are notified as jobs are enqueued instead of relying solely on polling.
• Distributed Locking: Job state changes, counters, and queue mutations are coordinated through NCache backed distributed locks, safe across multiple server processes.
• Server Registration & Heartbeats: Each Hangfire server announces itself, its queues, and its worker count into the cache, with automatic cleanup of servers that stop heartbeating.
• Fetched Job Recovery: An orphan recovery process requeues jobs left in a "processing" state past the configured invisibility timeout, e.g. after a server crash.
• Pub/Sub with Polling Fallback: Falls back to interval polling automatically if pub/sub notifications are disabled or unavailable.

Installation

dotnet add package NCache.OSS.Hangfire

Requirements

• .NET Standard 2.0 / .NET Framework 4.6.2 or higher
• An NCache client connection (Alachisoft.NCache.Client) to a running NCache OSS cache/cluster
• References Hangfire.Core (1.8.24) and Alachisoft.NCache.Opensource.SDK

Usage

Point the client at your server

Set your NCache server IP in client.ncconf (copied to the output directory on build):

<cache id="myCache" enable-client-logs="False" log-level="error">
    <server name="YOUR_SERVER_IP"/>
</cache>

cache id must match the cache name you use in code. A config.ncconf ships alongside it holding cache-side settings.

Register NCache as the job storage

var cacheName = builder.Configuration.GetValue<string>("NCache:CacheName") ?? "myCache";

builder.Services.AddHangfire(config => config
    .UseNCacheStorage(cacheName));
 

• First argument: your NCache cache name.

Configuration

To tune queue polling, lock timing, or terminal-state list sizes, pass an NCacheStorageOptions instance:

var storageOptions = new NCacheStorageOptions
{
    QueuePollInterval = TimeSpan.FromSeconds(60),
    InvisibilityTimeout = TimeSpan.FromMinutes(5),
    DistributedLockTimeout = TimeSpan.FromSeconds(30),
    LockAcquireMaxWait = TimeSpan.FromSeconds(15),
    EnablePubSubNotifications = true,
    SucceededListSize = 10000,
    DeletedListSize = 1000,
    FailedListSize = 1000
};

builder.Services.AddHangfire(config => config
    .UseNCacheStorage(cacheName, storageOptions));

Important

If NCache is not installed on the machine, you must ensure that client.ncconf and config.ncconf contain all required configuration information.

Documentation

• NCache Programmer Guide
• NCache Documentation
• Hangfire Documentation

Technical Support

Alachisoft® provides various sources of technical support.

• Refer to http://www.alachisoft.com/support.html to select a support resource suited to your issue.
• To request additional features, or report a discrepancy in this document, email support@alachisoft.com.

License

Copyrights 2026: Alachisoft, all rights reserved.