Network/HTTP/Lucu.hs

   1 -- | Lucu is an HTTP daemonic library. It can be embedded in any
   2 -- Haskell program and runs in an independent thread.
   3 --
   4 -- Features:
   5 --
   6 --   [/Full support of HTTP\/1.1/] Lucu supports request pipelining,
   7 --   chunked I\/O, ETag comparison and \"100 Continue\".
   8 --
   9 --   [/Performance/] Lucu doesn't fork\/exec to handle requests like
  10 --   CGI. It just spawns a new thread. Inter-process communication is
  11 --   done with STM.
  12 --
  13 --   [/Affinity for RESTafarians/] Lucu is a carefully designed
  14 --   web server for RESTful applications.
  15 --
  16 --   [/SSL connections/] Lucu can handle HTTP connections over SSL
  17 --   layer.
  18 --
  19 -- Lucu is not a replacement for Apache. It is intended to be used to
  20 -- create an efficient web-based application without messing around
  21 -- FastCGI. It is also intended to be run behind a reverse-proxy so it
  22 -- doesn't have the following (otherwise essential) facilities:
  23 --
  24 --   [/Logging/] Lucu doesn't log any requests from any clients.
  25 --
  26 --   [/Client Filtering/] Lucu always accepts any clients. No IP
  27 --   filter is implemented.
  28 --
  29 --   [/Bandwidth Limitting/] Lucu doesn't limit bandwidth it consumes.
  30 --
  31 --   [/Protection Against Wicked Clients/] Lucu is fragile against
  32 --   wicked clients. No attacker should be able to cause a
  33 --   buffer-overflow but can possibly DoS it.
  34 --
  35
  36
  37 module Network.HTTP.Lucu
  38     ( -- * Entry Point
  39       runHttpd
  40
  41       -- * Configuration
  42     , module Network.HTTP.Lucu.Config
  43
  44       -- * Resource Tree
  45     , ResourceDef(..)
  46     , ResTree
  47     , mkResTree
  48
  49       -- * Resource Monad
  50     , module Network.HTTP.Lucu.Resource
  51
  52       -- ** Things to be used in the Resource monad
  53
  54       -- *** Status Code
  55     , StatusCode(..)
  56
  57       -- *** Abortion
  58     , abort
  59     , abortPurely
  60     , abortA
  61
  62       -- *** ETag
  63     , ETag(..)
  64     , strongETag
  65     , weakETag
  66
  67       -- *** MIME Type
  68     , MIMEType(..)
  69
  70       -- *** Authorization
  71     , AuthChallenge(..)
  72     , AuthCredential(..)
  73
  74       -- * Utility
  75
  76       -- ** Static file handling
  77     , module Network.HTTP.Lucu.StaticFile
  78     )
  79     where
  80
  81 import Network.HTTP.Lucu.Abortion
  82 import Network.HTTP.Lucu.Authorization
  83 import Network.HTTP.Lucu.Config
  84 import Network.HTTP.Lucu.ETag
  85 import Network.HTTP.Lucu.Httpd
  86 import Network.HTTP.Lucu.MIMEType
  87 import Network.HTTP.Lucu.Resource hiding (driftTo)
  88 import Network.HTTP.Lucu.Resource.Tree
  89 import Network.HTTP.Lucu.Response
  90 import Network.HTTP.Lucu.StaticFile