X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=blobdiff_plain;f=helm%2Focaml%2Fgetter%2Fhttp_getter.mli;h=0b86e730d54eabac028cfb8aea52ec4cbf61ef0b;hb=423f3f23abfe6d5906818c26ab92d3703714057d;hp=a7d12f5a1611e8867d280d5df34bfd9a819665f1;hpb=954bacdd1f1ea6a649f3bf6cd5fab4d1222f9f8f;p=helm.git

diff --git a/helm/ocaml/getter/http_getter.mli b/helm/ocaml/getter/http_getter.mli
index a7d12f5a1..0b86e730d 100644
--- a/helm/ocaml/getter/http_getter.mli
+++ b/helm/ocaml/getter/http_getter.mli
@@ -37,9 +37,21 @@ val stdout_logger: logger_callback
   (** {2 Getter Web Service interface as API *)
 
 val help: unit -> string
+
+  (** @raise Http_getter_types.Unresolvable_URI _
+  * @raise Http_getter_types.Key_not_found _ *)
 val resolve: string -> string (* uri -> url *)
+
+  (** @raise Http_getter_types.Key_already_in _ *)
 val register: uri:string -> url:string -> unit
+
+  (** does not fail if given uri does not exist *)
+val unregister: string -> unit
+
 val update: ?logger:logger_callback -> unit -> unit
+
+  (** @param format defaults to `Gzipped
+   * @param patch_dtd defaults to false *)
 val getxml  : ?format:encoding -> ?patch_dtd:bool -> string -> string
 val getxslt : ?patch_dtd:bool -> string -> string
 val getdtd  : ?patch_dtd:bool -> string -> string
@@ -49,17 +61,23 @@ val add_server: ?logger:logger_callback -> ?position:int -> string -> unit
 val remove_server: ?logger:logger_callback -> int -> unit
 val getalluris: unit -> string list
 val getallrdfuris: [ `Forward | `Backward ] -> string list
-val ls: xml_uri -> ls_item list
+
+  (** @param regexp regular expression (PCRE syntax) over HELM URIs *)
+val ls: string -> ls_item list
 
   (** {2 Shorthands} *)
 
-val getxml'   : UriManager.uri -> string
-val resolve'  : UriManager.uri -> string
-val register' : UriManager.uri -> string -> unit
+val getxml'     : UriManager.uri -> string  (* `Gzipped format, no DTD patch *)
+val resolve'    : UriManager.uri -> string
+val register'   : UriManager.uri -> string -> unit
+val unregister' : UriManager.uri -> unit
 
   (** {2 Misc} *)
 
 val close_maps: unit -> unit
 val update_from_one_server: ?logger:logger_callback -> string -> unit
 val has_server: int -> bool (* does a server with a given position exists? *)
+val init: unit -> unit
 
+  (** cal this at exit() *)
+val sync_dump_file: unit -> unit