Safe Haskell	None
Language	Haskell2010

Web.ServerSession.Backend.Redis

Description

Storage backend for serversession using Redis via hedis.

Synopsis

data RedisStorage sess = RedisStorage {
- connPool :: Connection
- idleTimeout :: Maybe NominalDiffTime
- absoluteTimeout :: Maybe NominalDiffTime
}
data RedisStorageException
- = ExpectedTxSuccess (TxResult ())
- | ExpectedRight Reply
class IsSessionData sess => RedisSession sess where
- toHash :: Proxy sess -> Decomposed sess -> [(ByteString, ByteString)]
- fromHash :: Proxy sess -> [(ByteString, ByteString)] -> Decomposed sess

Documentation

data RedisStorage sess Source #

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

Instances details

RedisSession sess => Storage (RedisStorage sess) Source #

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

Instance details

Defined in Web.ServerSession.Backend.Redis.Internal

Associated Types

type SessionData (RedisStorage sess)
Instance details Defined in Web.ServerSession.Backend.Redis.Internal type SessionData (RedisStorage sess) = sess
type TransactionM (RedisStorage sess)
Instance details Defined in Web.ServerSession.Backend.Redis.Internal type TransactionM (RedisStorage sess) = Redis

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 SessionData (RedisStorage sess) Source #

Instance details

Defined in Web.ServerSession.Backend.Redis.Internal

type SessionData (RedisStorage sess) = sess

type TransactionM (RedisStorage sess) Source #

Instance details

Defined in Web.ServerSession.Backend.Redis.Internal

type TransactionM (RedisStorage sess) = Redis

data RedisStorageException Source #

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

Instances details

Exception RedisStorageException Source #
Instance details Defined in Web.ServerSession.Backend.Redis.Internal Methods toException :: RedisStorageException -> SomeException # fromException :: SomeException -> Maybe RedisStorageException # displayException :: RedisStorageException -> String # backtraceDesired :: RedisStorageException -> Bool #
Show RedisStorageException Source #
Instance details Defined in Web.ServerSession.Backend.Redis.Internal Methods showsPrec :: Int -> RedisStorageException -> ShowS # show :: RedisStorageException -> String # showList :: [RedisStorageException] -> ShowS #

class IsSessionData sess => RedisSession sess where Source #

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.

Methods

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

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

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

Parse back a Redis hash into session data.

Instances

Instances details

RedisSession SessionMap Source #	Assumes that keys are UTF-8 encoded when parsing (which is true if keys are always generated via `toHash`).
Instance details Defined in Web.ServerSession.Backend.Redis.Internal Methods toHash :: Proxy SessionMap -> Decomposed SessionMap -> [(ByteString, ByteString)] Source # fromHash :: Proxy SessionMap -> [(ByteString, ByteString)] -> Decomposed SessionMap Source #