Fields

• spc_initialState :: st

  initial application global state

• spc_database :: PoolOrConn conn

  See PoolOrConn

• spc_sessionCfg :: SessionCfg conn sess st

  See SessionCfg

• spc_maxRequestSize :: Maybe Word64

  Maximum request size in bytes. Nothing means no limit. Defaults to 5 MB in defaultSpockCfg.

• spc_errorHandler :: Status -> ActionCtxT () IO ()

  Custom error handlers for implicit errors such as not matching routes or exceptions during a request handler run.

• spc_logError :: Text -> IO ()

  Function that should be called to log errors.

• spc_logging :: Maybe LoggingConfig

  Optional request IDs and structured handleraccesserror logging.

• spc_slashPolicy :: SlashPolicy

  Slash matching and optional 308 canonical redirects. Defaults to IgnoreSlashes; set StrictSlashes to distinguish /foo and foo.

• spc_csrfProtection :: Bool

  When set to true, all non GET request will require either an HTTP-Header spc_csrfHeaderName or a POST-Parameter spc_csrfPostName to be set to the value aquired by getCsrfToken

• spc_csrfHeaderName :: Text

  see spc_csrfHeaderName

• spc_csrfPostName :: Text

  see spc_csrfPostName

Fields

• cb_createConn :: IO a
   
• cb_destroyConn :: a -> IO ()
   
• cb_poolConfiguration :: PoolCfg
   

Fields

• pc_stripes :: Int
   
• pc_resPerStripe :: Int
   
• pc_keepOpenTime :: NominalDiffTime
   

Fields

• sc_sessionMode :: SessionMode

  When to load or create a session. Defaults to SessionsOnDemand.

• sc_cookieName :: Text

  name of the client side cookie

• sc_cookieSettings :: CookieSettings

  how long the client side cookie should live

• sc_sessionTTL :: NominalDiffTime

  how long shoud a client session live

• sc_sessionIdEntropy :: Int

  entropy of the session id sent to the client

• sc_sessionExpandTTL :: Bool

  if this is true, every page reload will renew the session time to live counter

• sc_emptySession :: a

  initial session for visitors

• sc_backend :: SessionBackend conn a st

  Server storage or an authenticated client-cookie codec. Client sessions do not have server-wide mapping, deletion, or housekeeping capabilities.

Fields

• ssc_store :: SessionStoreInstance (Session conn sess st)
   
• ssc_housekeepingInterval :: NominalDiffTime
   
• ssc_hooks :: SessionHooks sess
   

Fields

• csc_codec :: ClientSessionCodec sess
   
• csc_maxCookieBytes :: Int

  Limit for the complete Set-Cookie value, including name and attributes. Must be between 1 and 4096. Oversized writes fail before changing state.

• csc_clock :: IO UTCTime

  Server clock. Defaults to getCurrentTime; replace in deterministic tests.

Fields

• csc_encode :: forall conn st. Text -> Session conn sess st -> IO ByteString
   
• csc_decode :: forall conn st. Text -> ByteString -> IO (Maybe (Session conn sess st, Bool))
   

Fields

• cs_EOL :: CookieEOL

  cookie expiration setting, see CookieEOL

• cs_path :: Maybe ByteString

  a path for the cookie

• cs_domain :: Maybe ByteString

  a domain for the cookie. Nothing means no domain is set

• cs_HTTPOnly :: Bool

  whether the cookie should be set as HttpOnly

• cs_secure :: Bool

  whether the cookie should be marked secure (sent over HTTPS only)

• cs_sameSite :: Maybe SameSite

  Cross-site cookie policy. Nothing omits the attribute. When using SameSiteNone, also enable cs_secure for browser compatibility.

Fields

• sh_removed :: HashMap SessionId a -> IO ()
   

Fields

• ss_runTx :: forall a. tx a -> IO a

  Run the entire supplied transaction atomically, isolated from other transactions. Session lookup, expiration, renewal, and modification rely on this guarantee to avoid lost updates or restoring deleted sessions.

• ss_loadSession :: SessionId -> tx (Maybe sess)
   
• ss_deleteSession :: SessionId -> tx ()
   
• ss_storeSession :: sess -> tx ()
   
• ss_toList :: tx [sess]
   
• ss_filterSessions :: (sess -> Bool) -> tx ()
   
• ss_mapSessions :: (sess -> tx sess) -> tx ()