src/guestfs.h

   1 /* libguestfs
   2  * Copyright (C) 2009 Red Hat Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef GUESTFS_H_
  20 #define GUESTFS_H_
  21
  22 /* IMPORTANT NOTE!
  23  * All API documentation is in the manual page --> guestfs(3) <--
  24  * Go and read it now, I'll wait.
  25  */
  26
  27 #include <rpc/xdr.h>
  28
  29 typedef struct guestfs_h guestfs_h;
  30
  31 /* Connection management. */
  32 extern guestfs_h *guestfs_create (void);
  33 extern void guestfs_close (guestfs_h *g);
  34
  35 /* Error handling. */
  36 extern const char *guestfs_last_error (guestfs_h *g);
  37
  38 typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg);
  39 typedef void (*guestfs_abort_cb) (void);
  40
  41 extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data);
  42 extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **data_rtn);
  43
  44 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
  45 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
  46
  47 #include <guestfs-structs.h>
  48 #include <guestfs-actions.h>
  49
  50 extern void guestfs_free_int_bool (struct guestfs_int_bool *);
  51 extern void guestfs_free_lvm_pv_list (struct guestfs_lvm_pv_list *);
  52 extern void guestfs_free_lvm_vg_list (struct guestfs_lvm_vg_list *);
  53 extern void guestfs_free_lvm_lv_list (struct guestfs_lvm_lv_list *);
  54
  55 /* Low-level event API. */
  56 typedef void (*guestfs_send_cb) (guestfs_h *g, void *data);
  57 typedef void (*guestfs_reply_cb) (guestfs_h *g, void *data, XDR *xdr);
  58 typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *data, char *buf, int len);
  59 typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *data);
  60 typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *data);
  61
  62 extern void guestfs_set_send_callback (guestfs_h *g, guestfs_send_cb cb, void *opaque);
  63 extern void guestfs_set_reply_callback (guestfs_h *g, guestfs_reply_cb cb, void *opaque);
  64 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
  65 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
  66 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque);
  67
  68 /* Main loop. */
  69 #define GUESTFS_HANDLE_READABLE 0x1
  70 #define GUESTFS_HANDLE_WRITABLE 0x2
  71 #define GUESTFS_HANDLE_HANGUP   0x4
  72 #define GUESTFS_HANDLE_ERROR    0x8
  73
  74 struct guestfs_main_loop;
  75
  76 typedef void (*guestfs_handle_event_cb) (struct guestfs_main_loop *ml, guestfs_h *g, void *data, int watch, int fd, int events);
  77 typedef int (*guestfs_add_handle_cb) (struct guestfs_main_loop *ml, guestfs_h *g, int fd, int events, guestfs_handle_event_cb cb, void *data);
  78 typedef int (*guestfs_remove_handle_cb) (struct guestfs_main_loop *ml, guestfs_h *g, int watch);
  79 typedef void (*guestfs_handle_timeout_cb) (struct guestfs_main_loop *ml, guestfs_h *g, void *data, int timer);
  80 typedef int (*guestfs_add_timeout_cb) (struct guestfs_main_loop *ml, guestfs_h *g, int interval, guestfs_handle_timeout_cb cb, void *data);
  81 typedef int (*guestfs_remove_timeout_cb) (struct guestfs_main_loop *ml, guestfs_h *g, int timer);
  82 typedef int (*guestfs_main_loop_run_cb) (struct guestfs_main_loop *ml, guestfs_h *g);
  83 typedef int (*guestfs_main_loop_quit_cb) (struct guestfs_main_loop *ml, guestfs_h *g);
  84
  85 /* This is the head of the main loop structure.  Concrete implementations
  86  * use additional private data after this struct.
  87  */
  88 struct guestfs_main_loop {
  89   guestfs_add_handle_cb add_handle;
  90   guestfs_remove_handle_cb remove_handle;
  91   guestfs_add_timeout_cb add_timeout;
  92   guestfs_remove_timeout_cb remove_timeout;
  93   guestfs_main_loop_run_cb main_loop_run;
  94   guestfs_main_loop_quit_cb main_loop_quit;
  95 };
  96 typedef struct guestfs_main_loop guestfs_main_loop;
  97
  98 extern void guestfs_set_main_loop (guestfs_h *handle, guestfs_main_loop *main_loop);
  99 extern guestfs_main_loop *guestfs_get_main_loop (guestfs_h *handle);
 100 extern guestfs_main_loop *guestfs_get_default_main_loop (void);
 101
 102 extern guestfs_main_loop *guestfs_create_main_loop (void);
 103 extern void guestfs_free_main_loop (guestfs_main_loop *);
 104
 105 #endif /* GUESTFS_H_ */