Network/HTTP/Lucu.hs

   1 -- | Lucu is an embedded HTTP server library.
   2 --
   3 -- Features:
   4 --
   5 --   [/Affinity for RESTafarians/] Lucu is specifically designed to be
   6 --   suitable for RESTful applications.
   7 --
   8 --   [/Full support of HTTP/\//1.1/] Lucu supports request pipelining,
   9 --   chunked I\/O, ETag comparison and \"100 Continue\".
  10 --
  11 --   [/SSL connections/] Lucu can handle HTTP connections over Secure
  12 --   Socket Layer when configured with -fssl flag.
  13 --
  14 -- Lucu is not a replacement for Apache or lighttpd. It is intended to
  15 -- be used to build an efficient web-based RESTful application which
  16 -- runs behind a reverse-proxy so it doesn't have the following
  17 -- (otherwise essential) functionalities:
  18 --
  19 --   [/Logging/] Lucu doesn't write logs of any requests from any
  20 --   clients.
  21 --
  22 --   [/Client Filtering/] Lucu always accepts any clients. No IP
  23 --   filter is implemented.
  24 --
  25 --   [/Bandwidth Limitting/] Lucu doesn't limit bandwidth it consumes.
  26 --
  27 --   [/Protection Against Wicked Clients/] Lucu is somewhat fragile
  28 --   against wicked clients. No attacker should be able to cause a
  29 --   buffer-overflow but can possibly DoS it.
  30 --
  31 module Network.HTTP.Lucu
  32     ( -- * Entry Point
  33       runHttpd
  34
  35       -- * 'Config'uration
  36     , module Network.HTTP.Lucu.Config
  37
  38       -- * 'Resource' Tree
  39     , ResTree
  40     , mkResTree
  41
  42       -- * 'Rsrc' Monad
  43     , module Network.HTTP.Lucu.Resource
  44
  45       -- ** Things to be used in the Resource monad
  46       -- *** 'StatusCode'
  47     , module Network.HTTP.Lucu.StatusCode
  48
  49       -- *** 'Abortion'
  50     , module Network.HTTP.Lucu.Abortion
  51
  52       -- *** ETag
  53     , ETag(..)
  54     , strongETag
  55     , weakETag
  56     , parseETag
  57
  58       -- *** MIME Type
  59     , MIMEType(..)
  60     , MIMEParams
  61     , parseMIMEType
  62     , mimeType
  63
  64       -- *** Authentication
  65     , AuthChallenge(..)
  66     , AuthCredential(..)
  67
  68       -- * Utilities
  69       -- ** Static file handling
  70     , module Network.HTTP.Lucu.StaticFile
  71     )
  72     where
  73 import Network.HTTP.Lucu.Abortion
  74 import Network.HTTP.Lucu.Authentication
  75 import Network.HTTP.Lucu.Config
  76 import Network.HTTP.Lucu.ETag
  77 import Network.HTTP.Lucu.Httpd
  78 import Network.HTTP.Lucu.MIMEParams
  79 import Network.HTTP.Lucu.MIMEType hiding (mimeType)
  80 import Network.HTTP.Lucu.MIMEType.TH
  81 import Network.HTTP.Lucu.Resource
  82 import Network.HTTP.Lucu.Resource.Tree
  83 import Network.HTTP.Lucu.Response
  84 import Network.HTTP.Lucu.StaticFile
  85 import Network.HTTP.Lucu.StatusCode