gio/gdbuserror.h

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #ifndef __G_DBUS_ERROR_H__
  24 #define __G_DBUS_ERROR_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /**
  35  * G_DBUS_ERROR:
  36  *
  37  * Error domain for errors generated by a remote message bus. Errors
  38  * in this domain will be from the #GDBusError enumeration.  See
  39  * #GError for more information on error domains.
  40  *
  41  * Note that errors in this error domain is intended only for
  42  * returning errors from a remote message bus process. Errors
  43  * generated locally in-process by e.g. #GDBusConnection is from the
  44  * %G_IO_ERROR domain.
  45  *
  46  * Since: 2.26
  47  */
  48 #define G_DBUS_ERROR g_dbus_error_quark()
  49
  50 GLIB_AVAILABLE_IN_ALL
  51 GQuark g_dbus_error_quark (void);
  52
  53 /* Used by applications to check, get and strip the D-Bus error name */
  54 GLIB_AVAILABLE_IN_ALL
  55 gboolean g_dbus_error_is_remote_error       (const GError    *error);
  56 GLIB_AVAILABLE_IN_ALL
  57 gchar   *g_dbus_error_get_remote_error      (const GError    *error);
  58 GLIB_AVAILABLE_IN_ALL
  59 gboolean g_dbus_error_strip_remote_error    (GError          *error);
  60
  61 /**
  62  * GDBusErrorEntry:
  63  * @error_code: An error code.
  64  * @dbus_error_name: The D-Bus error name to associate with @error_code.
  65  *
  66  * Struct used in g_dbus_error_register_error_domain().
  67  *
  68  * Since: 2.26
  69  */
  70 struct _GDBusErrorEntry
  71 {
  72   gint         error_code;
  73   const gchar *dbus_error_name;
  74 };
  75
  76 GLIB_AVAILABLE_IN_ALL
  77 gboolean g_dbus_error_register_error        (GQuark                 error_domain,
  78                                              gint                   error_code,
  79                                              const gchar           *dbus_error_name);
  80 GLIB_AVAILABLE_IN_ALL
  81 gboolean g_dbus_error_unregister_error      (GQuark                 error_domain,
  82                                              gint                   error_code,
  83                                              const gchar           *dbus_error_name);
  84 GLIB_AVAILABLE_IN_ALL
  85 void     g_dbus_error_register_error_domain (const gchar           *error_domain_quark_name,
  86                                              volatile gsize        *quark_volatile,
  87                                              const GDBusErrorEntry *entries,
  88                                              guint                  num_entries);
  89
  90 /* Only used by object mappings to map back and forth to GError */
  91 GLIB_AVAILABLE_IN_ALL
  92 GError  *g_dbus_error_new_for_dbus_error    (const gchar     *dbus_error_name,
  93                                              const gchar     *dbus_error_message);
  94 GLIB_AVAILABLE_IN_ALL
  95 void     g_dbus_error_set_dbus_error        (GError         **error,
  96                                              const gchar     *dbus_error_name,
  97                                              const gchar     *dbus_error_message,
  98                                              const gchar     *format,
  99                                              ...) G_GNUC_PRINTF(4, 5);
 100 GLIB_AVAILABLE_IN_ALL
 101 void     g_dbus_error_set_dbus_error_valist (GError         **error,
 102                                              const gchar     *dbus_error_name,
 103                                              const gchar     *dbus_error_message,
 104                                              const gchar     *format,
 105                                              va_list          var_args) G_GNUC_PRINTF(4, 0);
 106 GLIB_AVAILABLE_IN_ALL
 107 gchar   *g_dbus_error_encode_gerror         (const GError    *error);
 108
 109 G_END_DECLS
 110
 111 #endif /* __G_DBUS_ERROR_H__ */