- added via_http parameter so that when the getter is used locally (i.e.

[helm.git] / helm / ocaml / getter / http_getter_common.mli

diff --git a/helm/ocaml/getter/http_getter_common.mli b/helm/ocaml/getter/http_getter_common.mli
index 1828c82e84b1908eefe07d48897a4a2519de4df7..b4f733d8f23a95779ff94f9922762b9b2c166c40 100644 (file)
--- a/helm/ocaml/getter/http_getter_common.mli
+++ b/helm/ocaml/getter/http_getter_common.mli
@@ -38,9 +38,10 @@ val is_xsl_uri: string -> bool
 
 val uri_of_string: string -> uri
 
-val patch_xml : string -> string
-val patch_xsl : string -> string
-val patch_dtd : string -> string
+val patch_xml : ?via_http:bool -> unit -> string -> string
+val patch_dtd : ?via_http:bool -> unit -> string -> string
+  (* TODO via_http not yet supported for patch_xsl *)
+val patch_xsl : ?via_http:bool -> unit -> string -> string
 
   (**
   @param fname name of the file to be sent
@@ -50,11 +51,14 @@ val patch_dtd : string -> string
   @param gunzip is meaningful only if a patch function is provided. If gunzip
   is true patch_fun is applied to the uncompressed version of the file. The file
   is then compressed again and send to client
+  @param via_http (default: true) if true http specific communications are used
+  (e.g. headers, crlf before body) and sent via outchan, otherwise they're not.
+  Set it to false when saving to a local file
   @param outchan output channel over which sent file fname *)
 val return_file:
   fname:string ->
   ?contype:string -> ?contenc:string ->
-  ?patch_fun:(string -> string) -> ?gunzip:bool ->
+  ?patch_fun:(string -> string) -> ?gunzip:bool -> ?via_http:bool ->
   out_channel ->
     unit