Snap.Extension.Session

Snap.Extension.Session exports the MonadSession type class, which allows you to keep a session object for each client session of a web application. Convenience functions are provided for those cases where the session type is a Map.

Documentation

class MonadSnap m => MonadSession m where

This type class captures all Snap-related monads that contain a session.

Associated Types

type Session m

The type of the session object. In principle, this may be any type that you want. However, implementations or other extensions maybe put additional restrictions on the type (for example, the session implementation in Snap.Extension.Session.Client requires that the session type be an instance of Data.Serialize.Serialize.

Methods

getSession :: m (Session m)

setSession :: Session m -> m ()

clearSession :: m ()

touchSession :: m ()

Instances

HasMemorySessionManager s => MonadSession (SnapExtend s)

(HasClientSessionManager s, Serialize (ClientSession s)) => MonadSession (SnapExtend s)

inSession :: MonadSession m => m a -> m a

Insert this into your routes to renew sessions on each request.

withSession :: MonadSession m => (Session m -> m a) -> m a

getFromSession :: (Ord k, MonadSession m, Session m ~ Map k a) => k -> m (Maybe a)

deleteFromSession :: (Ord k, MonadSession m, Session m ~ Map k a) => k -> m ()

setInSession :: (Ord k, MonadSession m, Session m ~ Map k a) => k -> a -> m ()