AspNet.SessionState.NCache 5.3.7

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

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.
• NCache SDK 5.3.7.1 or later.
• 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

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.

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.