list callback], and a command that returns nothing would have
callback type [unit callback].
- Note that errors are not returned this way. Errors result
- in the command queue being discarded and the failure_hook
- function being called. *)
+ Note that errors are not returned this way. Each function can
+ optionally supply an extra callback to handle errors, or if
+ not supplied then it defaults to the failure hook set by
+ {!set_failure_hook}. *)
val no_callback : 'a callback
(** The main thread uses this as a callback if it doesn't care about
}
(** List of domains as returned in the {!connect} callback. *)
-val connect : string option -> domain list callback -> unit
+val connect : ?fail:exn callback -> string option -> domain list callback -> unit
(** [connect uri cb] causes the slave thread to disconnect from
libvirt and connect to the libvirt [uri]. If this succeeds,
then the list of all domains fetched from libvirt and [cb] is
Although you can connect to remote hosts, libguestfs won't
usually be able to see the drives on those hosts, so it normally
- doesn't make sense to use remote URIs. *)
+ doesn't make sense to use remote URIs.
+
+ If [fail] is passed, then failures cause this callback to
+ be called. If not, the global failure hook is called. *)
type inspection_data = {
insp_all_filesystems : (string * string) list;
insp_windows_systemroot : string option;
}
-val open_domain : string -> inspection_data callback -> unit
+val open_domain : ?fail:exn callback -> string -> inspection_data callback -> unit
(** [open_domain name cb] retrieves the list of block devices for
the libvirt domain [name], creates a libguestfs handle, adds
those block devices, launches the handle, and performs
with the list of filesystems and the results of inspection.
The slave thread must be connected to libvirt (see {!connect})
- else this command will fail. *)
+ else this command will fail.
+
+ If [fail] is passed, then failures cause this callback to
+ be called. If not, the global failure hook is called. *)
-val open_images : string list -> inspection_data callback -> unit
+val open_images : ?fail:exn callback -> string list -> inspection_data callback -> unit
(** [open_images images cb] is like {!open_domain} except
- that it opens local disk image(s) directly. *)
+ that it opens local disk image(s) directly.
+
+ If [fail] is passed, then failures cause this callback to
+ be called. If not, the global failure hook is called. *)
type source = OS of inspection_os | Volume of string
(** Source type used by {!read_directory}. *)
}
(** Directory entry returned by {!read_directory}. *)
-val read_directory : source -> string -> direntry list callback -> unit
+val read_directory : ?fail:exn callback -> source -> string -> direntry list callback -> unit
(** [read_directory src dir cb] reads the contents of the directory
[dir] from source [src], and calls the callback function [cb]
with the resulting list of directory entries, if successful.
dev]), or a fully mounted up operating system (if [src] is [OS ...]).
In the second case all the mountpoints of the operating system
are mounted up so that the path may span mountpoints in the
- natural way. *)
+ natural way.
+
+ If [fail] is passed, then failures cause this callback to
+ be called. If not, the global failure hook is called. *)
val discard_command_queue : unit -> unit
(** [discard_command_queue ()] discards any commands on the command