gio/gdbuserror.h

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2009 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 #include <gio/giotypes.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /**
  31  * G_DBUS_ERROR:
  32  *
  33  * Error domain for errors generated by a remote message bus. Errors
  34  * in this domain will be from the #GDBusError enumeration.  See
  35  * #GError for more information on error domains.
  36  *
  37  * Note that errors in this error domain is intended only for
  38  * returning errors from a remote message bus process. Errors
  39  * generated locally in-process by e.g. #GDBusConnection is from the
  40  * %G_IO_ERROR domain.
  41  */
  42 #define G_DBUS_ERROR g_dbus_error_quark()
  43
  44 GQuark g_dbus_error_quark (void);
  45
  46 /* Used by applications to check, get and strip the D-Bus error name */
  47 gboolean g_dbus_error_is_remote_error       (const GError    *error);
  48 gchar   *g_dbus_error_get_remote_error      (const GError    *error);
  49 gboolean g_dbus_error_strip_remote_error    (GError          *error);
  50
  51 /**
  52  * GDBusErrorEntry:
  53  * @error_code: An error code.
  54  * @dbus_error_name: The D-Bus error name to associate with @error_code.
  55  *
  56  * Struct used in g_dbus_error_register_error_domain().
  57  */
  58 struct _GDBusErrorEntry
  59 {
  60   gint         error_code;
  61   const gchar *dbus_error_name;
  62 };
  63
  64 gboolean g_dbus_error_register_error        (GQuark                 error_domain,
  65                                              gint                   error_code,
  66                                              const gchar           *dbus_error_name);
  67 gboolean g_dbus_error_unregister_error      (GQuark                 error_domain,
  68                                              gint                   error_code,
  69                                              const gchar           *dbus_error_name);
  70 void     g_dbus_error_register_error_domain (const gchar           *error_domain_quark_name,
  71                                              volatile gsize        *quark_volatile,
  72                                              const GDBusErrorEntry *entries,
  73                                              guint                  num_entries);
  74
  75 /* Only used by object mappings to map back and forth to GError */
  76 GError  *g_dbus_error_new_for_dbus_error    (const gchar     *dbus_error_name,
  77                                              const gchar     *dbus_error_message);
  78 void     g_dbus_error_set_dbus_error        (GError         **error,
  79                                              const gchar     *dbus_error_name,
  80                                              const gchar     *dbus_error_message,
  81                                              const gchar     *format,
  82                                              ...);
  83 void     g_dbus_error_set_dbus_error_valist (GError         **error,
  84                                              const gchar     *dbus_error_name,
  85                                              const gchar     *dbus_error_message,
  86                                              const gchar     *format,
  87                                              va_list          var_args);
  88 gchar   *g_dbus_error_encode_gerror         (const GError    *error);
  89
  90 G_END_DECLS
  91
  92 #endif /* __G_DBUS_ERROR_H__ */