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