# Harbour.RedisSessionStateStore

**Repository Path**: yangdejiu/Harbour.RedisSessionStateStore

## Basic Information

- **Project Name**: Harbour.RedisSessionStateStore
- **Description**: A Redis based SessionStateStoreProvider written in C# using ServiceStack.Redis.Use the sessionTimeoutMiutes instead of the HttpContext.Session.Timeout while HttpContext.Session IS NULL.
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-10-19
- **Last Updated**: 2022-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

This fork is based on Harbour.RedisSessionStateStore 1.4.0([https://github.com/TheCloudlessSky/Harbour.RedisSessionStateStore](https://github.com/TheCloudlessSky/Harbour.RedisSessionStateStore)),here is the change:Use the `sessionTimeoutMiutes` instead of the `HttpContext.Session.Timeout` while `HttpContext.Session` IS NULL.Online Nuget package name is Joeries.Harbour.RedisSessionStateStore.


Harbour.RedisSessionStateStore
==============================

This is a [Redis](http://redis.io/) based [SessionStateStoreProvider](http://msdn.microsoft.com/en-us/library/ms178587.aspx)
written in C# using [ServiceStack.Redis](https://github.com/ServiceStack/ServiceStack.Redis).

Installation
------------

1. You can either install using NuGet: `PM> Install-Package Harbour.RedisSessionStateStore`
2. Or build and install from source: `msbuild .\build\build.proj`

Usage
-----

Configure your `web.config` to use the session state provider:

```xml
<system.web>
  <sessionState mode="Custom" customProvider="RedisSessionStateProvider">
    <providers>
      <clear />
      <add name="RedisSessionStateProvider" 
           type="Harbour.RedisSessionStateStore.RedisSessionStateStoreProvider" 
           host="localhost:6379" clientType="pooled" />
    </providers>
  </sessionState>
</system.web>
```

This configuration will use a `PooledRedisClientManager` and use the default host
and port (localhost:6379). Alternatively you can use the `host` attribute 
to set a custom host/port. If you wish to change the client manager type to
`BasicRedisClientManager`, you can set the `clientType="basic"`.

If you require that a custom `IClientsManager` be configured (for example if you're
using an IoC container or you wish to only have one `IClientsManager` for your
whole application), you can do the following when the application starts:

```csharp
private IRedisClientsManager clientManager;

protected void Application_Start()
{
    // Or use your IoC container to wire this up.
    this.clientManager = new PooledRedisClientManager("localhost:6379");
    RedisSessionStateStoreProvider.SetClientManager(this.clientManager);

    // Configure options on the provider.
    RedisSessionStateStoreProvider.SetOptions(new RedisSessionStateStoreOptions()
    {
        KeySeparator = ":",
        OnDistributedLockNotAcquired = sessionId =>
        {
            Console.WriteLine("Session \"{0}\" could not establish distributed lock. " +
                              "This most likely means you have to increase the " +
                              "DistributedLockAcquireSeconds/DistributedLockTimeoutSeconds.", sessionId);
        }
    });
}

protected void Application_End()
{
    this.clientManager.Dispose();
}
```

Changelog
---------

### v1.4.1
- Use the `sessionTimeoutMiutes` instead of the `HttpContext.Session.Timeout`
  while `HttpContext.Session` IS NULL.

### v1.4.0
- Use the `HttpContext.Session.Timeout` instead of the timeout from the `web.config`
  so that the request can customize the session's timeout.

### v1.3.0
- Use a distributed lock rather than the WATCH/UNWATCH pattern because
  it was causing issues.
- Add the ability to configure the provider with static `SetOptions(options)`.

### v1.2.0
- Always ensure UNWATCH is called.
- Retry a transaction once if it fails.

### v1.1.0
- Add WATCH/UNWATCH pattern for transactions.

### v1.0.0
- Initial release.