X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=blobdiff_plain;f=helm%2FDEVEL%2Focaml-http%2Fhttp_common.mli;h=55e37b07325d75537374ceb0b8f07f0420ece454;hb=03d1ddf4a7fdf03fd497babd84d1963048253f0d;hp=bd7ff3079c55b2c4aa1067d7c604c3ca0ed5bced;hpb=a8ab5ff0a54358955e555c065e6707703b2f1026;p=helm.git

diff --git a/helm/DEVEL/ocaml-http/http_common.mli b/helm/DEVEL/ocaml-http/http_common.mli
index bd7ff3079..55e37b073 100644
--- a/helm/DEVEL/ocaml-http/http_common.mli
+++ b/helm/DEVEL/ocaml-http/http_common.mli
@@ -19,33 +19,62 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *)
 
+(** Common functionalities shared by other OCaml HTTP modules *)
+
+open Http_types;;
+
   (** whether debugging messages are enabled or not, can be changed at runtime
   *)
 val debug: bool ref
+
   (** print a string on stderr only if debugging is enabled *)
 val debug_print: string -> unit
 
-exception Invalid_HTTP_version of string
-exception Invalid_code of int
-exception Invalid_status of Http_types.status
+  (** see {! Http_constants.version} *)
+val http_version: version
 
-val http_version: Http_types.version
+  (** see {! Http_constants.server_string} *)
 val server_string: string
-val crlf: string
 
-val string_of_version: Http_types.version -> string
-val version_of_string: string -> Http_types.version
+  (** pretty print an HTTP version *)
+val string_of_version: version -> string
+
+  (** parse an HTTP version from a string
+  @raise Invalid_HTTP_version if given string doesn't represent a supported HTTP
+  version *)
+val version_of_string: string -> version
+
+  (** pretty print an HTTP method *)
+val string_of_method: meth -> string
+
+  (** parse an HTTP method from a string
+  @raise Invalid_HTTP_method if given string doesn't represent a supported
+  method *)
+val method_of_string: string -> meth
 
-val status_of_code: int -> Http_types.status
-val code_of_status: [< Http_types.status] -> int
+  (** converts an integer HTTP status to the corresponding status value
+  @raise Invalid_code if given integer isn't a valid HTTP status code *)
+val status_of_code: int -> status
 
-val reason_phrase_of_code: int -> string
-val reason_phrase_of_status: [< Http_types.status] -> string
+  (** converts an HTTP status to the corresponding integer value *)
+val code_of_status: [< status] -> int
 
+  (** @return true on "informational" status codes, false elsewhere *)
 val is_informational: int -> bool
+
+  (** @return true on "success" status codes, false elsewhere *)
 val is_success: int -> bool
+
+  (** @return true on "redirection" status codes, false elsewhere *)
 val is_redirection: int -> bool
+
+  (** @return true on "client error" status codes, false elsewhere *)
 val is_client_error: int -> bool
+
+  (** @return true on "server error" status codes, false elsewhere *)
 val is_server_error: int -> bool
+
+  (** @return true on "client error" and "server error" status code, false
+  elsewhere *)
 val is_error: int -> bool