1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
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.
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.
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.
20 * Author: David Zeuthen <davidz@redhat.com>
28 #include <gobject/gvaluecollector.h>
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"
40 #include "gasyncresult.h"
41 #include "gsimpleasyncresult.h"
48 * @short_description: Base class for proxies
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.
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.
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.
69 * See <xref linkend="gdbus-example-proxy-subclass"/> for an example.
72 struct _GDBusProxyPrivate
74 GDBusConnection *connection;
75 GDBusProxyFlags flags;
76 gchar *unique_bus_name;
78 gchar *interface_name;
81 /* gchar* -> GVariant* */
82 GHashTable *properties;
84 GDBusInterfaceInfo *expected_interface;
86 guint properties_changed_subscriber_id;
87 guint signals_subscriber_id;
96 PROP_G_UNIQUE_BUS_NAME,
99 PROP_G_INTERFACE_NAME,
100 PROP_G_DEFAULT_TIMEOUT,
101 PROP_G_INTERFACE_INFO
106 PROPERTIES_CHANGED_SIGNAL,
111 static void g_dbus_proxy_constructed (GObject *object);
113 guint signals[LAST_SIGNAL] = {0};
115 static void initable_iface_init (GInitableIface *initable_iface);
116 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
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)
124 g_dbus_proxy_finalize (GObject *object)
126 GDBusProxy *proxy = G_DBUS_PROXY (object);
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);
132 if (proxy->priv->signals_subscriber_id > 0)
133 g_dbus_connection_signal_unsubscribe (proxy->priv->connection,
134 proxy->priv->signals_subscriber_id);
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);
143 if (proxy->priv->expected_interface != NULL)
144 g_dbus_interface_info_unref (proxy->priv->expected_interface);
146 G_OBJECT_CLASS (g_dbus_proxy_parent_class)->finalize (object);
150 g_dbus_proxy_get_property (GObject *object,
155 GDBusProxy *proxy = G_DBUS_PROXY (object);
159 case PROP_G_CONNECTION:
160 g_value_set_object (value, proxy->priv->connection);
164 g_value_set_flags (value, proxy->priv->flags);
167 case PROP_G_UNIQUE_BUS_NAME:
168 g_value_set_string (value, proxy->priv->unique_bus_name);
171 case PROP_G_OBJECT_PATH:
172 g_value_set_string (value, proxy->priv->object_path);
175 case PROP_G_INTERFACE_NAME:
176 g_value_set_string (value, proxy->priv->interface_name);
179 case PROP_G_DEFAULT_TIMEOUT:
180 g_value_set_int (value, proxy->priv->timeout_msec);
183 case PROP_G_INTERFACE_INFO:
184 g_value_set_boxed (value, g_dbus_proxy_get_interface_info (proxy));
188 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
194 g_dbus_proxy_set_property (GObject *object,
199 GDBusProxy *proxy = G_DBUS_PROXY (object);
203 case PROP_G_CONNECTION:
204 proxy->priv->connection = g_value_dup_object (value);
208 proxy->priv->flags = g_value_get_flags (value);
211 case PROP_G_UNIQUE_BUS_NAME:
212 proxy->priv->unique_bus_name = g_value_dup_string (value);
215 case PROP_G_OBJECT_PATH:
216 proxy->priv->object_path = g_value_dup_string (value);
219 case PROP_G_INTERFACE_NAME:
220 proxy->priv->interface_name = g_value_dup_string (value);
223 case PROP_G_DEFAULT_TIMEOUT:
224 g_dbus_proxy_set_default_timeout (proxy, g_value_get_int (value));
227 case PROP_G_INTERFACE_INFO:
228 g_dbus_proxy_set_interface_info (proxy, g_value_get_boxed (value));
232 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
238 g_dbus_proxy_class_init (GDBusProxyClass *klass)
240 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
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;
247 /* Note that all property names are prefixed to avoid collisions with D-Bus property names
248 * in derived classes */
251 * GDBusProxy:g-interface-info:
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
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,
269 G_PARAM_STATIC_NAME |
270 G_PARAM_STATIC_BLURB |
271 G_PARAM_STATIC_NICK));
274 * GDBusProxy:g-connection:
276 * The #GDBusConnection the proxy is for.
280 g_object_class_install_property (gobject_class,
282 g_param_spec_object ("g-connection",
284 P_("The connection the proxy is for"),
285 G_TYPE_DBUS_CONNECTION,
288 G_PARAM_CONSTRUCT_ONLY |
289 G_PARAM_STATIC_NAME |
290 G_PARAM_STATIC_BLURB |
291 G_PARAM_STATIC_NICK));
294 * GDBusProxy:g-flags:
296 * Flags from the #GDBusProxyFlags enumeration.
300 g_object_class_install_property (gobject_class,
302 g_param_spec_flags ("g-flags",
304 P_("Flags for the proxy"),
305 G_TYPE_DBUS_PROXY_FLAGS,
306 G_DBUS_PROXY_FLAGS_NONE,
309 G_PARAM_CONSTRUCT_ONLY |
310 G_PARAM_STATIC_NAME |
311 G_PARAM_STATIC_BLURB |
312 G_PARAM_STATIC_NICK));
315 * GDBusProxy:g-unique-bus-name:
317 * The unique bus name the proxy is for.
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"),
329 G_PARAM_CONSTRUCT_ONLY |
330 G_PARAM_STATIC_NAME |
331 G_PARAM_STATIC_BLURB |
332 G_PARAM_STATIC_NICK));
335 * GDBusProxy:g-object-path:
337 * The object path the proxy is for.
341 g_object_class_install_property (gobject_class,
343 g_param_spec_string ("g-object-path",
345 P_("The object path the proxy is for"),
349 G_PARAM_CONSTRUCT_ONLY |
350 G_PARAM_STATIC_NAME |
351 G_PARAM_STATIC_BLURB |
352 G_PARAM_STATIC_NICK));
355 * GDBusProxy:g-interface-name:
357 * The D-Bus interface name the proxy is for.
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"),
369 G_PARAM_CONSTRUCT_ONLY |
370 G_PARAM_STATIC_NAME |
371 G_PARAM_STATIC_BLURB |
372 G_PARAM_STATIC_NICK));
375 * GDBusProxy:g-default-timeout:
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.
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.
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"),
399 G_PARAM_STATIC_NAME |
400 G_PARAM_STATIC_BLURB |
401 G_PARAM_STATIC_NICK));
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
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).
414 * This signal corresponds to the
415 * <literal>PropertiesChanged</literal> D-Bus signal on the
416 * <literal>org.freedesktop.DBus.Properties</literal> interface.
420 signals[PROPERTIES_CHANGED_SIGNAL] = g_signal_new ("g-properties-changed",
423 G_STRUCT_OFFSET (GDBusProxyClass, g_properties_changed),
426 _gio_marshal_VOID__BOXED_BOXED,
430 G_TYPE_STRV | G_SIGNAL_TYPE_STATIC_SCOPE);
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.
439 * Emitted when a signal from the remote object and interface that @proxy is for, has been received.
443 signals[SIGNAL_SIGNAL] = g_signal_new ("g-signal",
446 G_STRUCT_OFFSET (GDBusProxyClass, g_signal),
449 _gio_marshal_VOID__STRING_STRING_BOXED,
457 g_type_class_add_private (klass, sizeof (GDBusProxyPrivate));
461 g_dbus_proxy_init (GDBusProxy *proxy)
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,
467 (GDestroyNotify) g_variant_unref);
470 /* ---------------------------------------------------------------------------------------------------- */
473 * g_dbus_proxy_get_cached_property_names:
474 * @proxy: A #GDBusProxy.
476 * Gets the names of all cached properties on @proxy.
478 * Returns: A %NULL-terminated array of strings or %NULL if @proxy has
479 * no cached properties. Free the returned array with g_strfreev().
484 g_dbus_proxy_get_cached_property_names (GDBusProxy *proxy)
491 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
494 if (g_hash_table_size (proxy->priv->properties) == 0)
497 p = g_ptr_array_new ();
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);
505 names = (gchar **) g_ptr_array_free (p, FALSE);
511 static const GDBusPropertyInfo *
512 lookup_property_info_or_warn (GDBusProxy *proxy,
513 const gchar *property_name)
515 const GDBusPropertyInfo *info;
517 if (proxy->priv->expected_interface == NULL)
520 info = g_dbus_interface_info_lookup_property (proxy->priv->expected_interface, property_name);
523 g_warning ("Trying to lookup property %s which isn't in expected interface %s",
525 proxy->priv->expected_interface->name);
532 * g_dbus_proxy_get_cached_property:
533 * @proxy: A #GDBusProxy.
534 * @property_name: Property name.
536 * Looks up the value for a property from the cache. This call does no
539 * If @proxy has an expected interface (see
540 * #GDBusProxy:g-interface-info), then @property_name (for existence)
541 * is checked against it.
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().
550 g_dbus_proxy_get_cached_property (GDBusProxy *proxy,
551 const gchar *property_name)
555 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
556 g_return_val_if_fail (property_name != NULL, NULL);
558 value = g_hash_table_lookup (proxy->priv->properties, property_name);
561 const GDBusPropertyInfo *info;
562 info = lookup_property_info_or_warn (proxy, property_name);
567 g_variant_ref (value);
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.
579 * If @value is not %NULL, sets the cached value for the property with
580 * name @property_name to the value in @value.
582 * If @value is %NULL, then the cached value is removed from the
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.
589 * If the @value #GVariant is floating, it is consumed. This allows
590 * convenient 'inline' use of g_variant_new(), e.g.
592 * g_dbus_proxy_set_cached_property (proxy,
594 * g_variant_new ("(si)",
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.
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
617 g_dbus_proxy_set_cached_property (GDBusProxy *proxy,
618 const gchar *property_name,
621 const GDBusPropertyInfo *info;
623 g_return_if_fail (G_IS_DBUS_PROXY (proxy));
624 g_return_if_fail (property_name != NULL);
628 info = lookup_property_info_or_warn (proxy, property_name);
631 if (g_strcmp0 (info->signature, g_variant_get_type_string (value)) != 0)
633 g_warning (_("Trying to set property %s of type %s but according to the expected "
634 "interface the type is %s"),
636 g_variant_get_type_string (value),
641 g_hash_table_insert (proxy->priv->properties,
642 g_strdup (property_name),
643 g_variant_ref_sink (value));
647 g_hash_table_remove (proxy->priv->properties, property_name);
654 /* ---------------------------------------------------------------------------------------------------- */
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,
665 GDBusProxy *proxy = G_DBUS_PROXY (user_data);
667 if (!proxy->priv->initialized)
670 g_signal_emit (proxy,
671 signals[SIGNAL_SIGNAL],
680 /* ---------------------------------------------------------------------------------------------------- */
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,
691 GDBusProxy *proxy = G_DBUS_PROXY (user_data);
693 const gchar *interface_name_for_signal;
694 GVariant *changed_properties;
695 gchar **invalidated_properties;
701 changed_properties = NULL;
702 invalidated_properties = NULL;
704 if (!proxy->priv->initialized)
707 if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(sa{sv}as)")))
709 g_warning ("Value for PropertiesChanged signal with type `%s' does not match `(sa{sv}as)'",
710 g_variant_get_type_string (parameters));
714 g_variant_get (parameters,
716 &interface_name_for_signal,
718 &invalidated_properties);
720 if (g_strcmp0 (interface_name_for_signal, proxy->priv->interface_name) != 0)
723 g_variant_iter_init (&iter, changed_properties);
724 while (g_variant_iter_next (&iter, "{sv}", &key, &value))
726 g_hash_table_insert (proxy->priv->properties,
727 key, /* adopts string */
728 value); /* adopts value */
732 g_signal_emit (proxy, signals[PROPERTIES_CHANGED_SIGNAL],
735 invalidated_properties);
738 if (changed_properties != NULL)
739 g_variant_unref (changed_properties);
740 g_free (invalidated_properties);
743 /* ---------------------------------------------------------------------------------------------------- */
746 g_dbus_proxy_constructed (GObject *object)
748 if (G_OBJECT_CLASS (g_dbus_proxy_parent_class)->constructed != NULL)
749 G_OBJECT_CLASS (g_dbus_proxy_parent_class)->constructed (object);
752 /* ---------------------------------------------------------------------------------------------------- */
755 subscribe_to_signals (GDBusProxy *proxy)
757 if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
759 /* subscribe to PropertiesChanged() */
760 proxy->priv->properties_changed_subscriber_id =
761 g_dbus_connection_signal_subscribe (proxy->priv->connection,
762 proxy->priv->unique_bus_name,
763 "org.freedesktop.DBus.Properties",
765 proxy->priv->object_path,
766 proxy->priv->interface_name,
767 on_properties_changed,
772 if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS))
774 /* subscribe to all signals for the object */
775 proxy->priv->signals_subscriber_id =
776 g_dbus_connection_signal_subscribe (proxy->priv->connection,
777 proxy->priv->unique_bus_name,
778 proxy->priv->interface_name,
780 proxy->priv->object_path,
788 /* ---------------------------------------------------------------------------------------------------- */
791 process_get_all_reply (GDBusProxy *proxy,
797 if (strcmp (g_variant_get_type_string (result), "(a{sv})") != 0)
799 g_warning ("Value for GetAll reply with type `%s' does not match `(a{sv})'",
800 g_variant_get_type_string (result));
804 g_variant_iter_init (&iter, g_variant_get_child_value (result, 0));
805 while ((item = g_variant_iter_next_value (&iter)) != NULL)
814 //g_print ("got %s -> %s\n", key, g_variant_markup_print (value, FALSE, 0, 0));
816 g_hash_table_insert (proxy->priv->properties,
818 value); /* steals value */
825 initable_init (GInitable *initable,
826 GCancellable *cancellable,
829 GDBusProxy *proxy = G_DBUS_PROXY (initable);
835 subscribe_to_signals (proxy);
837 if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
839 /* load all properties synchronously */
840 result = g_dbus_connection_call_sync (proxy->priv->connection,
841 proxy->priv->unique_bus_name,
842 proxy->priv->object_path,
843 "org.freedesktop.DBus.Properties",
845 g_variant_new ("(s)", proxy->priv->interface_name),
846 G_DBUS_CALL_FLAGS_NONE,
853 process_get_all_reply (proxy, result);
855 g_variant_unref (result);
861 proxy->priv->initialized = TRUE;
866 initable_iface_init (GInitableIface *initable_iface)
868 initable_iface->init = initable_init;
871 /* ---------------------------------------------------------------------------------------------------- */
874 get_all_cb (GDBusConnection *connection,
878 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
883 result = g_dbus_connection_call_finish (connection,
888 g_simple_async_result_set_from_error (simple, error);
889 g_error_free (error);
893 g_simple_async_result_set_op_res_gpointer (simple,
895 (GDestroyNotify) g_variant_unref);
898 g_simple_async_result_complete_in_idle (simple);
899 g_object_unref (simple);
903 async_initable_init_async (GAsyncInitable *initable,
905 GCancellable *cancellable,
906 GAsyncReadyCallback callback,
909 GDBusProxy *proxy = G_DBUS_PROXY (initable);
910 GSimpleAsyncResult *simple;
912 simple = g_simple_async_result_new (G_OBJECT (proxy),
917 subscribe_to_signals (proxy);
919 if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
921 /* load all properties asynchronously */
922 g_dbus_connection_call (proxy->priv->connection,
923 proxy->priv->unique_bus_name,
924 proxy->priv->object_path,
925 "org.freedesktop.DBus.Properties",
927 g_variant_new ("(s)", proxy->priv->interface_name),
928 G_DBUS_CALL_FLAGS_NONE,
931 (GAsyncReadyCallback) get_all_cb,
936 g_simple_async_result_complete_in_idle (simple);
937 g_object_unref (simple);
942 async_initable_init_finish (GAsyncInitable *initable,
946 GDBusProxy *proxy = G_DBUS_PROXY (initable);
947 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
953 result = g_simple_async_result_get_op_res_gpointer (simple);
956 if (!(proxy->priv->flags & G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES))
958 g_simple_async_result_propagate_error (simple, error);
964 process_get_all_reply (proxy, result);
970 proxy->priv->initialized = TRUE;
975 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
977 async_initable_iface->init_async = async_initable_init_async;
978 async_initable_iface->init_finish = async_initable_init_finish;
981 /* ---------------------------------------------------------------------------------------------------- */
985 * @connection: A #GDBusConnection.
986 * @object_type: Either #G_TYPE_DBUS_PROXY or the #GType for the #GDBusProxy<!-- -->-derived type of proxy to create.
987 * @flags: Flags used when constructing the proxy.
988 * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
989 * @unique_bus_name: A unique bus name or %NULL if @connection is not a message bus connection.
990 * @object_path: An object path.
991 * @interface_name: A D-Bus interface name.
992 * @cancellable: A #GCancellable or %NULL.
993 * @callback: Callback function to invoke when the proxy is ready.
994 * @user_data: User data to pass to @callback.
996 * Creates a proxy for accessing @interface_name on the remote object at @object_path
997 * owned by @unique_bus_name at @connection and asynchronously loads D-Bus properties unless the
998 * #G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to the
999 * #GDBusProxy::g-properties-changed signal to get notified about property changes.
1001 * If the #G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1002 * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1003 * to handle signals from the remote object.
1005 * This is a failable asynchronous constructor - when the proxy is
1006 * ready, @callback will be invoked and you can use
1007 * g_dbus_proxy_new_finish() to get the result.
1009 * See g_dbus_proxy_new_sync() and for a synchronous version of this constructor.
1014 g_dbus_proxy_new (GDBusConnection *connection,
1016 GDBusProxyFlags flags,
1017 GDBusInterfaceInfo *info,
1018 const gchar *unique_bus_name,
1019 const gchar *object_path,
1020 const gchar *interface_name,
1021 GCancellable *cancellable,
1022 GAsyncReadyCallback callback,
1025 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1026 g_return_if_fail (g_type_is_a (object_type, G_TYPE_DBUS_PROXY));
1027 g_return_if_fail ((unique_bus_name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
1028 g_dbus_is_unique_name (unique_bus_name));
1029 g_return_if_fail (g_variant_is_object_path (object_path));
1030 g_return_if_fail (g_dbus_is_interface_name (interface_name));
1032 g_async_initable_new_async (object_type,
1038 "g-interface-info", info,
1039 "g-unique-bus-name", unique_bus_name,
1040 "g-connection", connection,
1041 "g-object-path", object_path,
1042 "g-interface-name", interface_name,
1047 * g_dbus_proxy_new_finish:
1048 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new().
1049 * @error: Return location for error or %NULL.
1051 * Finishes creating a #GDBusProxy.
1053 * Returns: A #GDBusProxy or %NULL if @error is set. Free with g_object_unref().
1058 g_dbus_proxy_new_finish (GAsyncResult *res,
1062 GObject *source_object;
1064 source_object = g_async_result_get_source_object (res);
1065 g_assert (source_object != NULL);
1067 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
1070 g_object_unref (source_object);
1073 return G_DBUS_PROXY (object);
1079 /* ---------------------------------------------------------------------------------------------------- */
1082 * g_dbus_proxy_new_sync:
1083 * @connection: A #GDBusConnection.
1084 * @object_type: Either #G_TYPE_DBUS_PROXY or the #GType for the #GDBusProxy<!-- -->-derived type of proxy to create.
1085 * @flags: Flags used when constructing the proxy.
1086 * @info: A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL.
1087 * @unique_bus_name: A unique bus name or %NULL if @connection is not a message bus connection.
1088 * @object_path: An object path.
1089 * @interface_name: A D-Bus interface name.
1090 * @cancellable: A #GCancellable or %NULL.
1091 * @error: Return location for error or %NULL.
1093 * Creates a proxy for accessing @interface_name on the remote object at @object_path
1094 * owned by @unique_bus_name at @connection and synchronously loads D-Bus properties unless the
1095 * #G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used.
1097 * If the #G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS flag is not set, also sets up
1098 * match rules for signals. Connect to the #GDBusProxy::g-signal signal
1099 * to handle signals from the remote object.
1101 * This is a synchronous failable constructor. See g_dbus_proxy_new()
1102 * and g_dbus_proxy_new_finish() for the asynchronous version.
1104 * Returns: A #GDBusProxy or %NULL if error is set. Free with g_object_unref().
1109 g_dbus_proxy_new_sync (GDBusConnection *connection,
1111 GDBusProxyFlags flags,
1112 GDBusInterfaceInfo *info,
1113 const gchar *unique_bus_name,
1114 const gchar *object_path,
1115 const gchar *interface_name,
1116 GCancellable *cancellable,
1119 GInitable *initable;
1121 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1122 g_return_val_if_fail (g_type_is_a (object_type, G_TYPE_DBUS_PROXY), NULL);
1123 g_return_val_if_fail ((unique_bus_name == NULL && g_dbus_connection_get_unique_name (connection) == NULL) ||
1124 g_dbus_is_unique_name (unique_bus_name), NULL);
1125 g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
1126 g_return_val_if_fail (g_dbus_is_interface_name (interface_name), NULL);
1128 initable = g_initable_new (object_type,
1132 "g-interface-info", info,
1133 "g-unique-bus-name", unique_bus_name,
1134 "g-connection", connection,
1135 "g-object-path", object_path,
1136 "g-interface-name", interface_name,
1138 if (initable != NULL)
1139 return G_DBUS_PROXY (initable);
1144 /* ---------------------------------------------------------------------------------------------------- */
1147 * g_dbus_proxy_get_connection:
1148 * @proxy: A #GDBusProxy.
1150 * Gets the connection @proxy is for.
1152 * Returns: A #GDBusConnection owned by @proxy. Do not free.
1157 g_dbus_proxy_get_connection (GDBusProxy *proxy)
1159 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1160 return proxy->priv->connection;
1164 * g_dbus_proxy_get_flags:
1165 * @proxy: A #GDBusProxy.
1167 * Gets the flags that @proxy was constructed with.
1169 * Returns: Flags from the #GDBusProxyFlags enumeration.
1174 g_dbus_proxy_get_flags (GDBusProxy *proxy)
1176 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), 0);
1177 return proxy->priv->flags;
1181 * g_dbus_proxy_get_unique_bus_name:
1182 * @proxy: A #GDBusProxy.
1184 * Gets the unique bus name @proxy is for.
1186 * Returns: A string owned by @proxy. Do not free.
1191 g_dbus_proxy_get_unique_bus_name (GDBusProxy *proxy)
1193 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1194 return proxy->priv->unique_bus_name;
1198 * g_dbus_proxy_get_object_path:
1199 * @proxy: A #GDBusProxy.
1201 * Gets the object path @proxy is for.
1203 * Returns: A string owned by @proxy. Do not free.
1208 g_dbus_proxy_get_object_path (GDBusProxy *proxy)
1210 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1211 return proxy->priv->object_path;
1215 * g_dbus_proxy_get_interface_name:
1216 * @proxy: A #GDBusProxy.
1218 * Gets the D-Bus interface name @proxy is for.
1220 * Returns: A string owned by @proxy. Do not free.
1225 g_dbus_proxy_get_interface_name (GDBusProxy *proxy)
1227 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1228 return proxy->priv->interface_name;
1232 * g_dbus_proxy_get_default_timeout:
1233 * @proxy: A #GDBusProxy.
1235 * Gets the timeout to use if -1 (specifying default timeout) is
1236 * passed as @timeout_msec in the g_dbus_proxy_call() and
1237 * g_dbus_proxy_call_sync() functions.
1239 * See the #GDBusProxy:g-default-timeout property for more details.
1241 * Returns: Timeout to use for @proxy.
1246 g_dbus_proxy_get_default_timeout (GDBusProxy *proxy)
1248 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), -1);
1249 return proxy->priv->timeout_msec;
1253 * g_dbus_proxy_set_default_timeout:
1254 * @proxy: A #GDBusProxy.
1255 * @timeout_msec: Timeout in milliseconds.
1257 * Sets the timeout to use if -1 (specifying default timeout) is
1258 * passed as @timeout_msec in the g_dbus_proxy_call() and
1259 * g_dbus_proxy_call_sync() functions.
1261 * See the #GDBusProxy:g-default-timeout property for more details.
1266 g_dbus_proxy_set_default_timeout (GDBusProxy *proxy,
1269 g_return_if_fail (G_IS_DBUS_PROXY (proxy));
1270 g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
1272 /* TODO: locking? */
1273 if (proxy->priv->timeout_msec != timeout_msec)
1275 proxy->priv->timeout_msec = timeout_msec;
1276 g_object_notify (G_OBJECT (proxy), "g-default-timeout");
1281 * g_dbus_proxy_get_interface_info:
1282 * @proxy: A #GDBusProxy
1284 * Returns the #GDBusInterfaceInfo, if any, specifying the minimal
1285 * interface that @proxy conforms to.
1287 * See the #GDBusProxy:g-interface-info property for more details.
1289 * Returns: A #GDBusInterfaceInfo or %NULL. Do not unref the returned
1290 * object, it is owned by @proxy.
1294 GDBusInterfaceInfo *
1295 g_dbus_proxy_get_interface_info (GDBusProxy *proxy)
1297 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1298 return proxy->priv->expected_interface;
1302 * g_dbus_proxy_set_interface_info:
1303 * @proxy: A #GDBusProxy
1304 * @info: Minimum interface this proxy conforms to or %NULL to unset.
1306 * Ensure that interactions with @proxy conform to the given
1307 * interface. For example, when completing a method call, if the type
1308 * signature of the message isn't what's expected, the given #GError
1309 * is set. Signals that have a type signature mismatch are simply
1312 * See the #GDBusProxy:g-interface-info property for more details.
1317 g_dbus_proxy_set_interface_info (GDBusProxy *proxy,
1318 GDBusInterfaceInfo *info)
1320 g_return_if_fail (G_IS_DBUS_PROXY (proxy));
1321 if (proxy->priv->expected_interface != NULL)
1322 g_dbus_interface_info_unref (proxy->priv->expected_interface);
1323 proxy->priv->expected_interface = info != NULL ? g_dbus_interface_info_ref (info) : NULL;
1326 /* ---------------------------------------------------------------------------------------------------- */
1329 maybe_split_method_name (const gchar *method_name,
1330 gchar **out_interface_name,
1331 const gchar **out_method_name)
1336 g_assert (out_interface_name != NULL);
1337 g_assert (out_method_name != NULL);
1338 *out_interface_name = NULL;
1339 *out_method_name = NULL;
1341 if (strchr (method_name, '.') != NULL)
1346 p = g_strdup (method_name);
1347 last_dot = strrchr (p, '.');
1350 *out_interface_name = p;
1351 *out_method_name = last_dot + 1;
1361 reply_cb (GDBusConnection *connection,
1365 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
1370 value = g_dbus_connection_call_finish (connection,
1375 g_simple_async_result_set_from_error (simple,
1377 g_error_free (error);
1381 g_simple_async_result_set_op_res_gpointer (simple,
1383 (GDestroyNotify) g_variant_unref);
1386 /* no need to complete in idle since the method GDBusConnection already does */
1387 g_simple_async_result_complete (simple);
1390 static const GDBusMethodInfo *
1391 lookup_method_info_or_warn (GDBusProxy *proxy,
1392 const gchar *method_name)
1394 const GDBusMethodInfo *info;
1396 if (proxy->priv->expected_interface == NULL)
1399 info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, method_name);
1402 g_warning ("Trying to invoke method %s which isn't in expected interface %s",
1403 method_name, proxy->priv->expected_interface->name);
1410 validate_method_return (const char *method_name,
1412 const GDBusMethodInfo *expected_method_info,
1415 const gchar *type_string;
1422 if (value == NULL || expected_method_info == NULL)
1425 /* Shouldn't happen... */
1426 if (g_variant_classify (value) != G_VARIANT_CLASS_TUPLE)
1429 type_string = g_variant_get_type_string (value);
1430 signature = _g_dbus_compute_complete_signature (expected_method_info->out_args, TRUE);
1431 if (g_strcmp0 (type_string, signature) != 0)
1435 G_IO_ERROR_INVALID_ARGUMENT,
1436 _("Method `%s' returned signature `%s', but expected `%s'"),
1449 * g_dbus_proxy_call:
1450 * @proxy: A #GDBusProxy.
1451 * @method_name: Name of method to invoke.
1452 * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
1453 * @flags: Flags from the #GDBusCallFlags enumeration.
1454 * @timeout_msec: The timeout in milliseconds or -1 to use the proxy default timeout.
1455 * @cancellable: A #GCancellable or %NULL.
1456 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
1457 * care about the result of the method invocation.
1458 * @user_data: The data to pass to @callback.
1460 * Asynchronously invokes the @method_name method on @proxy.
1462 * If @method_name contains any dots, then @name is split into interface and
1463 * method name parts. This allows using @proxy for invoking methods on
1466 * If the #GDBusConnection associated with @proxy is closed then
1467 * the operation will fail with %G_IO_ERROR_CLOSED. If
1468 * @cancellable is canceled, the operation will fail with
1469 * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
1470 * compatible with the D-Bus protocol, the operation fails with
1471 * %G_IO_ERROR_INVALID_ARGUMENT.
1473 * If the @parameters #GVariant is floating, it is consumed. This allows
1474 * convenient 'inline' use of g_variant_new(), e.g.:
1476 * g_dbus_proxy_call (proxy,
1478 * g_variant_new ("(ss)",
1481 * G_DBUS_CALL_FLAGS_NONE,
1484 * (GAsyncReadyCallback) two_strings_done,
1488 * This is an asynchronous method. When the operation is finished,
1489 * @callback will be invoked in the
1490 * <link linkend="g-main-context-push-thread-default">thread-default
1491 * main loop</link> of the thread you are calling this method from.
1492 * You can then call g_dbus_proxy_call_finish() to get the result of
1493 * the operation. See g_dbus_proxy_call_sync() for the synchronous
1494 * version of this method.
1499 g_dbus_proxy_call (GDBusProxy *proxy,
1500 const gchar *method_name,
1501 GVariant *parameters,
1502 GDBusCallFlags flags,
1504 GCancellable *cancellable,
1505 GAsyncReadyCallback callback,
1508 GSimpleAsyncResult *simple;
1510 gchar *split_interface_name;
1511 const gchar *split_method_name;
1512 const GDBusMethodInfo *expected_method_info;
1513 const gchar *target_method_name;
1514 const gchar *target_interface_name;
1516 g_return_if_fail (G_IS_DBUS_PROXY (proxy));
1517 g_return_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name));
1518 g_return_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
1519 g_return_if_fail (timeout_msec == -1 || timeout_msec >= 0);
1521 simple = g_simple_async_result_new (G_OBJECT (proxy),
1526 was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
1527 target_method_name = was_split ? split_method_name : method_name;
1528 target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
1530 g_object_set_data_full (G_OBJECT (simple), "-gdbus-proxy-method-name", g_strdup (target_method_name), g_free);
1532 /* Just warn here */
1533 expected_method_info = lookup_method_info_or_warn (proxy, target_method_name);
1535 g_dbus_connection_call (proxy->priv->connection,
1536 proxy->priv->unique_bus_name,
1537 proxy->priv->object_path,
1538 target_interface_name,
1542 timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
1544 (GAsyncReadyCallback) reply_cb,
1547 g_free (split_interface_name);
1551 * g_dbus_proxy_call_finish:
1552 * @proxy: A #GDBusProxy.
1553 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().
1554 * @error: Return location for error or %NULL.
1556 * Finishes an operation started with g_dbus_proxy_call().
1558 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
1559 * return values. Free with g_variant_unref().
1564 g_dbus_proxy_call_finish (GDBusProxy *proxy,
1568 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1570 const char *method_name;
1571 const GDBusMethodInfo *expected_method_info;
1573 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1574 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1575 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1577 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_proxy_call);
1581 if (g_simple_async_result_propagate_error (simple, error))
1584 value = g_simple_async_result_get_op_res_gpointer (simple);
1585 method_name = g_object_get_data (G_OBJECT (simple), "-gdbus-proxy-method-name");
1587 /* We may not have a method name for internally-generated proxy calls like GetAll */
1588 if (value && method_name && proxy->priv->expected_interface)
1590 expected_method_info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, method_name);
1591 if (!validate_method_return (method_name, value, expected_method_info, error))
1593 g_variant_unref (value);
1603 * g_dbus_proxy_call_sync:
1604 * @proxy: A #GDBusProxy.
1605 * @method_name: Name of method to invoke.
1606 * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
1607 * @flags: Flags from the #GDBusCallFlags enumeration.
1608 * @timeout_msec: The timeout in milliseconds or -1 to use the proxy default timeout.
1609 * @cancellable: A #GCancellable or %NULL.
1610 * @error: Return location for error or %NULL.
1612 * Synchronously invokes the @method_name method on @proxy.
1614 * If @method_name contains any dots, then @name is split into interface and
1615 * method name parts. This allows using @proxy for invoking methods on
1618 * If the #GDBusConnection associated with @proxy is disconnected then
1619 * the operation will fail with %G_IO_ERROR_CLOSED. If
1620 * @cancellable is canceled, the operation will fail with
1621 * %G_IO_ERROR_CANCELLED. If @parameters contains a value not
1622 * compatible with the D-Bus protocol, the operation fails with
1623 * %G_IO_ERROR_INVALID_ARGUMENT.
1625 * If the @parameters #GVariant is floating, it is consumed. This allows
1626 * convenient 'inline' use of g_variant_new(), e.g.:
1628 * g_dbus_proxy_call_sync (proxy,
1630 * g_variant_new ("(ss)",
1633 * G_DBUS_CALL_FLAGS_NONE,
1639 * The calling thread is blocked until a reply is received. See
1640 * g_dbus_proxy_call() for the asynchronous version of this
1643 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
1644 * return values. Free with g_variant_unref().
1649 g_dbus_proxy_call_sync (GDBusProxy *proxy,
1650 const gchar *method_name,
1651 GVariant *parameters,
1652 GDBusCallFlags flags,
1654 GCancellable *cancellable,
1659 gchar *split_interface_name;
1660 const gchar *split_method_name;
1661 const GDBusMethodInfo *expected_method_info;
1662 const gchar *target_method_name;
1663 const gchar *target_interface_name;
1665 g_return_val_if_fail (G_IS_DBUS_PROXY (proxy), NULL);
1666 g_return_val_if_fail (g_dbus_is_member_name (method_name) || g_dbus_is_interface_name (method_name), NULL);
1667 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
1668 g_return_val_if_fail (timeout_msec == -1 || timeout_msec >= 0, NULL);
1669 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1671 was_split = maybe_split_method_name (method_name, &split_interface_name, &split_method_name);
1672 target_method_name = was_split ? split_method_name : method_name;
1673 target_interface_name = was_split ? split_interface_name : proxy->priv->interface_name;
1675 if (proxy->priv->expected_interface)
1677 expected_method_info = g_dbus_interface_info_lookup_method (proxy->priv->expected_interface, target_method_name);
1678 if (expected_method_info == NULL)
1680 g_warning ("Trying to invoke method `%s' which isn't in expected interface `%s'",
1682 target_interface_name);
1687 expected_method_info = NULL;
1690 ret = g_dbus_connection_call_sync (proxy->priv->connection,
1691 proxy->priv->unique_bus_name,
1692 proxy->priv->object_path,
1693 target_interface_name,
1697 timeout_msec == -1 ? proxy->priv->timeout_msec : timeout_msec,
1700 if (!validate_method_return (target_method_name, ret, expected_method_info, error))
1702 g_variant_unref (ret);
1706 g_free (split_interface_name);
1711 /* ---------------------------------------------------------------------------------------------------- */
1713 #define __G_DBUS_PROXY_C__
1714 #include "gioaliasdef.c"