Documentation

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

diff --git a/Network/HTTP/Lucu/Config.hs b/Network/HTTP/Lucu/Config.hs
index 2f6335312b029d8e9eb8e561bf5291ee3bbbf16d..d33f35ab20de5533bd21e6b51e84fc55b5e08656 100644 (file)
--- a/Network/HTTP/Lucu/Config.hs
+++ b/Network/HTTP/Lucu/Config.hs
@@ -1,6 +1,7 @@
+-- |Configurations for the Lucu httpd like a port to listen.
 module Network.HTTP.Lucu.Config
     ( Config(..)
-    , defaultConfig -- Config
+    , defaultConfig
     )
     where
 
@@ -12,26 +13,56 @@ import           Network.HTTP.Lucu.MIMEType
 import           Network.HTTP.Lucu.MIMEType.DefaultExtensionMap
 import           System.IO.Unsafe
 
-
+-- |A 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
+    -- |The host name of the server. This value will be used in
+    -- built-in pages like \"404 Not Found\".
     , cnfServerHost           :: HostName
+    -- |A port ID to listen to HTTP clients.
     , 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
+    -- |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
-    , cnfMaxURILength         :: 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
+    -- |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
+    -- guessed only by file name. 
+    -- 
+    -- Guessing by file magic is indeed a wonderful idea but that is
+    -- not implemented (yet). But hey, don't you think it's better a
+    -- file system got a MIME Type as a part of inode? Or it might be
+    -- a good idea to use GnomeVFS
+    -- (<http://developer.gnome.org/doc/API/2.0/gnome-vfs-2.0/>)
+    -- instead of vanilla FS.
     , cnfExtToMIMEType        :: Map String MIMEType
     }
 
-
+-- |The default configuration. Generally you can use this value as-is,
+-- or possibly you just want to replace the 'cnfServerSoftware' and
+-- 'cnfServerPort'.
+defaultConfig :: Config
 defaultConfig = Config {
                   cnfServerSoftware       = "Lucu/1.0"
                 , cnfServerHost           = unsafePerformIO getHostName
                 , cnfServerPort           = Service "http"
                 , cnfMaxPipelineDepth     = 100
                 , cnfMaxEntityLength      = 16 * 1024 * 1024 -- 16 MiB
-                , cnfMaxURILength         = 4 * 1024         -- 4 KiB
                 , cnfMaxOutputChunkLength = 5 * 1024 * 1024  -- 5 MiB
                 , cnfExtToMIMEType        = defaultExtensionMap
                 }