AspNet.SignalR.NCache 5.3.800

AspNet.SignalR.NCache

NCache Backplane Provider for ASP.NET 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 AspNet.SignalR.NCache

or, using the .NET CLI:

dotnet add package AspNet.SignalR.NCache

Prerequisites

• .NET Framework 4.6.2+ 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

Register NCache as the SignalR backplane in your OWIN Startup class:

// Specify the OWIN startup class
[assembly: OwinStartup(typeof(YourApp.Startup))]

namespace YourApp
{
    /// <summary>
    /// Startup class to configure SignalR with NCache backplane
    /// </summary>
    public class Startup
    {
        /// <summary>
        /// Method to configure SignalR and NCache backplane
        /// </summary>
        /// <param name="app">The OWIN application builder.</param>
        public void Configuration(IAppBuilder app)
        {
            // Read NCache configuration settings from Web.config
            string cache = ConfigurationManager.AppSettings["cache"];
            string eventKey = ConfigurationManager.AppSettings["eventKey"];
            string userId = ConfigurationManager.AppSettings["userID"];
            string password = ConfigurationManager.AppSettings["password"];

            // Configure NCache as the backplane for SignalR
            GlobalHost.DependencyResolver.UseNCache(cache, eventKey, userId, password);

            // Map SignalR hubs (i.e., ChatHub) to the app builder pipeline
            app.MapSignalR();
        }
    }
}

Configuration

ASP.NET (Web.config): Add the configSections tag in <configuration> as follows:

<configuration>
  <configSections>
    <section name="ConnectionOptions"
    type="Alachisoft.NCache.AspNet.SignalR.SignalRConnectionOptions"/>
 </configSections>
</configuration>

Add the ConnectionOptions section in <configuration> to set different properties to be used at the time of client connection with the cache. For a detailed description of parameters provided in the ConnectionOptions object, refer to CacheConnectionOptions Properties.

<configuration>
  <ConnectionOptions ClientBindIp="" AppName="DemoAppName" EnableClientLogs="false" LogLevel="info"/>
    <Server name="20.200.21.39" port="9800"/>
    <UserCredentials userID="john doe" password="1234"/>
 </ConnectionOptions>
</configuration>

Add appSettings section specifying cacheName and eventKey in <configuration> as follows:

<appSettings>
  <add key="cache" value="YourCacheName"/>
  <add key="eventKey" value="chatApplication"/>
</appSettings>

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.