gio/gdbusmethodinvocation.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_METHOD_INVOCATION_H__
  24 #define __G_DBUS_METHOD_INVOCATION_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 #define G_TYPE_DBUS_METHOD_INVOCATION         (g_dbus_method_invocation_get_type ())
  35 #define G_DBUS_METHOD_INVOCATION(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_METHOD_INVOCATION, GDBusMethodInvocation))
  36 #define G_IS_DBUS_METHOD_INVOCATION(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_METHOD_INVOCATION))
  37
  38 GLIB_AVAILABLE_IN_ALL
  39 GType                  g_dbus_method_invocation_get_type             (void) G_GNUC_CONST;
  40 GLIB_AVAILABLE_IN_ALL
  41 const gchar           *g_dbus_method_invocation_get_sender           (GDBusMethodInvocation *invocation);
  42 GLIB_AVAILABLE_IN_ALL
  43 const gchar           *g_dbus_method_invocation_get_object_path      (GDBusMethodInvocation *invocation);
  44 GLIB_AVAILABLE_IN_ALL
  45 const gchar           *g_dbus_method_invocation_get_interface_name   (GDBusMethodInvocation *invocation);
  46 GLIB_AVAILABLE_IN_ALL
  47 const gchar           *g_dbus_method_invocation_get_method_name      (GDBusMethodInvocation *invocation);
  48 GLIB_AVAILABLE_IN_ALL
  49 const GDBusMethodInfo *g_dbus_method_invocation_get_method_info      (GDBusMethodInvocation *invocation);
  50 GLIB_AVAILABLE_IN_2_38
  51 const GDBusPropertyInfo *g_dbus_method_invocation_get_property_info  (GDBusMethodInvocation *invocation);
  52 GLIB_AVAILABLE_IN_ALL
  53 GDBusConnection       *g_dbus_method_invocation_get_connection       (GDBusMethodInvocation *invocation);
  54 GLIB_AVAILABLE_IN_ALL
  55 GDBusMessage          *g_dbus_method_invocation_get_message          (GDBusMethodInvocation *invocation);
  56 GLIB_AVAILABLE_IN_ALL
  57 GVariant              *g_dbus_method_invocation_get_parameters       (GDBusMethodInvocation *invocation);
  58 GLIB_AVAILABLE_IN_ALL
  59 gpointer               g_dbus_method_invocation_get_user_data        (GDBusMethodInvocation *invocation);
  60
  61 GLIB_AVAILABLE_IN_ALL
  62 void                   g_dbus_method_invocation_return_value         (GDBusMethodInvocation *invocation,
  63                                                                       GVariant              *parameters);
  64 GLIB_AVAILABLE_IN_ALL
  65 void                   g_dbus_method_invocation_return_value_with_unix_fd_list (GDBusMethodInvocation *invocation,
  66                                                                                 GVariant              *parameters,
  67                                                                                 GUnixFDList           *fd_list);
  68 GLIB_AVAILABLE_IN_ALL
  69 void                   g_dbus_method_invocation_return_error         (GDBusMethodInvocation *invocation,
  70                                                                       GQuark                 domain,
  71                                                                       gint                   code,
  72                                                                       const gchar           *format,
  73                                                                       ...) G_GNUC_PRINTF(4, 5);
  74 GLIB_AVAILABLE_IN_ALL
  75 void                   g_dbus_method_invocation_return_error_valist  (GDBusMethodInvocation *invocation,
  76                                                                       GQuark                 domain,
  77                                                                       gint                   code,
  78                                                                       const gchar           *format,
  79                                                                       va_list                var_args)
  80                                                                       G_GNUC_PRINTF(4, 0);
  81 GLIB_AVAILABLE_IN_ALL
  82 void                   g_dbus_method_invocation_return_error_literal (GDBusMethodInvocation *invocation,
  83                                                                       GQuark                 domain,
  84                                                                       gint                   code,
  85                                                                       const gchar           *message);
  86 GLIB_AVAILABLE_IN_ALL
  87 void                   g_dbus_method_invocation_return_gerror        (GDBusMethodInvocation *invocation,
  88                                                                       const GError          *error);
  89 GLIB_AVAILABLE_IN_ALL
  90 void                   g_dbus_method_invocation_take_error           (GDBusMethodInvocation *invocation,
  91                                                                       GError                *error);
  92 GLIB_AVAILABLE_IN_ALL
  93 void                   g_dbus_method_invocation_return_dbus_error    (GDBusMethodInvocation *invocation,
  94                                                                       const gchar           *error_name,
  95                                                                       const gchar           *error_message);
  96
  97 G_END_DECLS
  98
  99 #endif /* __G_DBUS_METHOD_INVOCATION_H__ */