Documentation

[Lucu.git] / Network / HTTP / Lucu / Config.hs

diff --git a/Network/HTTP/Lucu/Config.hs b/Network/HTTP/Lucu/Config.hs
index b49268a9f771088f2f369a9429d3028a5c36b588..17bf0224b7e2c1814160a41dce6046bb8b6daaf8 100644 (file)
--- a/Network/HTTP/Lucu/Config.hs
+++ b/Network/HTTP/Lucu/Config.hs
@@ -14,32 +14,35 @@ import           Network.HTTP.Lucu.MIMEType.Guess
 import           Network.HTTP.Lucu.MIMEType.DefaultExtensionMap
 import           System.IO.Unsafe
 
--- |A configuration record for the Lucu httpd. You need to use
+-- |Configuration record for the Lucu httpd. You need to use
 -- 'defaultConfig' or setup your own configuration to run the httpd.
 data Config = Config {
     -- |A string which will be sent to clients as \"Server\" field.
-      cnfServerSoftware       :: String
+      cnfServerSoftware :: String
     -- |The host name of the server. This value will be used in
     -- built-in pages like \"404 Not Found\".
-    , cnfServerHost           :: HostName
+    , cnfServerHost :: HostName
     -- |A port ID to listen to HTTP clients.
-    , cnfServerPort           :: PortID
+    , cnfServerPort :: PortID
     -- |The maximum number of requests to accept in one connection
     -- simultaneously. If a client exceeds this limitation, its last
     -- request won't be processed until a response for its earliest
     -- pending request is sent back to the client.
-    , cnfMaxPipelineDepth     :: Int
+    , cnfMaxPipelineDepth :: Int
     -- |The maximum length of request entity to accept in bytes. Note
     -- that this is nothing but the default value which is used when
     -- 'Network.HTTP.Lucu.Resource.input' and such like are applied to
     -- 'Network.HTTP.Lucu.Resource.defaultLimit', so there is no
     -- guarantee that this value always constrains all the requests.
-    , cnfMaxEntityLength      :: Int
+    , cnfMaxEntityLength :: Int
     -- |The maximum length of chunk to output. This value is used by
     -- 'Network.HTTP.Lucu.Resource.output' and such like to limit the
     -- chunk length so you can safely output an infinite string (like
     -- a lazy stream of \/dev\/random) using those actions.
     , cnfMaxOutputChunkLength :: Int
+    -- | Whether to dump too late abortion to the stderr or not. See
+    -- 'Network.HTTP.Lucu.Abortion.abort'.
+    , cnfDumpTooLateAbortionToStderr :: Bool
     -- |A mapping from extension to MIME Type. This value is used by
     -- 'Network.HTTP.Lucu.StaticFile.staticFile' to guess the MIME
     -- Type of static files. Note that MIME Types are currently
@@ -51,7 +54,7 @@ data Config = Config {
     -- a good idea to use GnomeVFS
     -- (<http://developer.gnome.org/doc/API/2.0/gnome-vfs-2.0/>)
     -- instead of vanilla FS.
-    , cnfExtToMIMEType        :: ExtMap
+    , cnfExtToMIMEType :: ExtMap
     }
 
 -- |The default configuration. Generally you can use this value as-is,
@@ -59,11 +62,12 @@ data Config = Config {
 -- 'cnfServerPort'.
 defaultConfig :: Config
 defaultConfig = Config {
-                  cnfServerSoftware       = "Lucu/1.0"
-                , cnfServerHost           = unsafePerformIO getHostName
-                , cnfServerPort           = Service "http"
-                , cnfMaxPipelineDepth     = 100
-                , cnfMaxEntityLength      = 16 * 1024 * 1024 -- 16 MiB
-                , cnfMaxOutputChunkLength = 5 * 1024 * 1024  -- 5 MiB
-                , cnfExtToMIMEType        = defaultExtensionMap
+                  cnfServerSoftware              = "Lucu/1.0"
+                , cnfServerHost                  = unsafePerformIO getHostName
+                , cnfServerPort                  = Service "http"
+                , cnfMaxPipelineDepth            = 100
+                , cnfMaxEntityLength             = 16 * 1024 * 1024 -- 16 MiB
+                , cnfMaxOutputChunkLength        = 5 * 1024 * 1024  -- 5 MiB
+                , cnfDumpTooLateAbortionToStderr = True
+                , cnfExtToMIMEType               = defaultExtensionMap
                 }