helm/ocaml/getter/http_getter.mli

   1 (*
   2  * Copyright (C) 2003-2004:
   3  *    Stefano Zacchiroli <zack@cs.unibo.it>
   4  *    for the HELM Team http://helm.cs.unibo.it/
   5  *
   6  *  This file is part of HELM, an Hypertextual, Electronic
   7  *  Library of Mathematics, developed at the Computer Science
   8  *  Department, University of Bologna, Italy.
   9  *
  10  *  HELM is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU General Public License
  12  *  as published by the Free Software Foundation; either version 2
  13  *  of the License, or (at your option) any later version.
  14  *
  15  *  HELM is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with HELM; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  23  *  MA  02111-1307, USA.
  24  *
  25  *  For details, see the HELM World-Wide-Web page,
  26  *  http://helm.cs.unibo.it/
  27  *)
  28
  29 open Http_getter_types
  30
  31   (** {2 Loggers} *)
  32
  33 type logger_callback = HelmLogger.html_tag -> unit
  34
  35 val stdout_logger: logger_callback
  36
  37   (** {2 Getter Web Service interface as API *)
  38
  39 val help: unit -> string
  40
  41   (** @raise Http_getter_types.Unresolvable_URI _
  42   * @raise Http_getter_types.Key_not_found _ *)
  43 val resolve: string -> string (* uri -> url *)
  44
  45   (** @raise Http_getter_types.Key_already_in _ *)
  46 val register: uri:string -> url:string -> unit
  47
  48   (** does not fail if given uri does not exist *)
  49 val unregister: string -> unit
  50
  51 val update: ?logger:logger_callback -> unit -> unit
  52
  53   (** @param format defaults to `Gzipped
  54    * @param patch_dtd defaults to false *)
  55 val getxml  : ?format:encoding -> ?patch_dtd:bool -> string -> string
  56 val getxslt : ?patch_dtd:bool -> string -> string
  57 val getdtd  : ?patch_dtd:bool -> string -> string
  58 val clean_cache: unit -> unit
  59 val list_servers: unit -> (int * string) list
  60 val add_server: ?logger:logger_callback -> ?position:int -> string -> unit
  61 val remove_server: ?logger:logger_callback -> int -> unit
  62 val getalluris: unit -> string list
  63 val getallrdfuris: [ `Forward | `Backward ] -> string list
  64
  65   (** @param regexp regular expression (PCRE syntax) over HELM URIs *)
  66 val ls: string -> ls_item list
  67
  68   (** {2 Shorthands} *)
  69
  70 val getxml'     : UriManager.uri -> string  (* `Gzipped format, no DTD patch *)
  71 val resolve'    : UriManager.uri -> string
  72 val register'   : UriManager.uri -> string -> unit
  73 val unregister' : UriManager.uri -> unit
  74
  75   (** {2 Misc} *)
  76
  77 val close_maps: unit -> unit
  78 val update_from_one_server: ?logger:logger_callback -> string -> unit
  79 val has_server: int -> bool (* does a server with a given position exists? *)
  80 val init: unit -> unit
  81
  82   (** cal this at exit() *)
  83 val sync_dump_file: unit -> unit