Scaleout.AspNetCore 1.1.0-beta

This is a prerelease version of Scaleout.AspNetCore.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Scaleout.AspNetCore --version 1.1.0-beta                
NuGet\Install-Package Scaleout.AspNetCore -Version 1.1.0-beta                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Scaleout.AspNetCore" Version="1.1.0-beta" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Scaleout.AspNetCore --version 1.1.0-beta                
#r "nuget: Scaleout.AspNetCore, 1.1.0-beta"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Scaleout.AspNetCore as a Cake Addin
#addin nuget:?package=Scaleout.AspNetCore&version=1.1.0-beta&prerelease

// Install Scaleout.AspNetCore as a Cake Tool
#tool nuget:?package=Scaleout.AspNetCore&version=1.1.0-beta&prerelease                

ScaleOut ASP.NET Core Distributed Cache Library

This library provides an implementation of Microsoft.Extensions.Caching.Distributed.IDistributedCache for session state storage using ScaleOut StateServer in ASP.NET Core web applications.

NuGet: Install-Package Scaleout.AspNetCore

Quick Start

To configure your ASP.NET Core web application to use ScaleOut StateServer for session state storage:

  1. Install the Scaleout.AspNetCore NuGet package: Install-Package Scaleout.AspNetCore
  2. In an application settings file (such as appsettings.json), add the following configuration elements, replacing the example configuration values as appropriate to your environment (Configuration elements are described in further detail later in this document):
	"ScaleOutStateServer": {
		"gateways": [
		  {
			"ip": "10.0.0.100",
			"servicePort": 721
		  },
		  {
			"ip": "10.0.0.101",
			"servicePort": 721
		  }
		],
		"defaultNamespace": "HelloWorld",
		"Protocol": "SossTcpTransport"
	  }
  1. In the ConfigureServices(IServiceCollection) initialization method, add the following line(s):
	public void ConfigureServices(IServiceCollection services)
	{
		// Add framework services.
		// ...
		services.AddSession();

		// Add ScaleOut implementation of IDistributedCache.
		services.AddScaleoutDistributedCache(Configuration);
		
		// ...
	}

Note: If the application configuration file(s) use a different name than "ScaleOutStateServer" for the configuration element, you may use the AddScaleoutDistributedCache(ConfigurationSection) overload, e.g., services.AddScaleoutDistributedCache(Configuration.GetSection("MyScaleOutConfigurationSection")).

That's it! All session access (typically through HttpContext.Session) will automatically read and store session information to the ScaleOut StateServer in-memory data grid.

Configuration

Gateways (list)

REQUIRED. List of gateways to use to connect to the ScaleOut StateServer service. Each element has two values:

  1. ip (string). REQUIRED. The IP address of the gateway.
  2. servicePort (integer). Optional. The service port for the selected protocol. Default: 721 (for the SossTcpTransport provider). If the SossHttpTransport is used, the port should be changed to direct requests to the port used by the ScaleOut REST API Service (typically port 4001).

Example

"gateways": [
    {
	    "ip": "10.0.0.100",
		"servicePort": 721
    },
    {
		"ip": "10.0.0.101",
		"servicePort": 721
    }
]

DefaultNamespace (string)

REQUIRED. The name of the application namespace to use in the ScaleOut StateServer in-memory data grid.

MaxSerializedCacheMemory (integer)

Optional. The maximum size (in bytes) of the serialized network cache held in the client memory process to minimize data transfer to and from the ScaleOut StateServer service when the client is internally known to be working with the latest version of a ScaleOut StateServer data grid object. Default: 10 MB.

MaxGatewayAttempts (integer)

Optional. The number of attempts for any operation which accesses the ScaleOut StateServer data grid before throwing an exception. Default: 3.

Protocol (string)

Optional. The protocol to use when communicating between the client application and the ScaleOut StateServer service. Two protocols are currently supported:

  • SossTcpTransport (default): Connects directly to the ScaleOut service. Offers the best performance.

  • SossHttpTransport: Communicates to the ScaleOut StateServer service over HTTP via the ScaleOut REST API service.

UseSecure (boolean)

Optional. Whether to use the secure version of the selected protocol. If set to true, ensure the associated service is properly configured to accept secure requests. Default: false.

The accept_secure, secure_svr_port, and secure_mgt_port parameters must be set in the ScaleOut service to use encrypted communications with the SossTcpTransport protocol. The servicePort value in your config's gateways section must also be modified to point to the ScaleOut service's secure_svr_port.

If the SossHttpTransport protocol is to be secured, see the Configuring the REST API Service topic for details on how to enable HTTPS in the REST service.

MaxTCPPoolSize (integer)

Optional. When using the TcpGatewayTransport, gets or sets the maximum number of TCP connections that the library may open to each ScaleOut host in the data grid. The default value is 16 TCP connections per ScaleOut host.

CoherencyInterval (double)

Optional. The maximum amount of time (in seconds) that can elapse before the client library performs a round-trip to the authoritative ScaleOut service. During this interval, a requested object can be returned directly from the in-process cache, which results in very good performance, but the returned value could be stale. The default value is 0 seconds (the cache is fully coherent).

The CoherencyInterval option is only supported by the TcpGatewayTransport protocol.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.6 1,950 3/19/2023
1.1.5 4,080 2/23/2021
1.1.4 536 9/16/2020
1.1.3 1,625 8/23/2019
1.1.2 834 1/18/2019
1.1.1-beta 572 11/8/2018
1.1.0-beta 599 11/8/2018
1.0.3 941 7/20/2018
1.0.2 1,100 4/27/2018
1.0.1 1,089 4/13/2018
1.0.0 1,514 8/22/2017

Added new SossTcpTransport option for improved network performance. This is the new default connection transport--clients using the original HTTP transport are encouraged to update their config files to use the new TCP transport.

Added new CoherencyInterval configuration option, allowing stale reads to be performed for the configured period in exchange for dramatically improved performance.