X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=blobdiff_plain;f=helm%2Focaml%2Fgetter%2Fhttp_getter.mli;h=c7a2c5c2ac865329caf9ef392d3d7d7ea6110bdb;hb=b41886e9d21d756279bd6a2ec3f19c17b1a64401;hp=e6a41117f4a608279be820fd9935956f9ac08886;hpb=384c369d4cbf5dd6cf1013902d3a218260400e73;p=helm.git diff --git a/helm/ocaml/getter/http_getter.mli b/helm/ocaml/getter/http_getter.mli index e6a41117f..c7a2c5c2a 100644 --- a/helm/ocaml/getter/http_getter.mli +++ b/helm/ocaml/getter/http_getter.mli @@ -28,22 +28,39 @@ open Http_getter_types + (** {2 Loggers} *) + +type logger_callback = HelmLogger.html_tag -> unit + +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 -val update: unit -> HelmLogger.html_msg + + (** does not fail if given uri does not exist *) +val unregister: string -> unit + +val update: ?logger:logger_callback -> unit -> unit val getxml : ?format:encoding -> ?patch_dtd:bool -> string -> string val getxslt : ?patch_dtd:bool -> string -> string val getdtd : ?patch_dtd:bool -> string -> string val clean_cache: unit -> unit val list_servers: unit -> (int * string) list -val add_server: ?position:int -> string -> HelmLogger.html_msg -val remove_server: int -> HelmLogger.html_msg +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} *) @@ -54,5 +71,7 @@ val register' : UriManager.uri -> string -> unit (** {2 Misc} *) val close_maps: unit -> unit -val update_from_one_server: string -> HelmLogger.html_msg +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