DEVEL/ocaml-http/http_parser.mli

   1
   2 (*
   3   OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
   4
   5   Copyright (C) <2002-2005> 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 Library General Public License as
   9   published by the Free Software Foundation, version 2.
  10
  11   This program is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU Library General Public License for more details.
  15
  16   You should have received a copy of the GNU Library General Public
  17   License along with this program; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  19   USA
  20 *)
  21
  22 (** HTTP messages parsing *)
  23
  24 open Http_types;;
  25
  26   (** given an HTTP like query string (e.g. "name1=value1&name2=value2&...")
  27   @return a list of pairs [("name1", "value1"); ("name2", "value2")]
  28   @raise Malformed_query if the string isn't a valid query string
  29   @raise Malformed_query_part if some piece of the query isn't valid
  30   *)
  31 val split_query_params: string -> (string * string) list
  32
  33   (** parse 1st line of an HTTP request
  34   @param inchan input channel from which parse request
  35   @return a triple meth * url * version, meth is the HTTP method invoked, url is
  36   the requested url, version is the HTTP version specified or None if no version
  37   was specified
  38   @raise Malformed_request if request 1st linst isn't well formed
  39   @raise Malformed_request_URI if requested URI isn't well formed *)
  40 val parse_request_fst_line: in_channel -> meth * Neturl.url * version option
  41
  42   (** parse 1st line of an HTTP response
  43    * @param inchan input channel from which parse response
  44    * @raise Malformed_response if first line isn't well formed
  45   *)
  46 val parse_response_fst_line: in_channel -> version * status
  47
  48   (** parse HTTP GET parameters from an URL; paramater which were passed with no
  49   value (like 'x' in "/foo.cgi?a=10&x=&c=9") are returned associated with the
  50   empty ("") string.
  51   @return a list of pairs param_name * param_value *)
  52 val parse_query_get_params: Neturl.url -> (string * string) list
  53
  54   (** parse the base path (removing query string, fragment, ....) from an URL *)
  55 val parse_path: Neturl.url -> string
  56
  57   (** parse HTTP headers. Consumes also trailing CRLF at the end of header list
  58   @param inchan input channel from which parse headers
  59   @return a list of pairs header_name * header_value
  60   @raise Invalid_header if a not well formed header is encountered *)
  61 val parse_headers: in_channel -> (string * string) list
  62
  63   (** given an input channel, reads from it a GET HTTP request and
  64   @return a pair <path, query_params> where path is a string representing the
  65   requested path and query_params is a list of pairs <name, value> (the GET
  66   parameters) *)
  67 val parse_request: in_channel -> string * (string * string) list
  68