Configure ASP.NET Core IDistributedCache

You can also use ASP.NET Core sessions with NCache’s IDistributedCache Provider. ASP.NET Core provides the AddDistributedMemoryCache() method to add a default implementation of IDistributedCache. However, to utilize NCache as a distributed cache to store ASP.NET sessions or objects, NCache provides its own extension method, AddNCacheDistributedCache(), which adds NCache as the default distributed cache as an implementation of IDistributedCache.

Install NuGet Package

Important

For NCache Version >= 5.0, use ASP.NET Core version 3.1.

Install the NuGet package NCache.Microsoft.Extensions.Caching Enterprise/Professional to your application by executing the following command in the Package Manager Console:

  • For Enterprise:
Install-Package NCache.Microsoft.Extensions.Caching
  • For Professional:
Install-Package NCache.Microsoft.Extensions.Caching.Professional
  • For OpenSource:
Install-Package NCache.Microsoft.Extensions.Caching.OpenSource

Include Namespaces

To utilize the APIs, include the following namespace in your application in Startup.cs of your application:

using Alachisoft.NCache.Caching.Distributed;

You can configure NCache as a distributed cache for your ASP.NET Core application in two steps:

  1. Configuring services
  2. Adding middleware to the application

Step 1: Configure Services

NCache provides the AddNCacheDistributedCache() extension method on IServiceCollection, which requires just a cache name in NCache and any optional configurations to store the sessions. The configuration object is the same as NCache ASP.NET Core Session Provider, which can be initialized similarly. The configuration can be provided through IOptions initializer as well.

There are two methods to specify configurations:

  • Through your application in Startup.cs or
  • In JSON format in Appsettings.json of your application.

Method 1: Specifying Configurations In Startup.cs

Configure Startup.cs for Single Cache:

The AddNCacheDistributedCache() method is an extension of the AddDistributedCache() method provided by ASP.NET Core. This method takes configuration settings in Startup.cs of your application, or reads them from the specified JSON file.

Add the following method and options in Startup.cs of your application:

public void ConfigureServices(IServiceCollection services)
{
    //Add framework services
    services.AddMvc();

    services.AddNCacheDistributedCache(configuration =>
    {
        configuration.CacheName = "demoClusteredCache";
        configuration.EnableLogs = true;
        configuration.ExceptionsEnabled = true; 
    });
}

Configure Startup.cs for Multiple Caches:

Note

This feature is for Enterprise Edition only.

The AddNCacheDistributedCacheProvider() is an extension of the AddDistributedCache() method provided by ASP.NET Core. This method takes configuration settings in the Startup.cs of your application. You can configure multiple caches using the AddNCacheDistributedCacheProvider method as follows:

public void ConfigureServices(IServiceCollection services)
{
    //Add framework services
    services.AddMvc();
    services.AddNCacheDistributedCacheProvider( options =>
             {
                options.CacheConfigurations = new NCacheConfiguration[] {
                new NCacheConfiguration() {
                    CacheName = "demoClusteredCache",
                    EnableLogs = true,
                    ExceptionsEnabled = true
                },
                new NCacheConfiguration(){
                    CacheName = "demoCache",
                    EnableLogs = true,
                    ExceptionsEnabled = true }
                }; 
             });
}

Method 2: Specifying Configurations In Appsettings.json

You can also specify the configurations within your application in JSON format in Appsettings.json of your application. Using this method, you can refer to the configurations by providing the name of the section containing JSON format configurations in Startup.cs.

Configure Appsettings.json for Single Cache: Configure the Appsettings.json file of your application as follows to configure a single cache.

{
  "AppSettings": {
    "SiteTitle": "ASP.NET MVC Music Store",
    "CacheDbResults": true,
  },

  "NCacheSettings": {
    "CacheName": "demoClusteredCache",
    "EnableLogs": "True",
    "RequestTimeout": "90"
  },
}

Refer these configurations in the Startup.cs as follows:

public void ConfigureServices(IServiceCollection services)
{
    //Add framework services
    services.AddMvc();

    //Add services to the container
    services.AddNCacheDistributedCache(Configuration.GetSection("NCacheSettings")); 

    services.AddSession();
}

Configure Appsettings.json for Multiple Caches:

Note

This feature is for Enterprise Edition only.

Configure the Appsettings.json file of your application as follows to configure a multiple caches.

"NCacheFactorySettings": {
    "NCacheConfigurations": [
        {
            "CacheName": "demoClusteredCache",
            "EnableLogs": true,
            "RequestTimeout": "90" 
        },
        {
            "CacheName": "demoCache",
            "EnableLogs": true,
            "RequestTimeout": "90"
        },
        {
            // Configure more caches
        }
    ]
}

Use the AddNCacheDistributedCacheProvider method to refer the NCacheFactorySettings section in Startup.cs:

public void ConfigureServices(IServiceCollection services)
{
    //Add framework services
    services.AddMvc();

    //Add services to the container
    services.AddNCacheDistributedCacheProvider(_config.GetSection("NCacheFactorySettings")); 

    services.AddSession();
}

Step 2: Add Middleware to Application

Once the distributed cache has been added to the service, sessions can store the data in NCache. UseSession() extension method provided by ASP.NET Core will add the default session middleware to the application but will utilize NCache as its cache.

You can now proceed to use NCache as the underlying cache for your ASP.NET Core sessions.

Configuration Properties

Configurations specific to Distributed Caching are explained below:

Refer to the CacheConnectionOptions API Documentation for more detail on properties of this class.

Member Type Description Default Value
CacheName string (required) Specifies the name of the cache to be used for caching session. If no cache name is specified, a configuration exception will be thrown. -
EnableLogs bool (optional) If this flag is set, NCache logs all error information. The log files are created in %NCHOME%/log-files/SessionState (Windows) or \opt\ncache\log-files\SessionState (Linux). false
EnableDetailLogs bool (optional) When this flag is set, NCache logs all debugging information. The log files are created in %NCHOME%/log-files/SessionState (Windows) or \opt\ncache\log-files\SessionState (Linux). false
ExceptionsEnabled bool (optional) Specifies whether exceptions from cache API are propagated to the page output. Setting this flag is especially helpful during development phase of application, since exceptions provide more information about the specific causes of failure. false
WriteExceptionsToEventLog bool (optional) If this flag is set, all the exceptions from cache API are written to event logs. false
RequestTimeout int Specifies the timeout for client requests in seconds. 90
OperationsRetry int (optional) Specifies the number of times server retries an operation in case connection is lost while executing an operation. 0
OperationRetryInterval int (optional) Specifies the time interval between each operation retry. 0

See Also

Using NCache with ASP.NET Core
Configure NCache ASP.​NET Core Session Provider
Multi-Region ASP.​NET Core Session Provider for NCache
Object Caching in ASP.​NET Core
ASP.NET Core Response Caching