- added a TODO comment

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

diff --git a/helm/DEVEL/ocaml-http/http_misc.mli b/helm/DEVEL/ocaml-http/http_misc.mli
index 3aea8b52d2655cec92e034a5251fbf2bfee8fbf5..8e8df902c5262fddcdd88022f393da4a4b407e89 100644 (file)
--- a/helm/DEVEL/ocaml-http/http_misc.mli
+++ b/helm/DEVEL/ocaml-http/http_misc.mli
@@ -42,10 +42,39 @@ val strip_heading_slash: string -> string
   (** given a dir handle @return a list of entries contained *)
 val ls: Unix.dir_handle -> string list
 
+  (** explode a string in a char list *)
 val string_explode: string -> char list
+  (** implode a char list in a string *)
 val string_implode: char list -> string
 
+  (** given an HTTP response code return the corresponding reason phrase *)
 val reason_phrase_of_code: int -> string
 
-val build_sockaddr: addr:string -> port:int -> Unix.sockaddr
+  (** build a Unix.sockaddr inet address from a string representation of an IP
+  address and a port number *)
+val build_sockaddr: string * int -> Unix.sockaddr
+  (** explode an _inet_ Unix.sockaddr address in a string representation of an
+  IP address and a port number *)
+val explode_sockaddr: Unix.sockaddr -> string * int
+
+  (** given an out_channel build on top of a socket, return peername related to
+  that socket *)
+val peername_of_out_channel: out_channel -> Unix.sockaddr
+  (** as above but works on in_channels *)
+val peername_of_in_channel: in_channel -> Unix.sockaddr
+  (** given an out_channel build on top of a socket, return sockname related to
+  that socket *)
+val sockname_of_out_channel: out_channel -> Unix.sockaddr
+  (** as above but works on in_channels *)
+val sockname_of_in_channel: in_channel -> Unix.sockaddr
+
+  (* TODO replace with Buffer.add_channel which does almost the same :-((( *)
+  (** reads from an input channel till it End_of_file and returns what has been
+  read; if limit is given returned buffer will contains at most first 'limit'
+  bytes read from input channel *)
+val buf_of_inchan: ?limit: int -> in_channel -> Buffer.t
+
+  (** like List.assoc but return all bindings of a given key instead of the
+  leftmost one only *)
+val list_assoc_all: 'a -> ('a * 'b) list -> 'b list