gio/gdbusproxy.c

   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 #include "config.h"
  24
  25 #include <stdlib.h>
  26 #include <string.h>
  27
  28 #include <gobject/gvaluecollector.h>
  29
  30 #include "gdbusutils.h"
  31 #include "gdbusproxy.h"
  32 #include "gioenumtypes.h"
  33 #include "gdbusconnection.h"
  34 #include "gdbuserror.h"
  35 #include "gdbusprivate.h"
  36 #include "gio-marshal.h"
  37 #include "ginitable.h"
  38 #include "gasyncinitable.h"
  39 #include "gioerror.h"
  40 #include "gasyncresult.h"
  41 #include "gsimpleasyncresult.h"
  42
  43 #include "glibintl.h"
  44 #include "gioalias.h"
  45
  46 /**
  47  * SECTION:gdbusproxy
  48  * @short_description: Base class for proxies
  49  * @include: gio/gio.h
  50  *
  51  * #GDBusProxy is a base class used for proxies to access a D-Bus
  52  * interface on a remote object. A #GDBusProxy can only be constructed
  53  * for unique name bus and does not track whether the name
  54  * vanishes. Use g_bus_watch_proxy() to construct #GDBusProxy proxies
  55  * for owners of a well-known names.
  56  *
  57  * By default, #GDBusProxy will cache all properties (and listen for
  58  * their changes) of the remote object, and proxy all signals that gets
  59  * emitted. This behaviour can be changed by passing suitable
  60  * #GDBusProxyFlags when the proxy is created.
  61  *
  62  * The generic #GDBusProxy::g-properties-changed and #GDBusProxy::g-signal
  63  * signals are not very convenient to work with. Therefore, the recommended
  64  * way of working with proxies is to subclass #GDBusProxy, and have
  65  * more natural properties and signals in your derived class. The
  66  * @interface_type argument of g_bus_watch_proxy() lets you obtain
  67  * instances of your derived class when using the high-level API.
  68  *
  69  * See <xref linkend="gdbus-example-proxy-subclass"/> for an example.
  70  */
  71
  72 struct _GDBusProxyPrivate
  73 {
  74   GDBusConnection *connection;
  75   GDBusProxyFlags flags;
  76   gchar *unique_bus_name;
  77   gchar *object_path;
  78   gchar *interface_name;
  79   gint timeout_msec;
  80
  81   /* gchar* -> GVariant* */
  82   GHashTable *properties;
  83
  84   GDBusInterfaceInfo *expected_interface;
  85
  86   guint properties_changed_subscriber_id;
  87   guint signals_subscriber_id;
  88
  89   gboolean initialized;
  90 };
  91
  92 enum
  93 {
  94   PROP_0,
  95   PROP_G_CONNECTION,
  96   PROP_G_UNIQUE_BUS_NAME,
  97   PROP_G_FLAGS,
  98   PROP_G_OBJECT_PATH,
  99   PROP_G_INTERFACE_NAME,
 100   PROP_G_DEFAULT_TIMEOUT,
 101   PROP_G_INTERFACE_INFO
 102 };
 103
 104 enum
 105 {
 106   PROPERTIES_CHANGED_SIGNAL,
 107   SIGNAL_SIGNAL,
 108   LAST_SIGNAL,
 109 };
 110
 111 static void g_dbus_proxy_constructed (GObject *object);
 112
 113 guint signals[LAST_SIGNAL] = {0};
 114
 115 static void initable_iface_init       (GInitableIface *initable_iface);
 116 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
 117
 118 G_DEFINE_TYPE_WITH_CODE (GDBusProxy, g_dbus_proxy, G_TYPE_OBJECT,
 119                          G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
 120                          G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
 121                          );
 122
 123 static void
 124 g_dbus_proxy_finalize (GObject *object)
 125 {
 126   GDBusProxy *proxy = G_DBUS_PROXY (object);
 127
 128   if (proxy->priv->properties_changed_subscriber_id > 0)
 129     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
 130                                           proxy->priv->properties_changed_subscriber_id);
 131
 132   if (proxy->priv->signals_subscriber_id > 0)
 133     g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
 134                                           proxy->priv->signals_subscriber_id);
 135
 136   g_object_unref (proxy->priv->connection);
 137   g_free (proxy->priv->unique_bus_name);
 138   g_free (proxy->priv->object_path);
 139   g_free (proxy->priv->interface_name);
 140   if (proxy->priv->properties != NULL)
 141     g_hash_table_unref (proxy->priv->properties);
 142
 143   if (proxy->priv->expected_interface != NULL)
 144     g_dbus_interface_info_unref (proxy->priv->expected_interface);
 145
 146   G_OBJECT_CLASS (g_dbus_proxy_parent_class)->finalize (object);
 147 }
 148
 149 static void
 150 g_dbus_proxy_get_property (GObject    *object,
 151                            guint       prop_id,
 152                            GValue     *value,
 153                            GParamSpec *pspec)
 154 {
 155   GDBusProxy *proxy = G_DBUS_PROXY (object);
 156
 157   switch (prop_id)
 158     {
 159     case PROP_G_CONNECTION:
 160       g_value_set_object (value, proxy->priv->connection);
 161       break;
 162
 163     case PROP_G_FLAGS:
 164       g_value_set_flags (value, proxy->priv->flags);
 165       break;
 166
 167     case PROP_G_UNIQUE_BUS_NAME:
 168       g_value_set_string (value, proxy->priv->unique_bus_name);
 169       break;
 170
 171     case PROP_G_OBJECT_PATH:
 172       g_value_set_string (value, proxy->priv->object_path);
 173       break;
 174
 175     case PROP_G_INTERFACE_NAME:
 176       g_value_set_string (value, proxy->priv->interface_name);
 177       break;
 178
 179     case PROP_G_DEFAULT_TIMEOUT:
 180       g_value_set_int (value, proxy->priv->timeout_msec);
 181       break;
 182
 183     case PROP_G_INTERFACE_INFO:
 184       g_value_set_boxed (value, g_dbus_proxy_get_interface_info (proxy));
 185       break;
 186
 187     default:
 188       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 189       break;
 190     }
 191 }
 192
 193 static void
 194 g_dbus_proxy_set_property (GObject      *object,
 195                            guint         prop_id,
 196                            const GValue *value,
 197                            GParamSpec   *pspec)
 198 {
 199   GDBusProxy *proxy = G_DBUS_PROXY (object);
 200
 201   switch (prop_id)
 202     {
 203     case PROP_G_CONNECTION:
 204       proxy->priv->connection = g_value_dup_object (value);
 205       break;
 206
 207     case PROP_G_FLAGS:
 208       proxy->priv->flags = g_value_get_flags (value);
 209       break;
 210
 211     case PROP_G_UNIQUE_BUS_NAME:
 212       proxy->priv->unique_bus_name = g_value_dup_string (value);
 213       break;
 214
 215     case PROP_G_OBJECT_PATH:
 216       proxy->priv->object_path = g_value_dup_string (value);
 217       break;
 218
 219     case PROP_G_INTERFACE_NAME:
 220       proxy->priv->interface_name = g_value_dup_string (value);
 221       break;
 222
 223     case PROP_G_DEFAULT_TIMEOUT:
 224       g_dbus_proxy_set_default_timeout (proxy, g_value_get_int (value));
 225       break;
 226
 227     case PROP_G_INTERFACE_INFO:
 228       g_dbus_proxy_set_interface_info (proxy, g_value_get_boxed (value));
 229       break;
 230
 231     default:
 232       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 233       break;
 234     }
 235 }
 236
 237 static void
 238 g_dbus_proxy_class_init (GDBusProxyClass *klass)
 239 {
 240   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 241
 242   gobject_class->finalize     = g_dbus_proxy_finalize;
 243   gobject_class->set_property = g_dbus_proxy_set_property;
 244   gobject_class->get_property = g_dbus_proxy_get_property;
 245   gobject_class->constructed  = g_dbus_proxy_constructed;
 246
 247   /* Note that all property names are prefixed to avoid collisions with D-Bus property names
 248    * in derived classes */
 249
 250   /**
 251    * GDBusProxy:g-interface-info:
 252    *
 253    * Ensure that interactions with this proxy conform to the given
 254    * interface.  For example, when completing a method call, if the
 255    * type signature of the message isn't what's expected, the given
 256    * #GError is set.  Signals that have a type signature mismatch are
 257    * simply dropped.
 258    *
 259    * Since: 2.26
 260    */
 261   g_object_class_install_property (gobject_class,
 262                                    PROP_G_INTERFACE_INFO,
 263                                    g_param_spec_boxed ("g-interface-info",
 264                                                        P_("Interface Information"),
 265                                                        P_("Interface Information"),
 266                                                        G_TYPE_DBUS_INTERFACE_INFO,
 267                                                        G_PARAM_READABLE |
 268                                                        G_PARAM_WRITABLE |
 269                                                        G_PARAM_STATIC_NAME |
 270                                                        G_PARAM_STATIC_BLURB |
 271                                                        G_PARAM_STATIC_NICK));
 272
 273   /**
 274    * GDBusProxy:g-connection:
 275    *
 276    * The #GDBusConnection the proxy is for.
 277    *
 278    * Since: 2.26
 279    */
 280   g_object_class_install_property (gobject_class,
 281                                    PROP_G_CONNECTION,
 282                                    g_param_spec_object ("g-connection",
 283                                                         P_("g-connection"),
 284                                                         P_("The connection the proxy is for"),
 285                                                         G_TYPE_DBUS_CONNECTION,
 286                                                         G_PARAM_READABLE |
 287                                                         G_PARAM_WRITABLE |
 288                                                         G_PARAM_CONSTRUCT_ONLY |
 289                                                         G_PARAM_STATIC_NAME |
 290                                                         G_PARAM_STATIC_BLURB |
 291                                                         G_PARAM_STATIC_NICK));
 292
 293   /**
 294    * GDBusProxy:g-flags:
 295    *
 296    * Flags from the #GDBusProxyFlags enumeration.
 297    *
 298    * Since: 2.26
 299    */
 300   g_object_class_install_property (gobject_class,
 301                                    PROP_G_FLAGS,
 302                                    g_param_spec_flags ("g-flags",
 303                                                        P_("g-flags"),
 304                                                        P_("Flags for the proxy"),
 305                                                        G_TYPE_DBUS_PROXY_FLAGS,
 306                                                        G_DBUS_PROXY_FLAGS_NONE,
 307                                                        G_PARAM_READABLE |
 308                                                        G_PARAM_WRITABLE |
 309                                                        G_PARAM_CONSTRUCT_ONLY |
 310                                                        G_PARAM_STATIC_NAME |
 311                                                        G_PARAM_STATIC_BLURB |
 312                                                        G_PARAM_STATIC_NICK));
 313
 314   /**
 315    * GDBusProxy:g-unique-bus-name:
 316    *
 317    * The unique bus name the proxy is for.
 318    *
 319    * Since: 2.26
 320    */
 321   g_object_class_install_property (gobject_class,
 322                                    PROP_G_UNIQUE_BUS_NAME,
 323                                    g_param_spec_string ("g-unique-bus-name",
 324                                                         P_("g-unique-bus-name"),
 325                                                         P_("The unique bus name the proxy is for"),
 326                                                         NULL,
 327                                                         G_PARAM_READABLE |
 328                                                         G_PARAM_WRITABLE |
 329                                                         G_PARAM_CONSTRUCT_ONLY |
 330                                                         G_PARAM_STATIC_NAME |
 331                                                         G_PARAM_STATIC_BLURB |
 332                                                         G_PARAM_STATIC_NICK));
 333
 334   /**
 335    * GDBusProxy:g-object-path:
 336    *
 337    * The object path the proxy is for.
 338    *
 339    * Since: 2.26
 340    */
 341   g_object_class_install_property (gobject_class,
 342                                    PROP_G_OBJECT_PATH,
 343                                    g_param_spec_string ("g-object-path",
 344                                                         P_("g-object-path"),
 345                                                         P_("The object path the proxy is for"),
 346                                                         NULL,
 347                                                         G_PARAM_READABLE |
 348                                                         G_PARAM_WRITABLE |
 349                                                         G_PARAM_CONSTRUCT_ONLY |
 350                                                         G_PARAM_STATIC_NAME |
 351                                                         G_PARAM_STATIC_BLURB |
 352                                                         G_PARAM_STATIC_NICK));
 353
 354   /**
 355    * GDBusProxy:g-interface-name:
 356    *
 357    * The D-Bus interface name the proxy is for.
 358    *
 359    * Since: 2.26
 360    */
 361   g_object_class_install_property (gobject_class,
 362                                    PROP_G_INTERFACE_NAME,
 363                                    g_param_spec_string ("g-interface-name",
 364                                                         P_("g-interface-name"),
 365                                                         P_("The D-Bus interface name the proxy is for"),
 366                                                         NULL,
 367                                                         G_PARAM_READABLE |
 368                                                         G_PARAM_WRITABLE |
 369                                                         G_PARAM_CONSTRUCT_ONLY |
 370                                                         G_PARAM_STATIC_NAME |
 371                                                         G_PARAM_STATIC_BLURB |
 372                                                         G_PARAM_STATIC_NICK));
 373
 374   /**
 375    * GDBusProxy:g-default-timeout:
 376    *
 377    * The timeout to use if -1 (specifying default timeout) is passed
 378    * as @timeout_msec in the g_dbus_proxy_call() and
 379    * g_dbus_proxy_call_sync() functions.
 380    *
 381    * This allows applications to set a proxy-wide timeout for all
 382    * remote method invocations on the proxy. If this property is -1,
 383    * the default timeout (typically 25 seconds) is used. If set to
 384    * %G_MAXINT, then no timeout is used.
 385    *
 386    * Since: 2.26
 387    */
 388   g_object_class_install_property (gobject_class,
 389                                    PROP_G_DEFAULT_TIMEOUT,
 390                                    g_param_spec_int ("g-default-timeout",
 391                                                      P_("Default Timeout"),
 392                                                      P_("Timeout for remote method invocation"),
 393                                                      -1,
 394                                                      G_MAXINT,
 395                                                      -1,
 396                                                      G_PARAM_READABLE |
 397                                                      G_PARAM_WRITABLE |
 398                                                      G_PARAM_CONSTRUCT |
 399                                                      G_PARAM_STATIC_NAME |
 400                                                      G_PARAM_STATIC_BLURB |
 401                                                      G_PARAM_STATIC_NICK));
 402
 403   /**
 404    * GDBusProxy::g-properties-changed:
 405    * @proxy: The #GDBusProxy emitting the signal.
 406    * @changed_properties: A #GVariant containing the properties that changed
 407    * @invalidated_properties: A %NULL terminated array of properties that was invalidated
 408    *
 409    * Emitted when one or more D-Bus properties on @proxy changes. The
 410    * local cache has already been updated when this signal fires. Note
 411    * that both @changed_properties and @invalidated_properties are
 412    * guaranteed to never be %NULL (either may be empty though).
 413    *
 414    * This signal corresponds to the
 415    * <literal>PropertiesChanged</literal> D-Bus signal on the
 416    * <literal>org.freedesktop.DBus.Properties</literal> interface.
 417    *
 418    * Since: 2.26
 419    */
 420   signals[PROPERTIES_CHANGED_SIGNAL] = g_signal_new ("g-properties-changed",
 421                                                      G_TYPE_DBUS_PROXY,
 422                                                      G_SIGNAL_RUN_LAST,
 423                                                      G_STRUCT_OFFSET (GDBusProxyClass, g_properties_changed),
 424                                                      NULL,
 425                                                      NULL,
 426                                                      _gio_marshal_VOID__BOXED_BOXED,
 427                                                      G_TYPE_NONE,
 428                                                      2,
 429                                                      G_TYPE_VARIANT,
 430                                                      G_TYPE_STRV | G_SIGNAL_TYPE_STATIC_SCOPE);
 431
 432   /**
 433    * GDBusProxy::g-signal:
 434    * @proxy: The #GDBusProxy emitting the signal.
 435    * @sender_name: The sender of the signal or %NULL if the connection is not a bus connection.
 436    * @signal_name: The name of the signal.
 437    * @parameters: A #GVariant tuple with parameters for the signal.
 438    *
 439    * Emitted when a signal from the remote object and interface that @proxy is for, has been received.
 440    *
 441    * Since: 2.26
 442    */
 443   signals[SIGNAL_SIGNAL] = g_signal_new ("g-signal",
 444                                          G_TYPE_DBUS_PROXY,
 445                                          G_SIGNAL_RUN_LAST,
 446                                          G_STRUCT_OFFSET (GDBusProxyClass, g_signal),
 447                                          NULL,
 448                                          NULL,
 449                                          _gio_marshal_VOID__STRING_STRING_BOXED,
 450                                          G_TYPE_NONE,
 451                                          3,
 452                                          G_TYPE_STRING,
 453                                          G_TYPE_STRING,
 454                                          G_TYPE_VARIANT);
 455
 456
 457   g_type_class_add_private (klass, sizeof (GDBusProxyPrivate));
 458 }
 459
 460 static void
 461 g_dbus_proxy_init (GDBusProxy *proxy)
 462 {
 463   proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy, G_TYPE_DBUS_PROXY, GDBusProxyPrivate);
 464   proxy->priv->properties = g_hash_table_new_full (g_str_hash,
 465                                                    g_str_equal,
 466                                                    g_free,
 467                                                    (GDestroyNotify) g_variant_unref);
 468 }
 469
 470 /* ---------------------------------------------------------------------------------------------------- */
 471
 472 /**
 473  * g_dbus_proxy_get_cached_property_names:
 474  * @proxy: A #GDBusProxy.
 475  *
 476  * Gets the names of all cached properties on @proxy.
 477  *
 478  * Returns: A %NULL-terminated array of strings or %NULL if @proxy has
 479  * no cached properties. Free the returned array with g_strfreev().
 480  *
 481  * Since: 2.26
 482  */
 483 gchar **
 484 g_dbus_proxy_get_cached_property_names (GDBusProxy  *proxy)
 485 {
 486   gchar **names;
 487   GPtrArray *p;
 488   GHashTableIter iter;
 489   const gchar *key;
 490
 491   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
 492
 493   names = NULL;
 494   if (g_hash_table_size (proxy->priv->properties) == 0)
 495     goto out;
 496
 497   p = g_ptr_array_new ();
 498
 499   g_hash_table_iter_init (&iter, proxy->priv->properties);
 500   while (g_hash_table_iter_next (&iter, (gpointer) &key, NULL))
 501     g_ptr_array_add (p, g_strdup (key));
 502   g_ptr_array_sort (p, (GCompareFunc) g_strcmp0);
 503   g_ptr_array_add (p, NULL);
 504
 505   names = (gchar **) g_ptr_array_free (p, FALSE);
 506
 507  out:
 508   return names;
 509 }
 510
 511 static const GDBusPropertyInfo *
 512 lookup_property_info_or_warn (GDBusProxy  *proxy,
 513                               const gchar *property_name)
 514 {
 515   const GDBusPropertyInfo *info;
 516
 517   if (proxy->priv->expected_interface == NULL)
 518     return NULL;
 519
 520   info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
 521   if (info == NULL)
 522     {
 523       g_warning ("Trying to lookup property %s which isn't in expected interface %s",
 524                  property_name,
 525                  proxy->priv->expected_interface->name);
 526     }
 527
 528   return info;
 529 }
 530
 531 /**
 532  * g_dbus_proxy_get_cached_property:
 533  * @proxy: A #GDBusProxy.
 534  * @property_name: Property name.
 535  *
 536  * Looks up the value for a property from the cache. This call does no
 537  * blocking IO.
 538  *
 539  * If @proxy has an expected interface (see
 540  * #GDBusProxy:g-interface-info), then @property_name (for existence)
 541  * is checked against it.
 542  *
 543  * Returns: A reference to the #GVariant instance that holds the value
 544  * for @property_name or %NULL if the value is not in the cache. The
 545  * returned reference must be freed with g_variant_unref().
 546  *
 547  * Since: 2.26
 548  */
 549 GVariant *
 550 g_dbus_proxy_get_cached_property (GDBusProxy   *proxy,
 551                                   const gchar  *property_name)
 552 {
 553   GVariant *value;
 554
 555   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
 556   g_return_val_if_fail (property_name != NULL, NULL);
 557
 558   value = g_hash_table_lookup (proxy->priv->properties, property_name);
 559   if (value == NULL)
 560     {
 561       const GDBusPropertyInfo *info;
 562       info = lookup_property_info_or_warn (proxy, property_name);
 563       /* no difference */
 564       goto out;
 565     }
 566
 567   g_variant_ref (value);
 568
 569  out:
 570   return value;
 571 }
 572
 573 /**
 574  * g_dbus_proxy_set_cached_property:
 575  * @proxy: A #GDBusProxy
 576  * @property_name: Property name.
 577  * @value: Value for the property or %NULL to remove it from the cache.
 578  *
 579  * If @value is not %NULL, sets the cached value for the property with
 580  * name @property_name to the value in @value.
 581  *
 582  * If @value is %NULL, then the cached value is removed from the
 583  * property cache.
 584  *
 585  * If @proxy has an expected interface (see
 586  * #GDBusProxy:g-interface-info), then @property_name (for existence)
 587  * and @value (for the type) is checked against it.
 588  *
 589  * If the @value #GVariant is floating, it is consumed. This allows
 590  * convenient 'inline' use of g_variant_new(), e.g.
 591  * |[
 592  *  g_dbus_proxy_set_cached_property (proxy,
 593  *                                    "SomeProperty",
 594  *                                    g_variant_new ("(si)",
 595  *                                                  "A String",
 596  *                                                  42));
 597  * ]|
 598  *
 599  * Normally you will not need to use this method since @proxy is
 600  * tracking changes using the
 601  * <literal>org.freedesktop.DBus.Properties.PropertiesChanged</literal>
 602  * D-Bus signal. However, for performance reasons an object may decide
 603  * to not use this signal for some properties and instead use a
 604  * proprietary out-of-band mechanism to transmit changes.
 605  *
 606  * As a concrete example, consider an object with a property
 607  * <literal>ChatroomParticipants</literal> which is an array of
 608  * strings. Instead of transmitting the same (long) array every time
 609  * the property changes, it is more efficient to only transmit the
 610  * delta using e.g. signals <literal>ChatroomParticipantJoined(String
 611  * name)</literal> and <literal>ChatroomParticipantParted(String
 612  * name)</literal>.
 613  *
 614  * Since: 2.26
 615  */
 616 void
 617 g_dbus_proxy_set_cached_property (GDBusProxy   *proxy,
 618                                   const gchar  *property_name,
 619                                   GVariant     *value)
 620 {
 621   const GDBusPropertyInfo *info;
 622
 623   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
 624   g_return_if_fail (property_name != NULL);
 625
 626   if (value != NULL)
 627     {
 628       info = lookup_property_info_or_warn (proxy, property_name);
 629       if (info != NULL)
 630         {
 631           if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
 632             {
 633               g_warning (_("Trying to set property %s of type %s but according to the expected "
 634                            "interface the type is %s"),
 635                          property_name,
 636                          g_variant_get_type_string (value),
 637                          info->signature);
 638               goto out;
 639             }
 640         }
 641       g_hash_table_insert (proxy->priv->properties,
 642                            g_strdup (property_name),
 643                            g_variant_ref_sink (value));
 644     }
 645   else
 646     {
 647       g_hash_table_remove (proxy->priv->properties, property_name);
 648     }
 649
 650  out:
 651   ;
 652 }
 653
 654 /* ---------------------------------------------------------------------------------------------------- */
 655
 656 static void
 657 on_signal_received (GDBusConnection *connection,
 658                     const gchar     *sender_name,
 659                     const gchar     *object_path,
 660                     const gchar     *interface_name,
 661                     const gchar     *signal_name,
 662                     GVariant        *parameters,
 663                     gpointer         user_data)
 664 {
 665   GDBusProxy *proxy = G_DBUS_PROXY (user_data);
 666
 667   if (!proxy->priv->initialized)
 668     goto out;
 669
 670   g_signal_emit (proxy,
 671                  signals[SIGNAL_SIGNAL],
 672                  0,
 673                  sender_name,
 674                  signal_name,
 675                  parameters);
 676  out:
 677   ;
 678 }
 679
 680 /* ---------------------------------------------------------------------------------------------------- */
 681
 682 static void
 683 on_properties_changed (GDBusConnection *connection,
 684                        const gchar     *sender_name,
 685                        const gchar     *object_path,
 686                        const gchar     *interface_name,
 687                        const gchar     *signal_name,
 688                        GVariant        *parameters,
 689                        gpointer         user_data)
 690 {
 691   GDBusProxy *proxy = G_DBUS_PROXY (user_data);
 692   GError *error;
 693   const gchar *interface_name_for_signal;
 694   GVariant *changed_properties;
 695   gchar **invalidated_properties;
 696   GVariantIter iter;
 697   gchar *key;
 698   GVariant *value;
 699   guint n;
 700
 701   error = NULL;
 702   changed_properties = NULL;
 703   invalidated_properties = NULL;
 704
 705   if (!proxy->priv->initialized)
 706     goto out;
 707
 708   if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(sa{sv}as)")))
 709     {
 710       g_warning ("Value for PropertiesChanged signal with type `%s' does not match `(sa{sv}as)'",
 711                  g_variant_get_type_string (parameters));
 712       goto out;
 713     }
 714
 715   g_variant_get (parameters,
 716                  "(&s@a{sv}^a&s)",
 717                  &interface_name_for_signal,
 718                  &changed_properties,
 719                  &invalidated_properties);
 720
 721   if (g_strcmp0 (interface_name_for_signal, proxy->priv->interface_name) != 0)
 722     goto out;
 723
 724   g_variant_iter_init (&iter, changed_properties);
 725   while (g_variant_iter_next (&iter, "{sv}", &key, &value))
 726     {
 727       g_hash_table_insert (proxy->priv->properties,
 728                            key, /* adopts string */
 729                            value); /* adopts value */
 730     }
 731
 732   for (n = 0; invalidated_properties[n] != NULL; n++)
 733     {
 734       g_hash_table_remove (proxy->priv->properties, invalidated_properties[n]);
 735     }
 736
 737   /* emit signal */
 738   g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
 739                  0,
 740                  changed_properties,
 741                  invalidated_properties);
 742
 743  out:
 744   if (changed_properties != NULL)
 745     g_variant_unref (changed_properties);
 746   g_free (invalidated_properties);
 747 }
 748
 749 /* ---------------------------------------------------------------------------------------------------- */
 750
 751 static void
 752 g_dbus_proxy_constructed (GObject *object)
 753 {
 754   if (G_OBJECT_CLASS (g_dbus_proxy_parent_class)->constructed != NULL)
 755     G_OBJECT_CLASS (g_dbus_proxy_parent_class)->constructed (object);
 756 }
 757
 758 /* ---------------------------------------------------------------------------------------------------- */
 759
 760 static void
 761 subscribe_to_signals (GDBusProxy *proxy)
 762 {
 763   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
 764     {
 765       /* subscribe to PropertiesChanged() */
 766       proxy->priv->properties_changed_subscriber_id =
 767         g_dbus_connection_signal_subscribe (proxy->priv->connection,
 768                                             proxy->priv->unique_bus_name,
 769                                             "org.freedesktop.DBus.Properties",
 770                                             "PropertiesChanged",
 771                                             proxy->priv->object_path,
 772                                             proxy->priv->interface_name,
 773                                             on_properties_changed,
 774                                             proxy,
 775                                             NULL);
 776     }
 777
 778   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS))
 779     {
 780       /* subscribe to all signals for the object */
 781       proxy->priv->signals_subscriber_id =
 782         g_dbus_connection_signal_subscribe (proxy->priv->connection,
 783                                             proxy->priv->unique_bus_name,
 784                                             proxy->priv->interface_name,
 785                                             NULL,                        /* member */
 786                                             proxy->priv->object_path,
 787                                             NULL,                        /* arg0 */
 788                                             on_signal_received,
 789                                             proxy,
 790                                             NULL);
 791     }
 792 }
 793
 794 /* ---------------------------------------------------------------------------------------------------- */
 795
 796 static void
 797 process_get_all_reply (GDBusProxy *proxy,
 798                        GVariant   *result)
 799 {
 800   GVariantIter *iter;
 801   gchar *key;
 802   GVariant *value;
 803
 804   if (strcmp (g_variant_get_type_string (result), "(a{sv})") != 0)
 805     {
 806       g_warning ("Value for GetAll reply with type `%s' does not match `(a{sv})'",
 807                  g_variant_get_type_string (result));
 808       goto out;
 809     }
 810
 811   g_variant_get (result, "(a{sv})", &iter);
 812   while (g_variant_iter_next (iter, "{sv}", &key, &value))
 813     {
 814       //g_print ("got %s -> %s\n", key, g_variant_markup_print (value, FALSE, 0, 0));
 815
 816       g_hash_table_insert (proxy->priv->properties,
 817                            key, /* adopts string */
 818                            value); /* adopts value */
 819     }
 820   g_variant_iter_free (iter);
 821
 822  out:
 823   ;
 824 }
 825
 826 static gboolean
 827 initable_init (GInitable     *initable,
 828                GCancellable  *cancellable,
 829                GError       **error)
 830 {
 831   GDBusProxy *proxy = G_DBUS_PROXY (initable);
 832   GVariant *result;
 833   gboolean ret;
 834
 835   ret = FALSE;
 836
 837   subscribe_to_signals (proxy);
 838
 839   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
 840     {
 841       /* load all properties synchronously */
 842       result = g_dbus_connection_call_sync (proxy->priv->connection,
 843                                             proxy->priv->unique_bus_name,
 844                                             proxy->priv->object_path,
 845                                             "org.freedesktop.DBus.Properties",
 846                                             "GetAll",
 847                                             g_variant_new ("(s)", proxy->priv->interface_name),
 848                                             G_VARIANT_TYPE ("(a{sv})"),
 849                                             G_DBUS_CALL_FLAGS_NONE,
 850                                             -1,           /* timeout */
 851                                             cancellable,
 852                                             error);
 853       if (result == NULL)
 854         {
 855           /* We just ignore if GetAll() is failing. Because this might happen
 856            * if the object has no properties at all. Or if the caller is
 857            * not authorized to see the properties.
 858            *
 859            * Either way, apps can know about this by using
 860            * get_cached_property_names() or get_cached_property().
 861            *
 862            * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
 863            * fact that GetAll() failed
 864            */
 865           //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
 866           if (error != NULL)
 867             {
 868               g_error_free (*error);
 869               *error = NULL;
 870             }
 871           ret = TRUE;
 872           goto out;
 873         }
 874
 875       process_get_all_reply (proxy, result);
 876
 877       g_variant_unref (result);
 878     }
 879
 880   ret = TRUE;
 881
 882  out:
 883   proxy->priv->initialized = TRUE;
 884   return ret;
 885 }
 886
 887 static void
 888 initable_iface_init (GInitableIface *initable_iface)
 889 {
 890   initable_iface->init = initable_init;
 891 }
 892
 893 /* ---------------------------------------------------------------------------------------------------- */
 894
 895 static void
 896 get_all_cb (GDBusConnection *connection,
 897             GAsyncResult    *res,
 898             gpointer         user_data)
 899 {
 900   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
 901   GVariant *result;
 902   GError *error;
 903
 904   error = NULL;
 905   result = g_dbus_connection_call_finish (connection,
 906                                           res,
 907                                           &error);
 908   if (result == NULL)
 909     {
 910       /* We just ignore if GetAll() is failing. Because this might happen
 911        * if the object has no properties at all. Or if the caller is
 912        * not authorized to see the properties.
 913        *
 914        * Either way, apps can know about this by using
 915        * get_cached_property_names() or get_cached_property().
 916        *
 917        * TODO: handle G_DBUS_DEBUG flag 'proxy' and, if enabled, log the
 918        * fact that GetAll() failed
 919        */
 920       //g_debug ("error: %d %d %s", error->domain, error->code, error->message);
 921       g_error_free (error);
 922     }
 923   else
 924     {
 925       g_simple_async_result_set_op_res_gpointer (simple,
 926                                                  result,
 927                                                  (GDestroyNotify) g_variant_unref);
 928     }
 929
 930   g_simple_async_result_complete_in_idle (simple);
 931   g_object_unref (simple);
 932 }
 933
 934 static void
 935 async_initable_init_async (GAsyncInitable      *initable,
 936                            gint                 io_priority,
 937                            GCancellable        *cancellable,
 938                            GAsyncReadyCallback  callback,
 939                            gpointer             user_data)
 940 {
 941   GDBusProxy *proxy = G_DBUS_PROXY (initable);
 942   GSimpleAsyncResult *simple;
 943
 944   simple = g_simple_async_result_new (G_OBJECT (proxy),
 945                                       callback,
 946                                       user_data,
 947                                       NULL);
 948
 949   subscribe_to_signals (proxy);
 950
 951   if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
 952     {
 953       /* load all properties asynchronously */
 954       g_dbus_connection_call (proxy->priv->connection,
 955                               proxy->priv->unique_bus_name,
 956                               proxy->priv->object_path,
 957                               "org.freedesktop.DBus.Properties",
 958                               "GetAll",
 959                               g_variant_new ("(s)", proxy->priv->interface_name),
 960                               G_VARIANT_TYPE ("(a{sv})"),
 961                               G_DBUS_CALL_FLAGS_NONE,
 962                               -1,           /* timeout */
 963                               cancellable,
 964                               (GAsyncReadyCallback) get_all_cb,
 965                               simple);
 966     }
 967   else
 968     {
 969       g_simple_async_result_complete_in_idle (simple);
 970       g_object_unref (simple);
 971     }
 972 }
 973
 974 static gboolean
 975 async_initable_init_finish (GAsyncInitable  *initable,
 976                             GAsyncResult    *res,
 977                             GError         **error)
 978 {
 979   GDBusProxy *proxy = G_DBUS_PROXY (initable);
 980   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
 981   GVariant *result;
 982   gboolean ret;
 983
 984   ret = FALSE;
 985
 986   if (g_simple_async_result_propagate_error (simple, error))
 987     goto out;
 988
 989   result = g_simple_async_result_get_op_res_gpointer (simple);
 990   if (result != NULL)
 991     {
 992       process_get_all_reply (proxy, result);
 993     }
 994
 995   ret = TRUE;
 996
 997  out:
 998   proxy->priv->initialized = TRUE;
 999   return ret;
1000 }
1001
1002 static void
1003 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
1004 {
1005   async_initable_iface->init_async = async_initable_init_async;
1006   async_initable_iface->init_finish = async_initable_init_finish;
1007 }
1008
1009 /* ---------------------------------------------------------------------------------------------------- */
1010
1011 /**
1012  * g_dbus_proxy_new:
1013  * @connection: A #GDBusConnection.
1014  * @object_type: Either #G_TYPE_DBUS_PROXY or the #GType for the #GDBusProxy<!-- -->-derived type of proxy to create.
1015  * @flags: Flags used when constructing the proxy.
1016  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1017  * @unique_bus_name: A unique bus name or %NULL if @connection is not a message bus connection.
1018  * @object_path: An object path.
1019  * @interface_name: A D-Bus interface name.
1020  * @cancellable: A #GCancellable or %NULL.
1021  * @callback: Callback function to invoke when the proxy is ready.
1022  * @user_data: User data to pass to @callback.
1023  *
1024  * Creates a proxy for accessing @interface_name on the remote object at @object_path
1025  * owned by @unique_bus_name at @connection and asynchronously loads D-Bus properties unless the
1026  * #G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to the
1027  * #GDBusProxy::g-properties-changed signal to get notified about property changes.
1028  *
1029  * If the #G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1030  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1031  * to handle signals from the remote object.
1032  *
1033  * This is a failable asynchronous constructor - when the proxy is
1034  * ready, @callback will be invoked and you can use
1035  * g_dbus_proxy_new_finish() to get the result.
1036  *
1037  * See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
1038  *
1039  * Since: 2.26
1040  */
1041 void
1042 g_dbus_proxy_new (GDBusConnection     *connection,
1043                   GType                object_type,
1044                   GDBusProxyFlags      flags,
1045                   GDBusInterfaceInfo  *info,
1046                   const gchar         *unique_bus_name,
1047                   const gchar         *object_path,
1048                   const gchar         *interface_name,
1049                   GCancellable        *cancellable,
1050                   GAsyncReadyCallback  callback,
1051                   gpointer             user_data)
1052 {
1053   g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1054   g_return_if_fail (g_type_is_a (object_type, G_TYPE_DBUS_PROXY));
1055   g_return_if_fail ((unique_bus_name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
1056                     g_dbus_is_unique_name (unique_bus_name));
1057   g_return_if_fail (g_variant_is_object_path (object_path));
1058   g_return_if_fail (g_dbus_is_interface_name (interface_name));
1059
1060   g_async_initable_new_async (object_type,
1061                               G_PRIORITY_DEFAULT,
1062                               cancellable,
1063                               callback,
1064                               user_data,
1065                               "g-flags", flags,
1066                               "g-interface-info", info,
1067                               "g-unique-bus-name", unique_bus_name,
1068                               "g-connection", connection,
1069                               "g-object-path", object_path,
1070                               "g-interface-name", interface_name,
1071                               NULL);
1072 }
1073
1074 /**
1075  * g_dbus_proxy_new_finish:
1076  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new().
1077  * @error: Return location for error or %NULL.
1078  *
1079  * Finishes creating a #GDBusProxy.
1080  *
1081  * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
1082  *
1083  * Since: 2.26
1084  */
1085 GDBusProxy *
1086 g_dbus_proxy_new_finish (GAsyncResult  *res,
1087                          GError       **error)
1088 {
1089   GObject *object;
1090   GObject *source_object;
1091
1092   source_object = g_async_result_get_source_object (res);
1093   g_assert (source_object != NULL);
1094
1095   object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
1096                                         res,
1097                                         error);
1098   g_object_unref (source_object);
1099
1100   if (object != NULL)
1101     return G_DBUS_PROXY (object);
1102   else
1103     return NULL;
1104 }
1105
1106
1107 /* ---------------------------------------------------------------------------------------------------- */
1108
1109 /**
1110  * g_dbus_proxy_new_sync:
1111  * @connection: A #GDBusConnection.
1112  * @object_type: Either #G_TYPE_DBUS_PROXY or the #GType for the #GDBusProxy<!-- -->-derived type of proxy to create.
1113  * @flags: Flags used when constructing the proxy.
1114  * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1115  * @unique_bus_name: A unique bus name or %NULL if @connection is not a message bus connection.
1116  * @object_path: An object path.
1117  * @interface_name: A D-Bus interface name.
1118  * @cancellable: A #GCancellable or %NULL.
1119  * @error: Return location for error or %NULL.
1120  *
1121  * Creates a proxy for accessing @interface_name on the remote object at @object_path
1122  * owned by @unique_bus_name at @connection and synchronously loads D-Bus properties unless the
1123  * #G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
1124  *
1125  * If the #G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1126  * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1127  * to handle signals from the remote object.
1128  *
1129  * This is a synchronous failable constructor. See g_dbus_proxy_new()
1130  * and g_dbus_proxy_new_finish() for the asynchronous version.
1131  *
1132  * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
1133  *
1134  * Since: 2.26
1135  */
1136 GDBusProxy *
1137 g_dbus_proxy_new_sync (GDBusConnection     *connection,
1138                        GType                object_type,
1139                        GDBusProxyFlags      flags,
1140                        GDBusInterfaceInfo  *info,
1141                        const gchar         *unique_bus_name,
1142                        const gchar         *object_path,
1143                        const gchar         *interface_name,
1144                        GCancellable        *cancellable,
1145                        GError             **error)
1146 {
1147   GInitable *initable;
1148
1149   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1150   g_return_val_if_fail (g_type_is_a (object_type, G_TYPE_DBUS_PROXY), NULL);
1151   g_return_val_if_fail ((unique_bus_name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
1152                         g_dbus_is_unique_name (unique_bus_name), NULL);
1153   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1154   g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
1155
1156   initable = g_initable_new (object_type,
1157                              cancellable,
1158                              error,
1159                              "g-flags", flags,
1160                              "g-interface-info", info,
1161                              "g-unique-bus-name", unique_bus_name,
1162                              "g-connection", connection,
1163                              "g-object-path", object_path,
1164                              "g-interface-name", interface_name,
1165                              NULL);
1166   if (initable != NULL)
1167     return G_DBUS_PROXY (initable);
1168   else
1169     return NULL;
1170 }
1171
1172 /* ---------------------------------------------------------------------------------------------------- */
1173
1174 /**
1175  * g_dbus_proxy_get_connection:
1176  * @proxy: A #GDBusProxy.
1177  *
1178  * Gets the connection @proxy is for.
1179  *
1180  * Returns: A #GDBusConnection owned by @proxy. Do not free.
1181  *
1182  * Since: 2.26
1183  */
1184 GDBusConnection *
1185 g_dbus_proxy_get_connection (GDBusProxy *proxy)
1186 {
1187   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1188   return proxy->priv->connection;
1189 }
1190
1191 /**
1192  * g_dbus_proxy_get_flags:
1193  * @proxy: A #GDBusProxy.
1194  *
1195  * Gets the flags that @proxy was constructed with.
1196  *
1197  * Returns: Flags from the #GDBusProxyFlags enumeration.
1198  *
1199  * Since: 2.26
1200  */
1201 GDBusProxyFlags
1202 g_dbus_proxy_get_flags (GDBusProxy *proxy)
1203 {
1204   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), 0);
1205   return proxy->priv->flags;
1206 }
1207
1208 /**
1209  * g_dbus_proxy_get_unique_bus_name:
1210  * @proxy: A #GDBusProxy.
1211  *
1212  * Gets the unique bus name @proxy is for.
1213  *
1214  * Returns: A string owned by @proxy. Do not free.
1215  *
1216  * Since: 2.26
1217  */
1218 const gchar *
1219 g_dbus_proxy_get_unique_bus_name (GDBusProxy *proxy)
1220 {
1221   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1222   return proxy->priv->unique_bus_name;
1223 }
1224
1225 /**
1226  * g_dbus_proxy_get_object_path:
1227  * @proxy: A #GDBusProxy.
1228  *
1229  * Gets the object path @proxy is for.
1230  *
1231  * Returns: A string owned by @proxy. Do not free.
1232  *
1233  * Since: 2.26
1234  */
1235 const gchar *
1236 g_dbus_proxy_get_object_path (GDBusProxy *proxy)
1237 {
1238   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1239   return proxy->priv->object_path;
1240 }
1241
1242 /**
1243  * g_dbus_proxy_get_interface_name:
1244  * @proxy: A #GDBusProxy.
1245  *
1246  * Gets the D-Bus interface name @proxy is for.
1247  *
1248  * Returns: A string owned by @proxy. Do not free.
1249  *
1250  * Since: 2.26
1251  */
1252 const gchar *
1253 g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
1254 {
1255   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1256   return proxy->priv->interface_name;
1257 }
1258
1259 /**
1260  * g_dbus_proxy_get_default_timeout:
1261  * @proxy: A #GDBusProxy.
1262  *
1263  * Gets the timeout to use if -1 (specifying default timeout) is
1264  * passed as @timeout_msec in the g_dbus_proxy_call() and
1265  * g_dbus_proxy_call_sync() functions.
1266  *
1267  * See the #GDBusProxy:g-default-timeout property for more details.
1268  *
1269  * Returns: Timeout to use for @proxy.
1270  *
1271  * Since: 2.26
1272  */
1273 gint
1274 g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
1275 {
1276   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), -1);
1277   return proxy->priv->timeout_msec;
1278 }
1279
1280 /**
1281  * g_dbus_proxy_set_default_timeout:
1282  * @proxy: A #GDBusProxy.
1283  * @timeout_msec: Timeout in milliseconds.
1284  *
1285  * Sets the timeout to use if -1 (specifying default timeout) is
1286  * passed as @timeout_msec in the g_dbus_proxy_call() and
1287  * g_dbus_proxy_call_sync() functions.
1288  *
1289  * See the #GDBusProxy:g-default-timeout property for more details.
1290  *
1291  * Since: 2.26
1292  */
1293 void
1294 g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
1295                                   gint        timeout_msec)
1296 {
1297   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
1298   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
1299
1300   /* TODO: locking? */
1301   if (proxy->priv->timeout_msec != timeout_msec)
1302     {
1303       proxy->priv->timeout_msec = timeout_msec;
1304       g_object_notify (G_OBJECT (proxy), "g-default-timeout");
1305     }
1306 }
1307
1308 /**
1309  * g_dbus_proxy_get_interface_info:
1310  * @proxy: A #GDBusProxy
1311  *
1312  * Returns the #GDBusInterfaceInfo, if any, specifying the minimal
1313  * interface that @proxy conforms to.
1314  *
1315  * See the #GDBusProxy:g-interface-info property for more details.
1316  *
1317  * Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
1318  * object, it is owned by @proxy.
1319  *
1320  * Since: 2.26
1321  */
1322 GDBusInterfaceInfo *
1323 g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
1324 {
1325   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1326   return proxy->priv->expected_interface;
1327 }
1328
1329 /**
1330  * g_dbus_proxy_set_interface_info:
1331  * @proxy: A #GDBusProxy
1332  * @info: Minimum interface this proxy conforms to or %NULL to unset.
1333  *
1334  * Ensure that interactions with @proxy conform to the given
1335  * interface.  For example, when completing a method call, if the type
1336  * signature of the message isn't what's expected, the given #GError
1337  * is set.  Signals that have a type signature mismatch are simply
1338  * dropped.
1339  *
1340  * See the #GDBusProxy:g-interface-info property for more details.
1341  *
1342  * Since: 2.26
1343  */
1344 void
1345 g_dbus_proxy_set_interface_info (GDBusProxy         *proxy,
1346                                  GDBusInterfaceInfo *info)
1347 {
1348   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
1349   if (proxy->priv->expected_interface != NULL)
1350     g_dbus_interface_info_unref (proxy->priv->expected_interface);
1351   proxy->priv->expected_interface = info != NULL ? g_dbus_interface_info_ref (info) : NULL;
1352 }
1353
1354 /* ---------------------------------------------------------------------------------------------------- */
1355
1356 static gboolean
1357 maybe_split_method_name (const gchar  *method_name,
1358                          gchar       **out_interface_name,
1359                          const gchar **out_method_name)
1360 {
1361   gboolean was_split;
1362
1363   was_split = FALSE;
1364   g_assert (out_interface_name != NULL);
1365   g_assert (out_method_name != NULL);
1366   *out_interface_name = NULL;
1367   *out_method_name = NULL;
1368
1369   if (strchr (method_name, '.') != NULL)
1370     {
1371       gchar *p;
1372       gchar *last_dot;
1373
1374       p = g_strdup (method_name);
1375       last_dot = strrchr (p, '.');
1376       *last_dot = '\0';
1377
1378       *out_interface_name = p;
1379       *out_method_name = last_dot + 1;
1380
1381       was_split = TRUE;
1382     }
1383
1384   return was_split;
1385 }
1386
1387
1388 static void
1389 reply_cb (GDBusConnection *connection,
1390           GAsyncResult    *res,
1391           gpointer         user_data)
1392 {
1393   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
1394   GVariant *value;
1395   GError *error;
1396
1397   error = NULL;
1398   value = g_dbus_connection_call_finish (connection,
1399                                          res,
1400                                          &error);
1401   if (error != NULL)
1402     {
1403       g_simple_async_result_set_from_error (simple,
1404                                             error);
1405       g_error_free (error);
1406     }
1407   else
1408     {
1409       g_simple_async_result_set_op_res_gpointer (simple,
1410                                                  value,
1411                                                  (GDestroyNotify) g_variant_unref);
1412     }
1413
1414   /* no need to complete in idle since the method GDBusConnection already does */
1415   g_simple_async_result_complete (simple);
1416 }
1417
1418 static const GDBusMethodInfo *
1419 lookup_method_info_or_warn (GDBusProxy  *proxy,
1420                             const gchar *method_name)
1421 {
1422   const GDBusMethodInfo *info;
1423
1424   if (proxy->priv->expected_interface == NULL)
1425     return NULL;
1426
1427   info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, method_name);
1428   if (info == NULL)
1429     {
1430       g_warning ("Trying to invoke method %s which isn't in expected interface %s",
1431                  method_name, proxy->priv->expected_interface->name);
1432     }
1433
1434   return info;
1435 }
1436
1437 /**
1438  * g_dbus_proxy_call:
1439  * @proxy: A #GDBusProxy.
1440  * @method_name: Name of method to invoke.
1441  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
1442  * @flags: Flags from the #GDBusCallFlags enumeration.
1443  * @timeout_msec: The timeout in milliseconds or -1 to use the proxy default timeout.
1444  * @cancellable: A #GCancellable or %NULL.
1445  * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
1446  * care about the result of the method invocation.
1447  * @user_data: The data to pass to @callback.
1448  *
1449  * Asynchronously invokes the @method_name method on @proxy.
1450  *
1451  * If @method_name contains any dots, then @name is split into interface and
1452  * method name parts. This allows using @proxy for invoking methods on
1453  * other interfaces.
1454  *
1455  * If the #GDBusConnection associated with @proxy is closed then
1456  * the operation will fail with %G_IO_ERROR_CLOSED. If
1457  * @cancellable is canceled, the operation will fail with
1458  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
1459  * compatible with the D-Bus protocol, the operation fails with
1460  * %G_IO_ERROR_INVALID_ARGUMENT.
1461  *
1462  * If the @parameters #GVariant is floating, it is consumed. This allows
1463  * convenient 'inline' use of g_variant_new(), e.g.:
1464  * |[
1465  *  g_dbus_proxy_call (proxy,
1466  *                     "TwoStrings",
1467  *                     g_variant_new ("(ss)",
1468  *                                    "Thing One",
1469  *                                    "Thing Two"),
1470  *                     G_DBUS_CALL_FLAGS_NONE,
1471  *                     -1,
1472  *                     NULL,
1473  *                     (GAsyncReadyCallback) two_strings_done,
1474  *                     &amp;data);
1475  * ]|
1476  *
1477  * This is an asynchronous method. When the operation is finished,
1478  * @callback will be invoked in the
1479  * <link linkend="g-main-context-push-thread-default">thread-default
1480  * main loop</link> of the thread you are calling this method from.
1481  * You can then call g_dbus_proxy_call_finish() to get the result of
1482  * the operation. See g_dbus_proxy_call_sync() for the synchronous
1483  * version of this method.
1484  *
1485  * Since: 2.26
1486  */
1487 void
1488 g_dbus_proxy_call (GDBusProxy          *proxy,
1489                    const gchar         *method_name,
1490                    GVariant            *parameters,
1491                    GDBusCallFlags       flags,
1492                    gint                 timeout_msec,
1493                    GCancellable        *cancellable,
1494                    GAsyncReadyCallback  callback,
1495                    gpointer             user_data)
1496 {
1497   GSimpleAsyncResult *simple;
1498   gboolean was_split;
1499   gchar *split_interface_name;
1500   const gchar *split_method_name;
1501   const GDBusMethodInfo *expected_method_info;
1502   const gchar *target_method_name;
1503   const gchar *target_interface_name;
1504   GVariantType *reply_type;
1505
1506   g_return_if_fail (G_IS_DBUS_PROXY (proxy));
1507   g_return_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name));
1508   g_return_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
1509   g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
1510
1511   simple = g_simple_async_result_new (G_OBJECT (proxy),
1512                                       callback,
1513                                       user_data,
1514                                       g_dbus_proxy_call);
1515
1516   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
1517   target_method_name = was_split ? split_method_name : method_name;
1518   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
1519
1520   g_object_set_data_full (G_OBJECT (simple), "-gdbus-proxy-method-name", g_strdup (target_method_name), g_free);
1521
1522   /* Just warn here */
1523   expected_method_info = lookup_method_info_or_warn (proxy, target_method_name);
1524
1525   if (expected_method_info)
1526     reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
1527   else
1528     reply_type = NULL;
1529
1530   g_dbus_connection_call (proxy->priv->connection,
1531                           proxy->priv->unique_bus_name,
1532                           proxy->priv->object_path,
1533                           target_interface_name,
1534                           target_method_name,
1535                           parameters,
1536                           reply_type,
1537                           flags,
1538                           timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
1539                           cancellable,
1540                           (GAsyncReadyCallback) reply_cb,
1541                           simple);
1542
1543   if (reply_type != NULL)
1544     g_variant_type_free (reply_type);
1545
1546   g_free (split_interface_name);
1547 }
1548
1549 /**
1550  * g_dbus_proxy_call_finish:
1551  * @proxy: A #GDBusProxy.
1552  * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().
1553  * @error: Return location for error or %NULL.
1554  *
1555  * Finishes an operation started with g_dbus_proxy_call().
1556  *
1557  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
1558  * return values. Free with g_variant_unref().
1559  *
1560  * Since: 2.26
1561  */
1562 GVariant *
1563 g_dbus_proxy_call_finish (GDBusProxy    *proxy,
1564                           GAsyncResult  *res,
1565                           GError       **error)
1566 {
1567   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1568   GVariant *value;
1569   const char *method_name;
1570
1571   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1572   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1573   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1574
1575   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_proxy_call);
1576
1577   value = NULL;
1578
1579   if (g_simple_async_result_propagate_error (simple, error))
1580     goto out;
1581
1582   value = g_simple_async_result_get_op_res_gpointer (simple);
1583   method_name = g_object_get_data (G_OBJECT (simple), "-gdbus-proxy-method-name");
1584
1585  out:
1586   return value;
1587 }
1588
1589 /**
1590  * g_dbus_proxy_call_sync:
1591  * @proxy: A #GDBusProxy.
1592  * @method_name: Name of method to invoke.
1593  * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
1594  * @flags: Flags from the #GDBusCallFlags enumeration.
1595  * @timeout_msec: The timeout in milliseconds or -1 to use the proxy default timeout.
1596  * @cancellable: A #GCancellable or %NULL.
1597  * @error: Return location for error or %NULL.
1598  *
1599  * Synchronously invokes the @method_name method on @proxy.
1600  *
1601  * If @method_name contains any dots, then @name is split into interface and
1602  * method name parts. This allows using @proxy for invoking methods on
1603  * other interfaces.
1604  *
1605  * If the #GDBusConnection associated with @proxy is disconnected then
1606  * the operation will fail with %G_IO_ERROR_CLOSED. If
1607  * @cancellable is canceled, the operation will fail with
1608  * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
1609  * compatible with the D-Bus protocol, the operation fails with
1610  * %G_IO_ERROR_INVALID_ARGUMENT.
1611  *
1612  * If the @parameters #GVariant is floating, it is consumed. This allows
1613  * convenient 'inline' use of g_variant_new(), e.g.:
1614  * |[
1615  *  g_dbus_proxy_call_sync (proxy,
1616  *                          "TwoStrings",
1617  *                          g_variant_new ("(ss)",
1618  *                                         "Thing One",
1619  *                                         "Thing Two"),
1620  *                          G_DBUS_CALL_FLAGS_NONE,
1621  *                          -1,
1622  *                          NULL,
1623  *                          &amp;error);
1624  * ]|
1625  *
1626  * The calling thread is blocked until a reply is received. See
1627  * g_dbus_proxy_call() for the asynchronous version of this
1628  * method.
1629  *
1630  * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
1631  * return values. Free with g_variant_unref().
1632  *
1633  * Since: 2.26
1634  */
1635 GVariant *
1636 g_dbus_proxy_call_sync (GDBusProxy      *proxy,
1637                         const gchar     *method_name,
1638                         GVariant        *parameters,
1639                         GDBusCallFlags   flags,
1640                         gint             timeout_msec,
1641                         GCancellable    *cancellable,
1642                         GError         **error)
1643 {
1644   GVariant *ret;
1645   gboolean was_split;
1646   gchar *split_interface_name;
1647   const gchar *split_method_name;
1648   const GDBusMethodInfo *expected_method_info;
1649   const gchar *target_method_name;
1650   const gchar *target_interface_name;
1651   GVariantType *reply_type;
1652
1653   g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1654   g_return_val_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name), NULL);
1655   g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
1656   g_return_val_if_fail (timeout_msec == -1 || timeout_msec >= 0, NULL);
1657   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1658
1659   was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
1660   target_method_name = was_split ? split_method_name : method_name;
1661   target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
1662
1663   if (proxy->priv->expected_interface)
1664     {
1665       expected_method_info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, target_method_name);
1666       if (expected_method_info == NULL)
1667         {
1668           g_warning ("Trying to invoke method `%s' which isn't in expected interface `%s'",
1669                      target_method_name,
1670                      target_interface_name);
1671         }
1672     }
1673   else
1674     {
1675       expected_method_info = NULL;
1676     }
1677
1678   if (expected_method_info)
1679     reply_type = _g_dbus_compute_complete_signature (expected_method_info->out_args);
1680   else
1681     reply_type = NULL;
1682
1683   ret = g_dbus_connection_call_sync (proxy->priv->connection,
1684                                      proxy->priv->unique_bus_name,
1685                                      proxy->priv->object_path,
1686                                      target_interface_name,
1687                                      target_method_name,
1688                                      parameters,
1689                                      reply_type,
1690                                      flags,
1691                                      timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
1692                                      cancellable,
1693                                      error);
1694
1695   if (reply_type != NULL)
1696     g_variant_type_free (reply_type);
1697
1698   g_free (split_interface_name);
1699
1700   return ret;
1701 }
1702
1703 /* ---------------------------------------------------------------------------------------------------- */
1704
1705 #define __G_DBUS_PROXY_C__
1706 #include "gioaliasdef.c"