Add contrib directory, and non-upstream patch to add Domain.get_cpu_stats_total.
[ocaml-libvirt.git] / libvirt / libvirt.mli
index d927bda..5a288c0 100644 (file)
@@ -239,7 +239,6 @@ type conn_t =
     | Read_only of Libvirt.ro Libvirt.Connect.t
     | Read_write of Libvirt.rw Libvirt.Connect.t
 ]}
-       See also the source of [mlvirsh].
     *)
 
 (** {3 Forward definitions}
@@ -436,6 +435,13 @@ sig
     | SchedFieldInt64 of int64 | SchedFieldUInt64 of int64
     | SchedFieldFloat of float | SchedFieldBool of bool
 
+  type typed_param = string * typed_param_value
+  and typed_param_value =
+    | TypedFieldInt32 of int32 | TypedFieldUInt32 of int32
+    | TypedFieldInt64 of int64 | TypedFieldUInt64 of int64
+    | TypedFieldFloat of float | TypedFieldBool of bool
+    | TypedFieldString of string
+
   type migrate_flag = Live
 
   type memory_flag = Virtual
@@ -469,26 +475,6 @@ sig
        functions.  If you want to peek more than this then you must
        break your request into chunks. *)
 
-  val list_all_domains : 'a Connect.t -> ?want_info:bool -> list_flag list -> 'a t array * info array
-    (** [list_all_domains conn flags] returns all domains which
-       match [flags].
-
-       This can return both active and inactive domains.  The
-       list of flags controls what domains are returned.  See
-       {!list_flag}.
-
-       The two arrays returned will have the same length, unless
-       [~want_info] is [false] in which case the info array
-       will be zero-length.  The default for [~want_info] is [true].
-       In most cases there is no extra penalty for getting the
-       info fields, or the penalty is insignificant.
-
-       This call was introduced in libvirt 0.4.5.  Because you
-       might dynamically link to an older version of libvirt which
-       doesn't have this call, you should use {!get_domains}
-       or {!get_domains_and_infos} which use the most efficient
-       way to get domains for the available version of libvirt.
-    *)
   val create_linux : [>`W] Connect.t -> xml -> rw t
     (** Create a new guest domain (not necessarily a Linux one)
        from the given XML.
@@ -573,6 +559,10 @@ sig
        for a domain.  See the libvirt documentation for details
        of the array and bitmap returned from this function.
     *)
+  val get_cpu_stats : [>`R] t -> typed_param list array
+    (** [get_pcpu_stats dom] returns the physical CPU stats
+       for a domain.  See the libvirt documentation for details.
+    *)
   val get_max_vcpus : [>`R] t -> int
     (** Returns the maximum number of vCPUs supported for this domain. *)
   val attach_device : [>`W] t -> xml -> unit
@@ -626,7 +616,6 @@ sig
 
        See also:
        {!get_domains_and_infos},
-       {!list_all_domains},
        {!Connect.list_domains},
        {!Connect.list_defined_domains}.
   *)
@@ -639,7 +628,6 @@ sig
 
        See also:
        {!get_domains},
-       {!list_all_domains},
        {!Connect.list_domains},
        {!Connect.list_defined_domains},
        {!get_info}.