-
Notifications
You must be signed in to change notification settings - Fork 0
/
odb_server.mli
65 lines (55 loc) · 3.44 KB
/
odb_server.mli
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
(*********************************************************************************)
(* Odb-server *)
(* *)
(* Copyright (C) 2011 Institut National de Recherche en Informatique *)
(* et en Automatique. All rights reserved. *)
(* *)
(* This program is free software; you can redistribute it and/or modify *)
(* it under the terms of the GNU General Public License as *)
(* published by the Free Software Foundation; either version 2 of the *)
(* License. *)
(* *)
(* This program is distributed in the hope that it will be useful, *)
(* but WITHOUT ANY WARRANTY; without even the implied warranty of *)
(* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *)
(* GNU Library General Public License for more details. *)
(* *)
(* You should have received a copy of the GNU General Public *)
(* License along with this program; if not, write to the Free Software *)
(* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA *)
(* 02111-1307 USA *)
(* *)
(* As a special exception, you have permission to link this program *)
(* with the OCaml compiler and distribute executables, as long as you *)
(* follow the requirements of the GNU GPL in regard to all of the *)
(* software in the executable aside from the OCaml compiler. *)
(* *)
(* Contact: Maxence.Guesdon@inria.fr *)
(* *)
(*********************************************************************************)
(** Server side. *)
(** The name of the server tool (i.e. "server"). If the name
of the server tool change, using this value will make
the change transparent. *)
val server_tool : string
(** The server documentation. *)
val server_doc : Odb_doc.tool_doc
(** {2 Handling command line options}
These values can be useful when creating a command-line server.
The {!start_server} function will use {!port} to known which
port to listen to.
*)
val port : int ref
(** Command line options which can be append to other command
line options.
By now, only one option, [-p], allows to set {!port}.*)
val options : (string * Arg.spec * string) list
(** Basic usage message prefix. *)
val usage : string
(** {2 Starting the server} *)
(** [start_server ()] will make the current program a server,
by listening on port number {!port}.
@param with_server_tool must be set to [false] when launching
a secondary server, since the "server" tool is already
registered in the main server. Default value is [true]. *)
val start_server : ?with_server_tool:bool -> unit -> unit