helm/DEVEL/ocaml-http/http_user_agent.mli

   1
   2 (*
   3   OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
   4
   5   Copyright (C) <2002-2004> 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 (** Minimal implementation of an HTTP 1.0/1.1 client. Interface is similar to
  23  * Gerd Stoplmann's Http_client module. Implementation is simpler and doesn't
  24  * handle HTTP redirection, proxies, ecc. The only reason for the existence of
  25  * this module is for performances and incremental elaboration of response's
  26  * bodies *)
  27
  28 exception Http_error of (int * string)  (* code, body *)
  29
  30   (** @param url an HTTP url
  31    * @return HTTP response's body
  32    * @raise Http_error when response code <> 200 *)
  33 val get: string -> string
  34
  35   (** as above but iter callback function on HTTP response's body instead of
  36    * returning it as a string *)
  37 val get_iter: (string -> unit) -> string -> unit
  38
  39   (** @param url an HTTP url
  40    * @return HTTP HEAD raw response
  41    * @raise Http_error when response code <> 200 *)
  42 val head: string -> string
  43