|
| 1 | +## Introduction |
| 2 | +SessionStateModule is ASP.NET’s default session-state handler which retrieves session data and writes it to the session-state store. It already operates asynchronously when acquiring the request state, but it doesn’t support async read/write to the session-state store. In the .NET Framework 4.6.2 release, we introduced a new interface named ISessionStateModule to enable this scenario. You can find more details on [this blog post](https://blogs.msdn.microsoft.com/webdev/2016/09/29/introducing-the-asp-net-async-sessionstate-module/). |
| 3 | + |
| 4 | +## How to build |
| 5 | +1. Open a [VS developer command prompt](https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs) |
| 6 | +2. Run build.cmd. This will build Nuget package and run all the unit tests. |
| 7 | +3. All the build artifacts will be under aspnetsessionstate\bin\Release\ folder. |
| 8 | + |
| 9 | +## Settings of the module and providers |
| 10 | + |
| 11 | ++ #### Microsoft.AspNet.SessionState.SessionStateModule |
| 12 | + |
| 13 | +1. appSetting *aspnet:RequestQueueLimitPerSession* |
| 14 | + |
| 15 | + *How to use* - Add ```<add key="aspnet:RequestQueueLimitPerSession" value="[int]"/>``` into web.config under appSettings section. |
| 16 | + |
| 17 | + *Description* - If multiple requests with same sessionid try to acquire sessionstate concurrently, asp.net only allows one request to get the sessionstate. This causes performance issues if there are too many requests with same sessionid and a request doesn't release sessionstate fast enough, as asp.net starts a timer for each of this request to acquire sessionstate every 0.5 sec by default. This is even worse, if out-proc sessionstate provider is used. Because this can potentially use most of the out-proc storage connection resources. With this setting, asp.net will ends the request after the number of concurrent requests with same sessionid reaches the configured number. |
| 18 | + |
| 19 | +2. appSetting *aspnet:AllowConcurrentRequestsPerSession* |
| 20 | + |
| 21 | + *How to use* - Add ```<add key="aspnet:AllowConcurrentRequestsPerSession" value="[int]"/>``` into web.config under appSettings section. |
| 22 | + |
| 23 | + *Description* - If multiple requests with same sessionid try to acquire sessionstate concurrently, asp.net only allows one request to get the sessionstate. With this setting, asp.net will allow multiple requests with same sessionid to acquire the sessionstate, but it doesn't guarantee thread safe of accessing sessionstate. |
| 24 | + |
| 25 | ++ #### Microsoft.AspNet.SessionState.SqlSessionStateProviderAsync |
| 26 | + |
| 27 | + The settings of this provider is located in the following configuration section in web.config. |
| 28 | +``` |
| 29 | + <sessionState cookieless="false" regenerateExpiredSessionId="true" mode="Custom" customProvider="SqlSessionStateProviderAsync"> |
| 30 | + <providers> |
| 31 | + <add name="SqlSessionStateProviderAsync" connectionStringName="DefaultConnection" UseInMemoryTable="[true|false]" MaxRetryNumber="[int]" RetryInterval="[int]" |
| 32 | + type="Microsoft.AspNet.SessionState.SqlSessionStateProviderAsync, Microsoft.AspNet.SessionState.SqlSessionStateProviderAsync, Version=1.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"/> |
| 33 | + </providers> |
| 34 | +``` |
| 35 | + |
| 36 | +1. *UseInMemoryTable* - Indicates whether to use Sql server 2016 In-Memory OLTP for sessionstate. You can find more details about using In-memory table for sessionstate [on this blog](https://blogs.msdn.microsoft.com/sqlcat/2016/10/26/how-bwin-is-using-sql-server-2016-in-memory-oltp-to-achieve-unprecedented-performance-and-scale/). |
| 37 | + |
| 38 | +2. *MaxRetryNumber* - The maximum number of retrying executing sql query to read/write sessionstate data from/to Sql server. The default value is 10. |
| 39 | + |
| 40 | +3. *RetryInterval* - The interval between the retry of executing sql query. The default value is 0.001 sec for in-memorytable mode. Otherwise the default value is 1 sec. |
| 41 | + |
| 42 | ++ #### Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync |
| 43 | + |
| 44 | + The settings of this provider is located in the following configuration section in web.config. |
| 45 | +``` |
| 46 | +<sessionState cookieless="false" regenerateExpiredSessionId="true" mode="Custom" customProvider="CosmosDBSessionStateProviderAsync"> |
| 47 | + <providers> |
| 48 | + <add name="CosmosDBSessionStateProviderAsync" cosmosDBEndPointSettingKey="cosmosDBEndPointSetting" cosmosDBAuthKeySettingKey="cosmosDBAuthKeySetting" |
| 49 | + databaseId="[DataBaseId]" collectionId="[CollectionId]" offerThroughput="5000" connectionMode="Direct" connectionProtocol="Tcp" requestTimeout="5" |
| 50 | + maxConnectionLimit="50" maxRetryAttemptsOnThrottledRequests="10" maxRetryWaitTimeInSeconds="10" preferredLocations="" partitionKey="" |
| 51 | + partitionNumUsedByProvider="" |
| 52 | + type="Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"/> |
| 53 | + </providers> |
| 54 | + </sessionState> |
| 55 | +``` |
| 56 | +1. *cosmosDBEndPointSettingKey* - The appsetting key name which points to a CosmosDB end point |
| 57 | + |
| 58 | +2. *cosmosDBAuthKeySettingKey* - The appsetting key name which points to a CosmosDB auth key |
| 59 | + |
| 60 | +3. *offerThroughput* - The offer throughput provisioned for a collection in measurement of Requests-per-Unit in the Azure DocumentDB database service. If the collection provided doesn't exist, the provider will create a collection with this offerThroughput. |
| 61 | + |
| 62 | +4. *connectionMode* - Direct | Gateway |
| 63 | + |
| 64 | +5. *connectionProtocol* - Https | Tcp |
| 65 | + |
| 66 | +6. *requestTimeout* - The request timeout in seconds when connecting to the Azure DocumentDB database service. |
| 67 | + |
| 68 | +7. *maxConnectionLimit* - maximum number of concurrent connections allowed for the target service endpoint in the Azure DocumentDB database service. |
| 69 | + |
| 70 | +8. *maxRetryAttemptsOnThrottledRequests* - the maximum number of retries in the case where the request fails because the Azure DocumentDB database service has applied rate limiting on the client. |
| 71 | + |
| 72 | +9. *maxRetryWaitTimeInSeconds* - The maximum retry time in seconds for the Azure DocumentDB database service. |
| 73 | + |
| 74 | +10. *preferredLocations* - Sets the preferred locations(regions) for geo-replicated database accounts in the Azure DocumentDB database service. Use ';' to split multiple locations. e.g. "East US;South Central US;North Europe" |
| 75 | + |
| 76 | +11. *partitionKey* - The partition key name of the collection |
| 77 | + |
| 78 | +12. *partitionNumUsedByProvider* - the number of partition can be used for sessionstate |
0 commit comments