Web.ServerSession.Backend.Redis

Storage backend for serversession using Redis via hedis.

Documentation

data RedisStorage sess

Session storage backend using Redis via the hedis package.

Constructors

RedisStorage

Fields

• connPool :: Connection

  Connection pool to the Redis server.

• idleTimeout :: Maybe NominalDiffTime

  How long should a session live after last access

• absoluteTimeout :: Maybe NominalDiffTime

  How long should a session live after creation

Instances

RedisSession sess => Storage (RedisStorage sess)

We do not provide any ACID guarantees for different actions running inside the same TransactionM RedisStorage.

Associated Types

type SessionData (RedisStorage sess) :: *

type TransactionM (RedisStorage sess) :: * -> *

Methods

runTransactionM :: RedisStorage sess -> TransactionM (RedisStorage sess) a -> IO a

getSession :: RedisStorage sess -> SessionId (SessionData (RedisStorage sess)) -> TransactionM (RedisStorage sess) (Maybe (Session (SessionData (RedisStorage sess))))

deleteSession :: RedisStorage sess -> SessionId (SessionData (RedisStorage sess)) -> TransactionM (RedisStorage sess) ()

deleteAllSessionsOfAuthId :: RedisStorage sess -> AuthId -> TransactionM (RedisStorage sess) ()

insertSession :: RedisStorage sess -> Session (SessionData (RedisStorage sess)) -> TransactionM (RedisStorage sess) ()

replaceSession :: RedisStorage sess -> Session (SessionData (RedisStorage sess)) -> TransactionM (RedisStorage sess) ()

type TransactionM (RedisStorage sess)

type TransactionM (RedisStorage sess) = Redis

type SessionData (RedisStorage sess)

type SessionData (RedisStorage sess) = sess

data RedisStorageException

An exception thrown by the serversession-backend-redis package.

Constructors

ExpectedTxSuccess (TxResult ())

We expected TxSuccess but got something else.

ExpectedRight Reply

We expected Right from an Either Reply a but got Left.

Instances

Show RedisStorageException

Methods

showsPrec :: Int -> RedisStorageException -> ShowS

show :: RedisStorageException -> String

showList :: [RedisStorageException] -> ShowS

Exception RedisStorageException

Methods

toException :: RedisStorageException -> SomeException

fromException :: SomeException -> Maybe RedisStorageException

displayException :: RedisStorageException -> String

class IsSessionData sess => RedisSession sess where

Class for data types that can be used as session data for the Redis backend.

It should hold that

fromHash p . perm . toHash p  ===  id

for all list permutations perm :: [a] -> [a], where p :: Proxy sess.

Minimal complete definition

toHash, fromHash

Methods

toHash :: Proxy sess -> Decomposed sess -> [(ByteString, ByteString)]

Transform a decomposed session into a Redis hash. Keys will be prepended with "data:" before being stored.

fromHash :: Proxy sess -> [(ByteString, ByteString)] -> Decomposed sess

Parse back a Redis hash into session data.

Instances

RedisSession SessionMap

Assumes that keys are UTF-8 encoded when parsing (which is true if keys are always generated via toHash).

Methods

toHash :: Proxy * SessionMap -> Decomposed SessionMap -> [(ByteString, ByteString)]

fromHash :: Proxy * SessionMap -> [(ByteString, ByteString)] -> Decomposed SessionMap