Contents Index

Framework.Types

Synopsis

type S = String data DBConnection = forall c . IConnection c => DBC c type HttpRequest = Request String type HttpResponse = Response String type FieldValidator = HttpRequest -> String -> String -> Either String String data HttpVar = Str String | POSTfile { filename :: String mimetype :: String filebody :: String } type HttpVarsMap = Map String HttpVar data StaticConfig = HP { portNumber :: Int docdir :: String dbDriver :: String dbPath :: String cacheDriver :: String cachePath :: String sessionsDriver :: String sessionsPath :: String accessLogPath :: String errorsLogPath :: String dbpool :: MPool DBConnection cpool :: MPool CacheConnection logChan :: Log errChan :: Log config :: ConfigParser } data StartupConfig = StartupConfig { dbpoolSC :: MPool DBConnection cpoolSC :: MPool CacheConnection logChanSC :: Log errChanSC :: Log configSC :: ConfigParser } data ActionConfig = ActionConfig { request :: HttpRequest httpParams :: StaticConfig dbconnection :: DBConnection sessionID :: SessionID sessionMap :: SessionMap sessionsBackend :: SessionsConnection cacheBackend :: CacheConnection cookiesExp :: String dbpoolIndex :: Int cpoolIndex :: Int } data UrlParam = String := String type FormVar = UrlParam repackHeader :: Header -> (String, String) packParam :: (String, String) -> UrlParam data LogItem = LogItem { logRequest :: HttpRequest logTime :: String logMessage :: String } type Log = Chan LogItem

Documentation

type S = String

data DBConnection

Container type for any database connection Constructors forall c . IConnection c => DBC c Instances Show DBConnection

type HttpRequest = Request String

type HttpResponse = Response String

type FieldValidator = HttpRequest -> String -> String -> Either String String

Field validator takes field value and returns either error message or validated value

data HttpVar

HTTP (GET or POST) variable can contain just a string or an uploaded file. Constructors Str String POSTfile filename :: String mimetype :: String filebody :: String Instances Show HttpVar

type HttpVarsMap = Map String HttpVar

data StaticConfig

This object contains config which is common for all requests Constructors HP portNumber :: Int Port number to listen docdir :: String Static content directory dbDriver :: String DB backend name dbPath :: String Info for DB backend cacheDriver :: String Cache backend name cachePath :: String Info for cache backend sessionsDriver :: String Sessions backend name sessionsPath :: String Info for sessions backend accessLogPath :: String Path to the access log errorsLogPath :: String Path to the erros log dbpool :: MPool DBConnection DB connections pool cpool :: MPool CacheConnection Cache connections pool logChan :: Log Handle to log errChan :: Log Handle to errors log config :: ConfigParser Instances Show StaticConfig

data StartupConfig

Temporarly object, contains part of StaticConfig which is not read from file Constructors StartupConfig dbpoolSC :: MPool DBConnection DB connections pool cpoolSC :: MPool CacheConnection Cache connections pool logChanSC :: Log Handle to log errChanSC :: Log Handle to errors log configSC :: ConfigParser Instances Show StartupConfig

data ActionConfig

Runtime controller action configuration Constructors ActionConfig request :: HttpRequest HTTP request httpParams :: StaticConfig Static (global) configuration dbconnection :: DBConnection DB connection sessionID :: SessionID Current HTTP session ID sessionMap :: SessionMap Contains session variables sessionsBackend :: SessionsConnection Connection to sessions backend cacheBackend :: CacheConnection Connection to cache backend cookiesExp :: String Cookies expiration date dbpoolIndex :: Int Index of DB connection in pool cpoolIndex :: Int Index of cache connection in pool Instances Show ActionConfig

data UrlParam

Constructors String := String

type FormVar = UrlParam

repackHeader :: Header -> (String, String)

packParam :: (String, String) -> UrlParam

data LogItem

Constructors LogItem logRequest :: HttpRequest logTime :: String logMessage :: String

type Log = Chan LogItem

Produced by Haddock version 2.4.2