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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_DBUS_METHOD_INVOCATION_H__
  28 #define __G_DBUS_METHOD_INVOCATION_H__
  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_DBUS_METHOD_INVOCATION_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DBUS_METHOD_INVOCATION, GDBusMethodInvocationClass))
  37 #define G_DBUS_METHOD_INVOCATION_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DBUS_METHOD_INVOCATION, GDBusMethodInvocationClass))
  38 #define G_IS_DBUS_METHOD_INVOCATION(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_METHOD_INVOCATION))
  39 #define G_IS_DBUS_METHOD_INVOCATION_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DBUS_METHOD_INVOCATION))
  40
  41 typedef struct _GDBusMethodInvocationClass   GDBusMethodInvocationClass;
  42 typedef struct _GDBusMethodInvocationPrivate GDBusMethodInvocationPrivate;
  43
  44 /**
  45  * GDBusMethodInvocation:
  46  *
  47  * The #GDBusMethodInvocation structure contains only private data and
  48  * should only be accessed using the provided API.
  49  *
  50  * Since: 2.26
  51  */
  52 struct _GDBusMethodInvocation
  53 {
  54   /*< private >*/
  55   GObject parent_instance;
  56   GDBusMethodInvocationPrivate *priv;
  57 };
  58
  59 /**
  60  * GDBusMethodInvocationClass:
  61  *
  62  * Class structure for #GDBusMethodInvocation.
  63  *
  64  * Since: 2.26
  65  */
  66 struct _GDBusMethodInvocationClass
  67 {
  68   /*< private >*/
  69   GObjectClass parent_class;
  70
  71   /*< private >*/
  72   /* Padding for future expansion */
  73   void (*_g_reserved1) (void);
  74   void (*_g_reserved2) (void);
  75   void (*_g_reserved3) (void);
  76   void (*_g_reserved4) (void);
  77   void (*_g_reserved5) (void);
  78   void (*_g_reserved6) (void);
  79   void (*_g_reserved7) (void);
  80   void (*_g_reserved8) (void);
  81 };
  82
  83 GType                  g_dbus_method_invocation_get_type             (void) G_GNUC_CONST;
  84 GDBusMethodInvocation *g_dbus_method_invocation_new                  (const gchar           *sender,
  85                                                                       const gchar           *object_path,
  86                                                                       const gchar           *interface_name,
  87                                                                       const gchar           *method_name,
  88                                                                       const GDBusMethodInfo *method_info,
  89                                                                       GDBusConnection       *connection,
  90                                                                       GDBusMessage          *message,
  91                                                                       GVariant              *parameters,
  92                                                                       gpointer               user_data);
  93 const gchar           *g_dbus_method_invocation_get_sender           (GDBusMethodInvocation *invocation);
  94 const gchar           *g_dbus_method_invocation_get_object_path      (GDBusMethodInvocation *invocation);
  95 const gchar           *g_dbus_method_invocation_get_interface_name   (GDBusMethodInvocation *invocation);
  96 const gchar           *g_dbus_method_invocation_get_method_name      (GDBusMethodInvocation *invocation);
  97 const GDBusMethodInfo *g_dbus_method_invocation_get_method_info      (GDBusMethodInvocation *invocation);
  98 GDBusConnection       *g_dbus_method_invocation_get_connection       (GDBusMethodInvocation *invocation);
  99 GDBusMessage          *g_dbus_method_invocation_get_message          (GDBusMethodInvocation *invocation);
 100 GVariant              *g_dbus_method_invocation_get_parameters       (GDBusMethodInvocation *invocation);
 101 gpointer               g_dbus_method_invocation_get_user_data        (GDBusMethodInvocation *invocation);
 102
 103 void                   g_dbus_method_invocation_return_value         (GDBusMethodInvocation *invocation,
 104                                                                       GVariant              *parameters);
 105 void                   g_dbus_method_invocation_return_error         (GDBusMethodInvocation *invocation,
 106                                                                       GQuark                 domain,
 107                                                                       gint                   code,
 108                                                                       const gchar           *format,
 109                                                                       ...);
 110 void                   g_dbus_method_invocation_return_error_valist  (GDBusMethodInvocation *invocation,
 111                                                                       GQuark                 domain,
 112                                                                       gint                   code,
 113                                                                       const gchar           *format,
 114                                                                       va_list                var_args);
 115 void                   g_dbus_method_invocation_return_error_literal (GDBusMethodInvocation *invocation,
 116                                                                       GQuark                 domain,
 117                                                                       gint                   code,
 118                                                                       const gchar           *message);
 119 void                   g_dbus_method_invocation_return_gerror        (GDBusMethodInvocation *invocation,
 120                                                                       const GError          *error);
 121 void                   g_dbus_method_invocation_return_dbus_error    (GDBusMethodInvocation *invocation,
 122                                                                       const gchar           *error_name,
 123                                                                       const gchar           *error_message);
 124
 125 G_END_DECLS
 126
 127 #endif /* __G_DBUS_METHOD_INVOCATION_H__ */