added head_callback to access response status and headers in requests

[helm.git] / helm / DEVEL / ocaml-http / http_user_agent.mli

diff --git a/helm/DEVEL/ocaml-http/http_user_agent.mli b/helm/DEVEL/ocaml-http/http_user_agent.mli
index 58032467718c21b01c14ec39e4045c7fefaaf6af..b3e91b3c006f5cb799742c2b7bb16dad8951e607 100644 (file)
--- a/helm/DEVEL/ocaml-http/http_user_agent.mli
+++ b/helm/DEVEL/ocaml-http/http_user_agent.mli
@@ -25,16 +25,26 @@
  * this module is for performances and incremental elaboration of response's
  * bodies *)
 
+open Http_types
+
 exception Http_error of (int * string)  (* code, body *)
 
-  (** @param url an HTTP url
+  (** @param head_callback optional calllback invoked on response's status and
+   * headers. If not provided no callback will be invoked
+   * @param url an HTTP url
    * @return HTTP response's body
    * @raise Http_error when response code <> 200 *)
-val get: string -> string
+val get:
+  ?head_callback:(status -> (string * string) list -> unit) ->
+  string ->
+    string
 
   (** as above but iter callback function on HTTP response's body instead of
    * returning it as a string *)
-val get_iter: (string -> unit) -> string -> unit
+val get_iter:
+  ?head_callback:(status -> (string * string) list -> unit) ->
+  (string -> unit) -> string ->
+    unit
 
   (** @param url an HTTP url
    * @return HTTP HEAD raw response