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       -- * URI-related data types
  39     , Host
  40     , Path
  41
  42       -- * 'Resource' dispatcher
  43     , module Network.HTTP.Lucu.Dispatcher
  44
  45       -- * 'Rsrc' Monad
  46     , module Network.HTTP.Lucu.Resource
  47
  48       -- ** Things to be used in the Resource monad
  49       -- *** 'Method'
  50     , Method(..)
  51
  52       -- *** 'StatusCode'
  53     , module Network.HTTP.Lucu.StatusCode
  54
  55       -- *** 'Abortion'
  56     , module Network.HTTP.Lucu.Abortion
  57
  58       -- *** ETag
  59     , ETag(..)
  60     , strongETag
  61     , weakETag
  62
  63       -- *** MIME Type
  64     , MIMEType(..)
  65     , MIMEParams
  66     , mimeType
  67
  68       -- *** Authentication
  69     , AuthChallenge(..)
  70     , AuthCredential(..)
  71
  72       -- * Utilities
  73       -- ** Static file handling
  74     , module Network.HTTP.Lucu.StaticFile
  75     )
  76     where
  77 import Network.HTTP.Lucu.Abortion
  78 import Network.HTTP.Lucu.Authentication
  79 import Network.HTTP.Lucu.Config
  80 import Network.HTTP.Lucu.Dispatcher
  81 import Network.HTTP.Lucu.ETag
  82 import Network.HTTP.Lucu.Httpd
  83 import Network.HTTP.Lucu.MIMEParams
  84 import Network.HTTP.Lucu.MIMEType hiding (mimeType)
  85 import Network.HTTP.Lucu.MIMEType.TH
  86 import Network.HTTP.Lucu.Request
  87 import Network.HTTP.Lucu.Resource
  88 import Network.HTTP.Lucu.Response
  89 import Network.HTTP.Lucu.StaticFile
  90 import Network.HTTP.Lucu.StatusCode
  91 import Network.HTTP.Lucu.Utils