src/types.mli

   1 (* 'top'-like tool for libvirt domains.
   2    (C) Copyright 2007-2017 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 (* XXX We should get rid of this type. *)
  21 type setup =
  22     Libvirt.ro Libvirt.Connect.t        (* connection *)
  23     * bool * bool * bool * bool         (* batch, script, csv, stream mode *)
  24     * Libvirt.Connect.node_info         (* node_info *)
  25     * string                            (* hostname *)
  26     * (int * int * int)                 (* libvirt version *)
  27
  28 (* Sort order. *)
  29 type sort_order =
  30   | DomainID | DomainName | Processor | Memory | Time
  31   | NetRX | NetTX | BlockRdRq | BlockWrRq
  32
  33 val all_sort_fields : sort_order list
  34 val printable_sort_order : sort_order -> string
  35 val sort_order_of_cli : string -> sort_order
  36 val cli_of_sort_order : sort_order -> string
  37
  38 (* Current major display mode: TaskDisplay is the normal display. *)
  39 type display = TaskDisplay | PCPUDisplay | BlockDisplay | NetDisplay
  40
  41 val display_of_cli : string -> display
  42 val cli_of_display : display -> string
  43
  44 (* Helpers for manipulating block_stats & interface_stats. *)
  45 val sum_block_stats : Libvirt.Domain.block_stats list -> Libvirt.Domain.block_stats
  46 val diff_block_stats : Libvirt.Domain.block_stats -> Libvirt.Domain.block_stats -> Libvirt.Domain.block_stats
  47
  48 val sum_interface_stats : Libvirt.Domain.interface_stats list -> Libvirt.Domain.interface_stats
  49 val diff_interface_stats : Libvirt.Domain.interface_stats -> Libvirt.Domain.interface_stats -> Libvirt.Domain.interface_stats