AspNetCore.SignalR.NCache 5.3.800

AspNetCore.SignalR.NCache

NCache Backplane Provider for ASP.NET Core SignalR applications. This package lets you use NCache as a scale-out backplane for SignalR, enabling real-time messages to be reliably broadcast across multiple SignalR server instances in a web farm — so clients connected to different servers still receive the same messages.

Installation

Install-Package AspNetCore.SignalR.NCache

or, using the .NET CLI:

dotnet add package AspNetCore.SignalR.NCache

Prerequisites

• .NET 6.0+ Application.
• NCache SDK 5.3.800 or later.
• An NCache 5.3.800 (or later) server should be up and running, with the target cache already created/registered on it.

Getting Started

Setting up NCache

1. Open your application's configuration file:
   • .NET / ASP.NET Core: appsettings.json
   • .NET Framework / ASP.NET: app.config or web.config
2. Add an entry for the cache you created on the NCache server, keyed by the cache's name. The example uses defaultCache; replace it with your cache's name.
3. Set server to one or more nodes of the cluster where that cache is running. Separate multiple nodes with commas.

appsettings.json

{
  "ncache": {
    "defaultCache": {
      "server": "20.200.20.24,20.200.20.25",
      "port": 9800
    }
  }
}

app.config / web.config

<configuration>
  <configSections>
    <section name="ncache" type="Alachisoft.NCache.Client.NCacheSection, Alachisoft.NCache.Client" />
  </configSections>
  <ncache>
    <caches>
      <add name="defaultCache" server="20.200.20.24,20.200.20.25" port="9800" />
    </caches>
  </ncache>
</configuration>

The cache name in the configuration must match the name you pass in code:

ICache cache = CacheManager.GetCache("defaultCache");

Setting up Package

Modify Program.cs to configure SignalR to use NCache as a backplane:

using Alachisoft.NCache.AspNetCore.SignalR;

var builder = WebApplication.CreateBuilder(args);

// Bind NCache configuration section
builder.Services.Configure<NCacheConfiguration>(
    builder.Configuration.GetSection("NCacheConfiguration"));

// Register SignalR with NCache backplane
builder.Services.AddSignalR().AddNCache(ncacheOptions =>
{
    ncacheOptions.CacheName = builder.Configuration["NCacheConfiguration:CacheName"];
    ncacheOptions. EventKey = builder.Configuration["NCacheConfiguration: EventKey"];
});

var app = builder.Build();

// Map your SignalR hub endpoint directly 
app.MapHub<YourSignalRHub>("/your-hub");

app.Run();

Configuration

ASP.NET Core (appsettings.json):

{
  "NCacheConfiguration": {
    "CacheName": "defaultCache",
    "EventKey": "chat",
  }
}

Adjust cache name and other settings as needed for your environment.

Resources

• NCache Integration Docs
• Client SDK Docs
• Sample Code on GitHub
• Programmer's Guide

Technical Support

Alachisoft provides various technical support resources.

Visit the Alachisoft Support Center to select a support resource appropriate for your issue. To request additional features or report a documentation discrepancy, contact support@alachisoft.com.

License

Copyright © 2026 Alachisoft. All rights reserved.