efa5f56417b9cb8fbe5cbaf801ad2511fe003c34
[virt-top.git] / virt-top / virt_top.mli
1 (* 'top'-like tool for libvirt domains.
2    (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
3    http://libvirt.org/
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software
17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 *)
19
20 (* Hook for virt_top_xml to override (if present). *)
21 val parse_device_xml :
22   (int -> [ `R ] Libvirt.Domain.t -> string list * string list) ref
23
24 (* Hooks for virt_top_csv to override (if present). *)
25 val csv_start : (string -> unit) ref
26 val csv_write : (string list -> unit) ref
27
28 (* Hook for virt_top_calendar to override (if present). *)
29 val parse_date_time : (string -> float) ref
30
31 type setup =
32     Libvirt.ro Libvirt.Connect.t        (* connection *)
33     * bool * bool * bool                (* batch, script, csv modes *)
34     * Libvirt.Connect.node_info         (* node_info *)
35     * string                            (* hostname *)
36     * (int * int * int)                 (* libvirt version *)
37
38 val start_up : unit -> setup
39 val main_loop : setup -> unit