Web.ServerSession.Backend.Redis.Internal

Internal module exposing the guts of the package. Use at your own risk. No API stability guarantees apply.

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

transaction :: RedisTx (Queued ()) -> Redis ()

Run the given Redis transaction and force its result. Throws a RedisStorageException if the result is not TxSuccess.

unwrap :: Redis (Either Reply a) -> Redis a

Unwraps an Either Reply a by throwing an exception if not Right.

rSessionKey :: SessionId sess -> ByteString

Redis key for the given session ID.

rAuthKey :: AuthId -> ByteString

Redis key for the given auth ID.

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

parseSession :: forall sess. RedisSession sess => SessionId sess -> [(ByteString, ByteString)] -> Maybe (Session sess)

Parse a Session from a Redis hash.

printSession :: forall sess. RedisSession sess => Session sess -> [(ByteString, ByteString)]

Convert a Session into a Redis hash.

parseUTCTime :: ByteString -> UTCTime

Parse UTCTime from a ByteString stored on Redis. Uses error on parse error.

printUTCTime :: UTCTime -> ByteString

Convert a UTCTime into a ByteString to be stored on Redis.

timeFormat :: String

Time format used when storing UTCTime.

getSessionImpl :: RedisSession sess => SessionId sess -> Redis (Maybe (Session sess))

Get the session for the given session ID.

deleteSessionImpl :: RedisSession sess => SessionId sess -> Redis ()

Delete the session with given session ID.

removeSessionFromAuthId :: (RedisCtx m f, Functor m) => SessionId sess -> Maybe AuthId -> m ()

Remove the given SessionId from the set of sessions of the given AuthId. Does not do anything if Nothing.

insertSessionForAuthId :: (RedisCtx m f, Functor m) => SessionId sess -> Maybe AuthId -> m ()

Insert the given SessionId into the set of sessions of the given AuthId. Does not do anything if Nothing.

deleteAllSessionsOfAuthIdImpl :: AuthId -> Redis ()

Delete all sessions of the given auth ID.

insertSessionImpl :: RedisSession sess => RedisStorage sess -> Session sess -> Redis ()

Insert a new session.

replaceSessionImpl :: RedisSession sess => RedisStorage sess -> Session sess -> Redis ()

Replace the contents of a session.

throwRS :: Storage (RedisStorage sess) => StorageException (RedisStorage sess) -> Redis a

Specialization of throwIO for RedisStorage.