Modulescotty-0.30Haskell2010

Web.Scotty.Session

This module provides session management functionality for Scotty web applications.

Example usage:

{-# LANGUAGE OverloadedStrings #-}

import Web.Scotty
import Web.Scotty.Session
import Control.Monad.IO.Class (liftIO)
main :: IO ()
main = do
    -- Create a session jar
    sessionJar <- createSessionJar
    scotty 3000 $ do
        -- Route to create a session
        get "/create" $ do
            sess <- createUserSession sessionJar "user data"
            html $ "Session created with ID: " <> sessId sess
        -- Route to read a session
        get "/read" $ do
            eSession <- getUserSession sessionJar
            case eSession of
                Left _-> html "No session found or session expired."
                Right sess -> html $ "Session content: " <> sessContent sess

4 types
10 values

Packagescotty-0.30
Exports14
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSession.hs

datadata Session a

Represents a session containing an ID, expiration time, and content.

Constructors

Session
- sessId :: SessionId
  Unique identifier for the session.
- sessExpiresAt :: UTCTime
  Expiration time of the session.
- sessContent :: a
  Content stored in the session.

Instances2Eq, Show

Eq a => Eq (Session a)Defined in scotty-0.30 · Web.Scotty.Session
Show a => Show (Session a)Defined in scotty-0.30 · Web.Scotty.Session

typetype SessionId = Text

Type alias for session identifiers.

typetype SessionJar a = TVar (HashMap SessionId (Session a))

Type for session storage, a transactional variable containing a map of session IDs to sessions.

datadata SessionStatus

Status of a session lookup.

Instances2Eq, Show

Eq SessionStatusDefined in scotty-0.30 · Web.Scotty.Session
Show SessionStatusDefined in scotty-0.30 · Web.Scotty.Session

Create Session Jar

1 declaration

valuecreateSessionJar :: IO (SessionJar a)

Creates a new session jar and starts a background thread to maintain it.

Create session

2 declarations

valuecreateUserSession

:: MonadIO m
=> SessionJar a
SessionJar, which can be created by createSessionJar
-> Maybe Int
Optional expiration time (in seconds)
-> a
Content
-> ActionT m (Session a)

Creates a new session for a user, storing the content and setting a cookie.

valuecreateSession :: SessionJar a -> Maybe Int -> a -> IO (Session a)

Creates a new session with a generated ID, sets its expiration, | and adds it to the session jar.

Read session

4 declarations

valuereadUserSession

:: MonadIO m
=> SessionJar a
-> ActionT m (Either SessionStatus a)

Reads the content of the current user's session.

valuereadSession

:: MonadIO m
=> SessionJar a
-> SessionId
-> ActionT m (Either SessionStatus a)

Reads the content of a session by its ID.

valuegetUserSession

:: MonadIO m
=> SessionJar a
-> ActionT m (Either SessionStatus (Session a))

Retrieves the current user's session based on the "sess_id" cookie. | Returns `Left SessionStatus` if the session is expired or does not exist.

valuegetSession

:: MonadIO m
=> SessionJar a
-> SessionId
-> ActionT m (Either SessionStatus (Session a))

Retrieves a session by its ID from the session jar.

Add session

1 declaration

valueaddSession :: SessionJar a -> Session a -> IO ()

Adds or overwrites a new session to the session jar.

Delte session

1 declaration

valuedeleteSession :: MonadIO m => SessionJar a -> SessionId -> ActionT m ()

Deletes a session by its ID from the session jar.

Helper functions

1 declaration

valuemaintainSessions :: SessionJar a -> IO ()

Continuously removes expired sessions from the session jar.