AspNet.SignalR.NCache 5.3.7

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

What is Installed

Installing this package adds the following NCache configuration files to your project:

• client.ncconf — Defines the cache client settings, including the cache name and the list of server nodes the client connects to.
• config.ncconf — Contains the cache configuration (cache topology, partitions, eviction policy, etc.) used when the cache is created/registered.
• tls.ncconf — Contains TLS/SSL settings used to secure communication between the client and the NCache cluster, if enabled.

Prerequisites

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

Getting Started

Setting up NCache

Before running your application (if NCache is not installed on the current machine), you need to update client.ncconf so the client knows which cache to connect to and where to find it:

1. Open client.ncconf.
2. Locate the cache entry named myCache and rename it to the name of your actual cache (the cache you created/registered on the NCache server).
3. Under the server settings, update the server address to point to one of the nodes in the cluster where that cache is running.

Example:

<cache id="myCache" ... >
  <server name="10.0.0.1" ... />
</cache>

Change myCache → YourCacheName, and 10.0.0.1 → the IP/hostname of a node hosting YourCacheName.

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
• 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.