AspNet.SessionState.NCache 5.3.800

AspNet.SessionState

NCache Session State Provider for ASP.NET applications. This package lets you offload ASP.NET session state storage to NCache, giving you a fast, distributed, and highly available alternative to InProc, StateServer, or SQL Server session modes — enabling your application to scale out across multiple web servers while keeping session data consistent.

Installation

Install-Package AspNet.SessionState.NCache

or, using the .NET CLI:

dotnet add package AspNet.SessionState.NCache

Prerequisites

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

1. Register NCache as the session state provider:
   • ASP.NET Framework — update web.config (see Configuration section below).

Configuration

ASP.NET Framework (web.config):

<system.web>
  <sessionState
    mode="Custom"
    customProvider="NCacheSessionProvider">
    <providers>
      <add name="NCacheSessionProvider" type="Alachisoft.NCache.Web.SessionState.NSessionStoreProvider" exceptionsEnabled="true" enableSessionLocking="true" enableSessionSharing="false" emptySessionWhenLocked="false" sessionLockingRetry="-1" sessionAppId="NCacheSharedSessionApp" useInProc="false" enableLogs="false" cacheName="YourCacheName" writeExceptionsToEventLog="false" AsyncSession="false"/>
    </providers>
  </sessionState>
</system.web>

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

The cookieSameSite setting is applied when the server runs .NET Framework 4.7.2 or later (where HttpCookie.SameSite exists); on an older framework it is ignored.

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.