X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=src%2Fguestfs.h;h=3d0ea323bd71fc8e9be3e96016cb8eff8d26f82b;hp=9b84e315ebfe956e6739114f58d22bc0df982699;hb=504177b0aad966ef6db90190ad81eb1a75a193ce;hpb=b6233d1fff5d9a6bbc61e7123a57bdd7d8cbc792 diff --git a/src/guestfs.h b/src/guestfs.h index 9b84e31..3d0ea32 100644 --- a/src/guestfs.h +++ b/src/guestfs.h @@ -1,5 +1,5 @@ /* libguestfs - * Copyright (C) 2009 Red Hat Inc. + * Copyright (C) 2009-2010 Red Hat Inc. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -19,37 +19,76 @@ #ifndef GUESTFS_H_ #define GUESTFS_H_ -/* For API documentation, please read the manual page guestfs(3). */ +/* IMPORTANT NOTE + * + * All API documentation is in the manpage, 'guestfs(3)'. + * To read it, type: + * man 3 guestfs + * Or read it online here: + * http://libguestfs.org/guestfs.3.html + * Go and read it now, I'll wait for you to come back. + */ + +#ifdef __cplusplus +extern "C" { +#endif typedef struct guestfs_h guestfs_h; -/* Create and destroy the guest handle. */ +/* Connection management. */ extern guestfs_h *guestfs_create (void); -extern void guestfs_free (guestfs_h *g); +extern void guestfs_close (guestfs_h *g); -/* Guest configuration. */ -extern int guestfs_config (guestfs_h *g, - const char *qemu_param, const char *qemu_value); -extern int guestfs_add_drive (guestfs_h *g, const char *filename); -extern int guestfs_add_cdrom (guestfs_h *g, const char *filename); +/* Error handling. */ +extern const char *guestfs_last_error (guestfs_h *g); -/* Steps to start up the guest. */ -extern int guestfs_launch (guestfs_h *g); -extern int guestfs_wait_ready (guestfs_h *g); -extern int guestfs_ready (guestfs_h *g); +typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg); +typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__)); -/* Kill the guest subprocess. */ -extern int guestfs_kill_subprocess (guestfs_h *g); +extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data); +extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **data_rtn); -/* Error handling. */ -typedef void (*guestfs_abort_fn) (void); -extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_fn); -extern guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g); +extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb); +extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g); -extern void guestfs_set_exit_on_error (guestfs_h *g, int exit_on_error); -extern int guestfs_get_exit_on_error (guestfs_h *g); +/* Events. */ +typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *data, char *buf, int len); +typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *data); +typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *data); + +extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque); +extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque); +extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque); + +#include +#include +#include + +/* PRIVATE: These are NOT part of the public, stable API, and can + * change at any time! We export them because they are used by some + * of the language bindings. + */ +struct guestfs_message_header; +struct guestfs_message_error; +extern void guestfs_error (guestfs_h *g, const char *fs, ...) + __attribute__((format (printf,2,3))); +extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...) + __attribute__((format (printf,2,3))); +extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes); +extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s); +extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes); +extern char *guestfs_safe_strdup (guestfs_h *g, const char *str); +extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size); +extern int guestfs___set_busy (guestfs_h *g); +extern int guestfs___end_busy (guestfs_h *g); +extern int guestfs___send (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args); +extern int guestfs___recv (guestfs_h *g, const char *fn, struct guestfs_message_header *hdr, struct guestfs_message_error *err, xdrproc_t xdrp, char *ret); +extern int guestfs___send_file (guestfs_h *g, const char *filename); +extern int guestfs___recv_file (guestfs_h *g, const char *filename); +/* End of private functions. */ -extern void guestfs_set_verbose (guestfs_h *g, int verbose); -extern int guestfs_get_verbose (guestfs_h *g); +#ifdef __cplusplus +} +#endif #endif /* GUESTFS_H_ */