Happstack.Server.ClientSession

Documentation

class SafeCopy st => ClientSession st where

Your session type must have an instance for this class.

Methods

empty :: st

An empty session, i.e. what you get when there is no existing session stored.

data SessionConf

Configuration for the session cookie for passing to runClientSessionT.

Constructors

SessionConf

Fields

sessionCookieName :: String

Name of the cookie to hold your session data.

sessionCookieLife :: CookieLife

Lifetime of that cookie.

sessionKey :: Key

Encryption key, usually from getKey or getDefaultKey.

sessionSecure :: Bool

Only use a session over secure transports.

mkSessionConf :: Key -> SessionConf

Create a SessionConf using defaults for everything except sessionKey. You can use record update syntax to override individual fields.

 main = do key <- getDefaultKey
           let sessConf = (mkSessionConf key) { sessionCookieLife = oneWeek }
           simpleHTTP nullConf $ runClientSessionT handlers sessConf
   where
     oneWeek  = MaxAge $ 60 * 60 * 24 * 7
     handlers = sessionPart $ msum [...]

data ClientSessionT st m a

Transformer for monads capable of using a session.

Instances

FilterMonad r m => FilterMonad r (ClientSessionT st m)

WebMonad r m => WebMonad r (ClientSessionT st m)

Monad m => Monad (ClientSessionT st m)

Functor m => Functor (ClientSessionT st m)

MonadPlus m => MonadPlus (ClientSessionT st m)

(Monad m, Functor m) => Applicative (ClientSessionT st m)

(Functor m, MonadPlus m) => Alternative (ClientSessionT st m)

Happstack m => Happstack (ClientSessionT st m)

(Monad m, HasRqData m) => HasRqData (ClientSessionT st m)

ServerMonad m => ServerMonad (ClientSessionT st m)

MonadIO m => MonadIO (ClientSessionT st m)

runClientSessionT :: Monad m => ClientSessionT st m a -> SessionConf -> m a

Get the inner monad of a ClientSessionT.

getSession :: (Functor m, MonadPlus m, HasRqData m, ClientSession st) => ClientSessionT st m st

Get the session value. If the cookie has not been decoded yet, it will be decoded. If no session data is stored or the session has been expired, empty is returned.

putSession :: (Monad m, ClientSession st) => st -> ClientSessionT st m ()

Put a new value in the session.

expireSession :: Monad m => ClientSessionT st m ()

Expire the session, i.e. the cookie holding it.

withSession :: (Functor m, MonadPlus m, HasRqData m, ClientSession st, Eq st) => State st a -> ClientSessionT st m a

Run a State monad with the session.

sessionPart :: (Functor m, Monad m, MonadIO m, FilterMonad Response m, ClientSession st) => ClientSessionT st m a -> ClientSessionT st m a

Wrapper around your handlers that use the session. Takes care of expiring the cookie of an expired session, or encrypting a modified session into the cookie.