]> gitweb @ CieloNegro.org - Lucu.git/blob - Network/HTTP/Lucu.hs
8ef80d94a51f712b7e30fa6b4f33cd5d369e8ef6
[Lucu.git] / 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       -- *** 'StatusCode'
50     , module Network.HTTP.Lucu.StatusCode
51
52       -- *** 'Abortion'
53     , module Network.HTTP.Lucu.Abortion
54
55       -- *** ETag
56     , ETag(..)
57     , strongETag
58     , weakETag
59     , parseETag
60
61       -- *** MIME Type
62     , MIMEType(..)
63     , MIMEParams
64     , parseMIMEType
65     , mimeType
66
67       -- *** Authentication
68     , AuthChallenge(..)
69     , AuthCredential(..)
70     
71       -- * Utilities
72       -- ** Static file handling
73     , module Network.HTTP.Lucu.StaticFile
74     )
75     where
76 import Network.HTTP.Lucu.Abortion
77 import Network.HTTP.Lucu.Authentication
78 import Network.HTTP.Lucu.Config
79 import Network.HTTP.Lucu.Dispatcher
80 import Network.HTTP.Lucu.ETag
81 import Network.HTTP.Lucu.Httpd
82 import Network.HTTP.Lucu.MIMEParams
83 import Network.HTTP.Lucu.MIMEType hiding (mimeType)
84 import Network.HTTP.Lucu.MIMEType.TH
85 import Network.HTTP.Lucu.Resource
86 import Network.HTTP.Lucu.Response
87 import Network.HTTP.Lucu.StaticFile
88 import Network.HTTP.Lucu.StatusCode
89 import Network.HTTP.Lucu.Utils