Web.Sprinkles.SessionStore

Documentation

type SessionID = ByteString

data SessionExpiry

Constructors

NeverExpires

Expires POSIXTime

Instances

Eq SessionExpiry

Defined in Web.Sprinkles.SessionStore

Methods

(==) :: SessionExpiry -> SessionExpiry -> Bool

(/=) :: SessionExpiry -> SessionExpiry -> Bool

Show SessionExpiry

Defined in Web.Sprinkles.SessionStore

Methods

showsPrec :: Int -> SessionExpiry -> ShowS

show :: SessionExpiry -> String

showList :: [SessionExpiry] -> ShowS

data SessionNotFoundException

Constructors

SessionNotFoundException

Instances

Show SessionNotFoundException

Defined in Web.Sprinkles.SessionStore

Methods

showsPrec :: Int -> SessionNotFoundException -> ShowS

show :: SessionNotFoundException -> String

showList :: [SessionNotFoundException] -> ShowS

Exception SessionNotFoundException

Defined in Web.Sprinkles.SessionStore

Methods

toException :: SessionNotFoundException -> SomeException

fromException :: SomeException -> Maybe SessionNotFoundException

displayException :: SessionNotFoundException -> String

data SessionSupportDisabled

Constructors

SessionSupportDisabled

Instances

Show SessionSupportDisabled

Defined in Web.Sprinkles.SessionStore

Methods

showsPrec :: Int -> SessionSupportDisabled -> ShowS

show :: SessionSupportDisabled -> String

showList :: [SessionSupportDisabled] -> ShowS

Exception SessionSupportDisabled

Defined in Web.Sprinkles.SessionStore

Methods

toException :: SessionSupportDisabled -> SomeException

fromException :: SomeException -> Maybe SessionSupportDisabled

displayException :: SessionSupportDisabled -> String

data SessionStore

Common interface for session store backends.

Constructors

SessionStore

Fields

• ssGet :: SessionID -> Text -> IO (Maybe Text)

  Attempt to retrieve a value from a session

• ssList :: SessionID -> IO [Text]

  List all the keys in the session

• ssGetAll :: SessionID -> IO [(Text, Text)]

  Retrieve the entire session contents (key, value)

• ssPut :: SessionID -> Text -> Text -> IO ()

  Store a value in a session. Fail if session does not exist.

• ssCreateSession :: SessionID -> SessionExpiry -> IO ()

  Create a new session

• ssDropSession :: SessionID -> IO ()

  Drop a session and delete its associated data

• ssDoesSessionExist :: SessionID -> IO Bool

  Checks if a session exists

nullSessionStore :: SessionStore