src/guestfs.h

   1 /* libguestfs
   2  * Copyright (C) 2009-2010 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  *
  24  * All API documentation is in the manpage, 'guestfs(3)'.
  25  * To read it, type:
  26  *   man 3 guestfs
  27  * Or read it online here:
  28  *   http://libguestfs.org/guestfs.3.html
  29  * Go and read it now, I'll wait for you to come back.
  30  */
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef struct guestfs_h guestfs_h;
  37
  38 /* Connection management. */
  39 extern guestfs_h *guestfs_create (void);
  40 extern void guestfs_close (guestfs_h *g);
  41
  42 /* Error handling. */
  43 extern const char *guestfs_last_error (guestfs_h *g);
  44
  45 typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg);
  46 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
  47
  48 extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data);
  49 extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **data_rtn);
  50
  51 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
  52 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
  53
  54 /* Events. */
  55 typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *data, char *buf, int len);
  56 typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *data);
  57 typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *data);
  58
  59 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
  60 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
  61 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque);
  62
  63 #include <rpc/xdr.h>
  64 #include <guestfs-structs.h>
  65 #include <guestfs-actions.h>
  66
  67 /* PRIVATE: These are NOT part of the public, stable API, and can
  68  * change at any time!  We export them because they are used by some
  69  * of the language bindings.
  70  */
  71 struct guestfs_message_header;
  72 struct guestfs_message_error;
  73 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
  74   __attribute__((format (printf,2,3)));
  75 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
  76   __attribute__((format (printf,2,3)));
  77 extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
  78 extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
  79 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
  80 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
  81 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
  82 extern int guestfs___set_busy (guestfs_h *g);
  83 extern int guestfs___end_busy (guestfs_h *g);
  84 extern int guestfs___send (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args);
  85 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);
  86 extern int guestfs___send_file (guestfs_h *g, const char *filename);
  87 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
  88 /* End of private functions. */
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94 #endif /* GUESTFS_H_ */