]> matita.cs.unibo.it Git - helm.git/blob - helm/DEVEL/ocaml-http/http_daemon.mli
use ledit for debugging
[helm.git] / helm / DEVEL / ocaml-http / http_daemon.mli
1
2 (*
3   OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
4
5   Copyright (C) <2002> Stefano Zacchiroli <zack@cs.unibo.it>
6
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.
11
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.
16
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
20 *)
21
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 *)
26
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
30
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 *)
34 val send_status_line:
35   ?version: Http_types.version -> ?code: int -> ?status: Http_types.status ->
36   out_channel ->
37     unit
38
39   (** like send_status_line but additionally will also send "Date" and "Server"
40   standard headers *)
41 val send_basic_headers:
42   ?version: Http_types.version -> ?code: int -> ?status: Http_types.status ->
43   out_channel ->
44     unit
45
46   (** send an HTTP header on outchan *)
47 val send_header: header: string -> value: string -> out_channel -> unit
48
49   (** as send_header, but for a list of pairs <header, value> *)
50 val send_headers: headers:(string * string) list -> out_channel -> unit
51
52 (*
53   (** send a file through an out_channel, file can be passed as an in_channel
54   (if 'file' is given) or as a file name (if 'name' is given) *)
55 val send_file: ?name:string -> ?file:in_channel -> out_channel -> unit
56 *)
57   (** send a file through an out_channel *)
58 val send_file: src:Http_types.file_source -> out_channel -> unit
59
60   (** high level response function, respond on outchan sending: basic headers
61   (including Content-Length computed using 'body' argument), headers probided
62   via 'headers' argument, body given via 'body' argument.  Default response
63   status is 200, default response HTTP version is Http_common.http_version *)
64 val respond:
65   ?body:string -> ?headers:(string * string) list ->
66   ?version:Http_types.version -> ?code:int -> ?status:Http_types.status ->
67   out_channel ->
68     unit
69
70   (** send a 404 (not found) HTTP response *)
71 val respond_not_found:
72   url:string -> ?version: Http_types.version -> out_channel -> unit
73
74   (** send a 403 (forbidden) HTTP response *)
75 val respond_forbidden:
76   url:string -> ?version: Http_types.version -> out_channel -> unit
77
78   (** send a "redirection" class response, optional body argument contains data
79   that will be displayed in the body of the response, default response status is
80   302 (moved permanently), only redirection status are accepted by this
81   function, other values will raise Failure *)
82 val respond_redirect:
83   location:string -> ?body:string ->
84   ?version: Http_types.version ->
85   ?code: int -> ?status: Http_types.redirection_status ->
86   out_channel ->
87     unit
88
89   (** send an "error" response (i.e. 400 <= status < 600), optional body
90   argument as per send_redirect, default response status is 400 (bad request),
91   only error status are accepted by this function, other values will
92   raise Failure *)
93 val respond_error:
94   ?body:string ->
95   ?version: Http_types.version ->
96   ?code: int -> ?status: Http_types.error_status ->
97   out_channel ->
98     unit
99
100   (** tipical static pages http daemon behaviour, if requested url is a file,
101   return it, it it is a directory return a directory listing of it *)
102 val respond_file:
103   fname:string -> ?version: Http_types.version -> out_channel -> unit
104
105   (** respond using a prebuilt Http_types.response object *)
106 val respond_with: Http_types.response -> out_channel -> unit
107
108   (** create an HTTP daemon listening on 'addr':'port' (defaults are
109   addr:"0.0.0.0" and port:80), callback is the user supplied function which
110   receive as a first parameter the path required by the the HTTP client as a
111   string, and a list of pair <parameter, value> representing parameters passed
112   via GET. The last argument of the callback is an output_channel connected to
113   the HTTP client to which the user can write directly. 'timeout' parameter sets
114   a timeout for each request processed by the daemon, if it's set to None,
115   daemon waits forever for completed requests (use with care!), default is 5
116   minute. 'mode' parameter has 3 possible values: `Single means that all request
117   are handled by the same process, `Fork means that each request is handled by a
118   separate process, `Thread means that each request is handled by a separate
119   thread, default is `Fork; 'root' (mnemonic "document root") is the directory
120   where the daemon chdir before starting up, default is current working
121   directory *)
122 val start:
123   ?addr: string -> ?port: int ->
124   ?timeout: int option -> ?mode: Http_types.daemon_mode -> ?root: string ->
125   (string -> (string * string) list -> out_channel -> unit) ->
126     unit
127
128   (** identical to 'start' above but callback receive two arguments, the second
129   one is an out_channel as per 'start', but the secondo one is a Request.request
130   object *)
131 val start':
132   ?addr: string -> ?port: int ->
133   ?timeout: int option -> ?mode: Http_types.daemon_mode -> ?root: string -> 
134   (Http_types.request -> out_channel -> unit) ->
135     unit
136
137   (** Object oriented interface to HTTP daemons.
138   @param addr address on which daemon will listen for connections
139   @param port port which daemon will bind
140   see {! Http_types.daemon} *)
141 class daemon:
142   ?addr: string -> ?port: int ->
143     unit ->
144       Http_types.daemon
145
146   (** Trivial static pages HTTP daemon.
147   Daemons created using this module will serve directory indexes and files found
148   starting from the working directory *)
149 module Trivial :
150   sig
151       (** callback function, exposed if you like to use it as a basis to define
152       a more powerful daemon *)
153     val callback : string -> 'a -> out_channel -> unit
154
155       (** start the "trivial" HTTP daemon *)
156     val start : ?addr:string -> ?port:int -> unit -> unit
157   end
158