3 OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
5 Copyright (C) <2002> Stefano Zacchiroli <zack@cs.unibo.it>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 (** Main OCaml HTTP module.
23 Here you can find two set of functions:
24 - functions which let you start an HTTP Daemon (start* functions)
25 - facility functions which let you sent responses back to clients *)
27 (** send a CRLF sequence on the given output channel, this is mandatory after
28 the last header was sent and before start sending the response body *)
29 val send_CRLF: out_channel -> unit
31 (** send response status line, version is the http version used in response,
32 either code or status must be given (not both, not none) which represent the
33 HTTP response code, outchan is the output channel to which send status line *)
35 ?version: Http_types.version -> ?code: int -> ?status: Http_types.status ->
39 (** like send_status_line but additionally will also send "Date" and "Server"
41 val send_basic_headers:
42 ?version: Http_types.version -> ?code: int -> ?status: Http_types.status ->
46 (** send an HTTP header on outchan *)
47 val send_header: header: string -> value: string -> out_channel -> unit
49 (** as send_header, but for a list of pairs <header, value> *)
50 val send_headers: headers:(string * string) list -> out_channel -> unit
52 (** send a file through an out_channel, file can be passed as an in_channel
53 (if 'file' is given) or as a file name (if 'name' is given) *)
54 val send_file: ?name:string -> ?file:in_channel -> out_channel -> unit
56 (** high level response function, respond on outchan sending: basic headers
57 (including Content-Length computed using 'body' argument), headers probided
58 via 'headers' argument, body given via 'body' argument. Default response
59 status is 200, default response HTTP version is Http_common.http_version *)
61 ?body:string -> ?headers:(string * string) list ->
62 ?version:Http_types.version -> ?code:int -> ?status:Http_types.status ->
66 (** send a 404 (not found) HTTP response *)
67 val respond_not_found:
68 url:string -> ?version: Http_types.version -> out_channel -> unit
70 (** send a 403 (forbidden) HTTP response *)
71 val respond_forbidden:
72 url:string -> ?version: Http_types.version -> out_channel -> unit
74 (** send a "redirection" class response, optional body argument contains data
75 that will be displayed in the body of the response, default response status is
76 302 (moved permanently), only redirection status are accepted by this
77 function, other values will raise Failure *)
79 location:string -> ?body:string ->
80 ?version: Http_types.version ->
81 ?code: int -> ?status: Http_types.redirection_status ->
85 (** send an "error" response (i.e. 400 <= status < 600), optional body
86 argument as per send_redirect, default response status is 400 (bad request),
87 only error status are accepted by this function, other values will
91 ?version: Http_types.version ->
92 ?code: int -> ?status: Http_types.error_status ->
96 (** tipical static pages http daemon behaviour, if requested url is a file,
97 return it, it it is a directory return a directory listing of it *)
99 fname:string -> ?version: Http_types.version -> out_channel -> unit
101 (** respond using a prebuilt Http_types.response object *)
102 val respond_with: Http_types.response -> out_channel -> unit
104 (** create an HTTP daemon listening on 'addr':'port' (defaults are
105 addr:"0.0.0.0" and port:80), callback is the user supplied function which
106 receive as a first parameter the path required by the the HTTP client as a
107 string, and a list of pair <parameter, value> representing parameters passed
108 via GET. The last argument of the callback is an output_channel connected to
109 the HTTP client to which the user can write directly. 'timeout' parameter sets
110 a timeout for each request processed by the daemon, if it's set to None,
111 daemon waits forever for completed requests (use with care!), default is 5
112 minute. 'mode' parameter has 3 possible values: `Single means that all request
113 are handled by the same process, `Fork means that each request is handled by a
114 separate process, `Thread means that each request is handled by a separate
115 thread, default is `Fork; 'root' (mnemonic "document root") is the directory
116 where the daemon chdir before starting up, default is current working
119 ?addr: string -> ?port: int ->
120 ?timeout: int option -> ?mode: Http_types.daemon_mode -> ?root: string ->
121 (string -> (string * string) list -> out_channel -> unit) ->
124 (** identical to 'start' above but callback receive two arguments, the second
125 one is an out_channel as per 'start', but the secondo one is a Request.request
128 ?addr: string -> ?port: int ->
129 ?timeout: int option -> ?mode: Http_types.daemon_mode -> ?root: string ->
130 (Http_types.request -> out_channel -> unit) ->
133 (** Object oriented interface to HTTP daemons.
134 @param addr address on which daemon will listen for connections
135 @param port port which daemon will bind
136 see {! Http_types.daemon} *)
138 ?addr: string -> ?port: int ->
142 (** Trivial static pages HTTP daemon.
143 Daemons created using this module will serve directory indexes and files found
144 starting from the working directory *)
147 (** callback function, exposed if you like to use it as a basis to define
148 a more powerful daemon *)
149 val callback : string -> 'a -> out_channel -> unit
151 (** start the "trivial" HTTP daemon *)
152 val start : ?addr:string -> ?port:int -> unit -> unit