Cabal

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

diff --git a/Network/HTTP/Lucu.hs b/Network/HTTP/Lucu.hs
index 3f4350bc35004b8a23066616b232914fdcfcb943..14d39543aca45b86f6796e940c1835f48652f65a 100644 (file)
--- a/Network/HTTP/Lucu.hs
+++ b/Network/HTTP/Lucu.hs
@@ -1,43 +1,73 @@
-module Network.HTTP.Lucu
-    ( -- Abortion
-      abort
-    , abortA
-
-      -- Config
-    , Config(..)
-    , defaultConfig
-
-      -- ETag
-    , ETag
-    , mkETag
-    , strongETag
-    , weakETag
+-- | Lucu is an HTTP daemonic library. It can be embedded in any
+-- Haskell program and runs in an independent thread.
+--
+-- Features:
+--
+--   [/Full support of HTTP\/1.1/] Lucu supports request pipelining,
+--   chunked I\/O, ETag comparison and \"100 Continue\".
+--
+--   [/Performance/] Lucu doesn't fork\/exec to handle requests like
+--   CGI. It just spawns a new thread. Inter-process communication is
+--   done with STM.
+--
+-- Lucu is not a replacement for Apache. It is intended to be used to
+-- create an efficient web-based application without messing around
+-- FastCGI. It is also intended to be run behind a reverse-proxy so it
+-- doesn't have the following (otherwise essential) facilities:
+--
+--   [/Logging/] Lucu doesn't log any requests from any clients.
+--
+--   [/Client Filtering/] Lucu always accepts any clients. No IP
+--   filter is implemented.
+--
+--   [/SSL Support/] Lucu can handle only HTTP.
+--
+--   [/Bandwidth Limitting/] Lucu doesn't limit bandwidth it consumes.
+--
+--   [/Protection Against Wicked Clients/] Lucu is fragile against
+--   wicked clients. No attacker should be able to cause a
+--   buffer-overflow but can possibly DoS it.
+--
 
-      -- Httpd
-    , runHttpd
 
-      -- MIMEType
-    , MIMEType(..)
-    , (+/+)
-    , (+:+)
-    , (+=+)
-    
-      -- Request
-    , Method(..)
-    , Request(..)
+module Network.HTTP.Lucu
+    ( -- * Entry Point
+      runHttpd
 
-      -- Resource (driftTo だけは要らないが)
-    , module Network.HTTP.Lucu.Resource
+      -- * Configuration
+    , module Network.HTTP.Lucu.Config
 
-      -- Resource.Tree
+      -- * Resource Tree
     , ResourceDef(..)
     , ResTree
     , mkResTree
 
-      -- Response
+      -- * Resource Monad
+    , module Network.HTTP.Lucu.Resource
+
+      -- ** Things to be used in the Resource monad
+
+      -- *** Status Code
     , StatusCode(..)
+
+      -- *** Abortion
+    , abort
+    , abortA
+
+      -- *** ETag
+    , ETag(..)
+    , strongETag
+    , weakETag
+
+      -- *** MIME Type
+    , MIMEType(..)
+    , (</>)
+    , (<:>)
+    , (<=>)
     
-      -- StaticFile
+      -- * Utility
+
+      -- ** Static file handling
     , module Network.HTTP.Lucu.StaticFile
     )
     where
@@ -48,7 +78,7 @@ import Network.HTTP.Lucu.ETag
 import Network.HTTP.Lucu.Httpd
 import Network.HTTP.Lucu.MIMEType
 import Network.HTTP.Lucu.Request
-import Network.HTTP.Lucu.Resource
+import Network.HTTP.Lucu.Resource hiding (driftTo)
 import Network.HTTP.Lucu.Resource.Tree
 import Network.HTTP.Lucu.Response
 import Network.HTTP.Lucu.StaticFile