gio/gdbusproxy.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_PROXY_H__
  28 #define __G_DBUS_PROXY_H__
  29
  30 #include <gio/giotypes.h>
  31 #include <gio/gdbusintrospection.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define G_TYPE_DBUS_PROXY         (g_dbus_proxy_get_type ())
  36 #define G_DBUS_PROXY(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DBUS_PROXY, GDBusProxy))
  37 #define G_DBUS_PROXY_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DBUS_PROXY, GDBusProxyClass))
  38 #define G_DBUS_PROXY_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DBUS_PROXY, GDBusProxyClass))
  39 #define G_IS_DBUS_PROXY(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DBUS_PROXY))
  40 #define G_IS_DBUS_PROXY_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DBUS_PROXY))
  41
  42 typedef struct _GDBusProxyClass   GDBusProxyClass;
  43 typedef struct _GDBusProxyPrivate GDBusProxyPrivate;
  44
  45 /**
  46  * GDBusProxy:
  47  *
  48  * The #GDBusProxy structure contains only private data and
  49  * should only be accessed using the provided API.
  50  *
  51  * Since: 2.26
  52  */
  53 struct _GDBusProxy
  54 {
  55   /*< private >*/
  56   GObject parent_instance;
  57   GDBusProxyPrivate *priv;
  58 };
  59
  60 /**
  61  * GDBusProxyClass:
  62  * @g_properties_changed: Signal class handler for the #GDBusProxy::g-properties-changed signal.
  63  * @g_signal: Signal class handler for the #GDBusProxy::g-signal signal.
  64  *
  65  * Class structure for #GDBusProxy.
  66  *
  67  * Since: 2.26
  68  */
  69 struct _GDBusProxyClass
  70 {
  71   /*< private >*/
  72   GObjectClass parent_class;
  73
  74   /*< public >*/
  75   /* Signals */
  76   void (*g_properties_changed) (GDBusProxy          *proxy,
  77                                 GVariant            *changed_properties,
  78                                 const gchar* const  *invalidated_properties);
  79   void (*g_signal)             (GDBusProxy          *proxy,
  80                                 const gchar         *sender_name,
  81                                 const gchar         *signal_name,
  82                                 GVariant            *parameters);
  83
  84   /*< private >*/
  85   /* Padding for future expansion */
  86   gpointer padding[32];
  87 };
  88
  89 GType            g_dbus_proxy_get_type                  (void) G_GNUC_CONST;
  90 void             g_dbus_proxy_new                       (GDBusConnection     *connection,
  91                                                          GDBusProxyFlags      flags,
  92                                                          GDBusInterfaceInfo *info,
  93                                                          const gchar         *name,
  94                                                          const gchar         *object_path,
  95                                                          const gchar         *interface_name,
  96                                                          GCancellable        *cancellable,
  97                                                          GAsyncReadyCallback  callback,
  98                                                          gpointer             user_data);
  99 GDBusProxy      *g_dbus_proxy_new_finish                (GAsyncResult        *res,
 100                                                          GError             **error);
 101 GDBusProxy      *g_dbus_proxy_new_sync                  (GDBusConnection     *connection,
 102                                                          GDBusProxyFlags      flags,
 103                                                          GDBusInterfaceInfo *info,
 104                                                          const gchar         *name,
 105                                                          const gchar         *object_path,
 106                                                          const gchar         *interface_name,
 107                                                          GCancellable        *cancellable,
 108                                                          GError             **error);
 109 void             g_dbus_proxy_new_for_bus               (GBusType             bus_type,
 110                                                          GDBusProxyFlags      flags,
 111                                                          GDBusInterfaceInfo *info,
 112                                                          const gchar         *name,
 113                                                          const gchar         *object_path,
 114                                                          const gchar         *interface_name,
 115                                                          GCancellable        *cancellable,
 116                                                          GAsyncReadyCallback  callback,
 117                                                          gpointer             user_data);
 118 GDBusProxy      *g_dbus_proxy_new_for_bus_finish        (GAsyncResult        *res,
 119                                                          GError             **error);
 120 GDBusProxy      *g_dbus_proxy_new_for_bus_sync          (GBusType             bus_type,
 121                                                          GDBusProxyFlags      flags,
 122                                                          GDBusInterfaceInfo *info,
 123                                                          const gchar         *name,
 124                                                          const gchar         *object_path,
 125                                                          const gchar         *interface_name,
 126                                                          GCancellable        *cancellable,
 127                                                          GError             **error);
 128 GDBusConnection *g_dbus_proxy_get_connection            (GDBusProxy          *proxy);
 129 GDBusProxyFlags  g_dbus_proxy_get_flags                 (GDBusProxy          *proxy);
 130 const gchar     *g_dbus_proxy_get_name                  (GDBusProxy          *proxy);
 131 gchar           *g_dbus_proxy_get_name_owner            (GDBusProxy          *proxy);
 132 const gchar     *g_dbus_proxy_get_object_path           (GDBusProxy          *proxy);
 133 const gchar     *g_dbus_proxy_get_interface_name        (GDBusProxy          *proxy);
 134 gint             g_dbus_proxy_get_default_timeout       (GDBusProxy          *proxy);
 135 void             g_dbus_proxy_set_default_timeout       (GDBusProxy          *proxy,
 136                                                          gint                 timeout_msec);
 137 GDBusInterfaceInfo *g_dbus_proxy_get_interface_info     (GDBusProxy          *proxy);
 138 void             g_dbus_proxy_set_interface_info        (GDBusProxy           *proxy,
 139                                                          GDBusInterfaceInfo   *info);
 140 GVariant        *g_dbus_proxy_get_cached_property       (GDBusProxy          *proxy,
 141                                                          const gchar         *property_name);
 142 void             g_dbus_proxy_set_cached_property       (GDBusProxy          *proxy,
 143                                                          const gchar         *property_name,
 144                                                          GVariant            *value);
 145 gchar          **g_dbus_proxy_get_cached_property_names (GDBusProxy          *proxy);
 146 void             g_dbus_proxy_call                      (GDBusProxy          *proxy,
 147                                                          const gchar         *method_name,
 148                                                          GVariant            *parameters,
 149                                                          GDBusCallFlags       flags,
 150                                                          gint                 timeout_msec,
 151                                                          GCancellable        *cancellable,
 152                                                          GAsyncReadyCallback  callback,
 153                                                          gpointer             user_data);
 154 GVariant        *g_dbus_proxy_call_finish               (GDBusProxy          *proxy,
 155                                                          GAsyncResult        *res,
 156                                                          GError             **error);
 157 GVariant        *g_dbus_proxy_call_sync                 (GDBusProxy          *proxy,
 158                                                          const gchar         *method_name,
 159                                                          GVariant            *parameters,
 160                                                          GDBusCallFlags       flags,
 161                                                          gint                 timeout_msec,
 162                                                          GCancellable        *cancellable,
 163                                                          GError             **error);
 164
 165 void             g_dbus_proxy_call_with_unix_fd_list        (GDBusProxy          *proxy,
 166                                                              const gchar         *method_name,
 167                                                              GVariant            *parameters,
 168                                                              GDBusCallFlags       flags,
 169                                                              gint                 timeout_msec,
 170                                                              GUnixFDList         *fd_list,
 171                                                              GCancellable        *cancellable,
 172                                                              GAsyncReadyCallback  callback,
 173                                                              gpointer             user_data);
 174 GVariant        *g_dbus_proxy_call_with_unix_fd_list_finish (GDBusProxy          *proxy,
 175                                                              GUnixFDList        **out_fd_list,
 176                                                              GAsyncResult        *res,
 177                                                              GError             **error);
 178 GVariant        *g_dbus_proxy_call_with_unix_fd_list_sync   (GDBusProxy          *proxy,
 179                                                              const gchar         *method_name,
 180                                                              GVariant            *parameters,
 181                                                              GDBusCallFlags       flags,
 182                                                              gint                 timeout_msec,
 183                                                              GUnixFDList         *fd_list,
 184                                                              GUnixFDList        **out_fd_list,
 185                                                              GCancellable        *cancellable,
 186                                                              GError             **error);
 187
 188 G_END_DECLS
 189
 190 #endif /* __G_DBUS_PROXY_H__ */