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>
26 * - Validate all data (e.g. UTF-8) and check all the required D-Bus headers
27 * are present and forbidden ones aren't
28 * - When writing: g_dbus_message_to_blob()
29 * - When reading: g_dbus_message_new_from_blob()
31 * - would be nice to expose GDBusAuthMechanism and an extension point
33 * - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
34 * the mechanism VFuncs need to be able to set an error.
36 * - Need to document other mechanisms/sources for determining the D-Bus
37 * address of a well-known bus.
39 * - e.g. on Win32 we need code like from here
41 * http://cgit.freedesktop.org/~david/gdbus-standalone/tree/gdbus/gdbusaddress.c#n900
43 * that was never copied over here because it originally was copy-paste
44 * from the GPLv2 / AFL 2.1 libdbus sources.
46 * - on OS X we need to look in launchd for the address
48 * https://bugs.freedesktop.org/show_bug.cgi?id=14259
50 * - on X11 we need to look in a X11 property on the X server
51 * - (we can also just use dbus-launch(1) from the D-Bus
54 * - (ideally) this requires D-Bus spec work because none of
55 * this has never really been specced out properly (excect
58 * - Related to the above, we also need to be able to launch a message bus
59 * instance.... Since we don't want to write our own bus daemon we should
60 * launch dbus-daemon(1) (thus: Win32 and OS X need to bundle it)
62 * - probably want a G_DBUS_NONCE_TCP_TMPDIR environment variable
63 * to specify where the nonce is stored. This will allow people to use
64 * G_DBUS_NONCE_TCP_TMPDIR=/mnt/secure.company.server/dbus-nonce-dir
65 * to easily acheive secure RPC via nonce-tcp.
67 * - need to expose an extension point for resolving D-Bus address and
68 * turning them into GIOStream objects. This will allow us to implement
69 * e.g. X11 D-Bus transports without dlopen()'ing or linking against
71 * - see g_dbus_address_connect() in gdbusaddress.c
73 * - would be cute to use kernel-specific APIs to resolve fds for
74 * debug output when using G_DBUS_DEBUG=message, e.g. in addition to
76 * fd 21: dev=8:1,mode=0100644,ino=1171231,uid=0,gid=0,rdev=0:0,size=234,atime=1273070640,mtime=1267126160,ctime=1267126160
78 * maybe we can show more information about what fd 21 really is.
79 * Ryan suggests looking in /proc/self/fd for clues / symlinks!
80 * Initial experiments on Linux 2.6 suggests that the symlink looks
85 * e.g. not of much use.
87 * - GDBus High-Level docs
88 * - Proxy: properties, signals...
89 * - Connection: IOStream based, ::close, connection setup steps
90 * mainloop integration, threading
91 * - Differences from libdbus (extend "Migrating from")
92 * - the message handling thread
93 * - Using GVariant instead of GValue
94 * - Explain why the high-level API is a good thing and what
95 * kind of pitfalls it avoids
96 * - Export objects before claiming names
97 * - Talk about auto-starting services (cf. GBusNameWatcherFlags)
104 #include <sys/types.h>
109 #include "gdbusauth.h"
110 #include "gdbusutils.h"
111 #include "gdbusaddress.h"
112 #include "gdbusmessage.h"
113 #include "gdbusconnection.h"
114 #include "gdbuserror.h"
115 #include "gioenumtypes.h"
116 #include "gdbusintrospection.h"
117 #include "gdbusmethodinvocation.h"
118 #include "gdbusprivate.h"
119 #include "gdbusauthobserver.h"
120 #include "gio-marshal.h"
121 #include "ginitable.h"
122 #include "gasyncinitable.h"
123 #include "giostream.h"
124 #include "gasyncresult.h"
125 #include "gsimpleasyncresult.h"
128 #include "gunixconnection.h"
129 #include "gunixfdmessage.h"
132 #include "glibintl.h"
133 #include "gioalias.h"
136 * SECTION:gdbusconnection
137 * @short_description: D-Bus Connections
138 * @include: gio/gio.h
140 * The #GDBusConnection type is used for D-Bus connections to remote
141 * peers such as a message buses. It is a low-level API that offers a
142 * lot of flexibility. For instance, it lets you establish a connection
143 * over any transport that can by represented as an #GIOStream.
145 * This class is rarely used directly in D-Bus clients. If you are writing
146 * an D-Bus client, it is often easier to use the g_bus_own_name(),
147 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
149 * <example id="gdbus-server"><title>D-Bus server example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-server.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
151 * <example id="gdbus-subtree-server"><title>D-Bus subtree example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-subtree.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
153 * <example id="gdbus-unix-fd-client"><title>D-Bus UNIX File Descriptor example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-unix-fd-client.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
155 * <example id="gdbus-export"><title>Exporting a GObject</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-export.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
158 /* ---------------------------------------------------------------------------------------------------- */
160 G_LOCK_DEFINE_STATIC (message_bus_lock);
162 static GDBusConnection *the_session_bus = NULL;
163 static GDBusConnection *the_system_bus = NULL;
165 /* ---------------------------------------------------------------------------------------------------- */
168 _g_strv_has_string (const gchar* const *haystack,
173 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
175 if (g_strcmp0 (haystack[n], needle) == 0)
181 /* ---------------------------------------------------------------------------------------------------- */
184 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
186 // TODO: for some reason this doesn't work on Windows
187 #define CONNECTION_ENSURE_LOCK(obj) do { \
188 if (G_UNLIKELY (g_mutex_trylock((obj)->priv->lock))) \
190 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
191 "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
196 #define CONNECTION_LOCK(obj) do { \
197 g_mutex_lock ((obj)->priv->lock); \
200 #define CONNECTION_UNLOCK(obj) do { \
201 g_mutex_unlock ((obj)->priv->lock); \
204 struct _GDBusConnectionPrivate
206 /* ------------------------------------------------------------------------ */
207 /* -- General object state ------------------------------------------------ */
208 /* ------------------------------------------------------------------------ */
210 /* object-wide lock */
213 /* A lock used in the init() method of the GInitable interface - see comments
214 * in initable_init() for why a separate lock is needed
218 /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
219 * someone calls org.freedesktop.DBus.GetMachineId()
223 /* The underlying stream used for communication */
226 /* The object used for authentication (if any) */
229 /* Set to TRUE if the connection has been closed */
232 /* Last serial used */
235 /* The object used to send/receive message */
238 /* If connected to a message bus, this contains the unique name assigned to
239 * us by the bus (e.g. ":1.42")
241 gchar *bus_unique_name;
243 /* The GUID returned by the other side if we authenticed as a client or
244 * the GUID to use if authenticating as a server
248 /* set to TRUE exactly when initable_init() has finished running */
249 gboolean is_initialized;
251 /* If the connection could not be established during initable_init(), this GError will set */
252 GError *initialization_error;
254 /* The result of g_main_context_get_thread_default() when the object
255 * was created (the GObject _init() function) - this is used for delivery
256 * of the :closed GObject signal.
258 GMainContext *main_context_at_construction;
260 /* construct properties */
262 GDBusConnectionFlags flags;
264 /* Map used for managing method replies */
265 GHashTable *map_method_serial_to_send_message_data; /* guint32 -> SendMessageData* */
267 /* Maps used for managing signal subscription */
268 GHashTable *map_rule_to_signal_data; /* match rule (gchar*) -> SignalData */
269 GHashTable *map_id_to_signal_data; /* id (guint) -> SignalData */
270 GHashTable *map_sender_unique_name_to_signal_data_array; /* unique sender (gchar*) -> GPtrArray* of SignalData */
272 /* Maps used for managing exported objects and subtrees */
273 GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
274 GHashTable *map_id_to_ei; /* guint -> ExportedInterface* */
275 GHashTable *map_object_path_to_es; /* gchar* -> ExportedSubtree* */
276 GHashTable *map_id_to_es; /* guint -> ExportedSubtree* */
278 /* Structure used for message filters */
281 /* Whether to exit on close */
282 gboolean exit_on_close;
284 /* Capabilities negotiated during authentication */
285 GDBusCapabilityFlags capabilities;
287 GDBusAuthObserver *authentication_observer;
288 GCredentials *crendentials;
291 typedef struct ExportedObject ExportedObject;
292 static void exported_object_free (ExportedObject *eo);
294 typedef struct ExportedSubtree ExportedSubtree;
295 static void exported_subtree_free (ExportedSubtree *es);
313 PROP_CAPABILITY_FLAGS,
314 PROP_AUTHENTICATION_OBSERVER,
317 static void distribute_signals (GDBusConnection *connection,
318 GDBusMessage *message);
320 static void distribute_method_call (GDBusConnection *connection,
321 GDBusMessage *message);
323 static gboolean handle_generic_unlocked (GDBusConnection *connection,
324 GDBusMessage *message);
327 static void purge_all_signal_subscriptions (GDBusConnection *connection);
328 static void purge_all_filters (GDBusConnection *connection);
330 #define _G_ENSURE_LOCK(name) do { \
331 if (G_UNLIKELY (G_TRYLOCK(name))) \
333 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
334 "_G_ENSURE_LOCK: Lock `" #name "' is not locked"); \
338 static guint signals[LAST_SIGNAL] = { 0 };
340 static void initable_iface_init (GInitableIface *initable_iface);
341 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
343 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
344 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
345 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
349 g_dbus_connection_dispose (GObject *object)
351 GDBusConnection *connection = G_DBUS_CONNECTION (object);
353 G_LOCK (message_bus_lock);
354 //g_debug ("disposing %p", connection);
355 if (connection == the_session_bus)
357 the_session_bus = NULL;
359 else if (connection == the_system_bus)
361 the_system_bus = NULL;
363 if (connection->priv->worker != NULL)
365 _g_dbus_worker_stop (connection->priv->worker);
366 connection->priv->worker = NULL;
368 G_UNLOCK (message_bus_lock);
370 if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
371 G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
375 g_dbus_connection_finalize (GObject *object)
377 GDBusConnection *connection = G_DBUS_CONNECTION (object);
379 if (connection->priv->authentication_observer != NULL)
380 g_object_unref (connection->priv->authentication_observer);
382 if (connection->priv->auth != NULL)
383 g_object_unref (connection->priv->auth);
385 //g_debug ("finalizing %p", connection);
386 if (connection->priv->stream != NULL)
388 /* We don't really care if closing the stream succeeds or not */
389 g_io_stream_close_async (connection->priv->stream,
391 NULL, /* GCancellable */
392 NULL, /* GAsyncReadyCallback */
393 NULL); /* userdata */
394 g_object_unref (connection->priv->stream);
395 connection->priv->stream = NULL;
398 g_free (connection->priv->address);
400 g_free (connection->priv->guid);
401 g_free (connection->priv->bus_unique_name);
403 if (connection->priv->initialization_error != NULL)
404 g_error_free (connection->priv->initialization_error);
406 g_hash_table_unref (connection->priv->map_method_serial_to_send_message_data);
408 purge_all_signal_subscriptions (connection);
409 g_hash_table_unref (connection->priv->map_rule_to_signal_data);
410 g_hash_table_unref (connection->priv->map_id_to_signal_data);
411 g_hash_table_unref (connection->priv->map_sender_unique_name_to_signal_data_array);
413 g_hash_table_unref (connection->priv->map_id_to_ei);
414 g_hash_table_unref (connection->priv->map_object_path_to_eo);
415 g_hash_table_unref (connection->priv->map_id_to_es);
416 g_hash_table_unref (connection->priv->map_object_path_to_es);
418 purge_all_filters (connection);
419 g_ptr_array_unref (connection->priv->filters);
421 if (connection->priv->main_context_at_construction != NULL)
422 g_main_context_unref (connection->priv->main_context_at_construction);
424 g_free (connection->priv->machine_id);
426 g_mutex_free (connection->priv->init_lock);
427 g_mutex_free (connection->priv->lock);
429 G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
433 g_dbus_connection_get_property (GObject *object,
438 GDBusConnection *connection = G_DBUS_CONNECTION (object);
443 g_value_set_object (value, g_dbus_connection_get_stream (connection));
447 g_value_set_string (value, g_dbus_connection_get_guid (connection));
450 case PROP_UNIQUE_NAME:
451 g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
455 g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
458 case PROP_EXIT_ON_CLOSE:
459 g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
462 case PROP_CAPABILITY_FLAGS:
463 g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
467 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
473 g_dbus_connection_set_property (GObject *object,
478 GDBusConnection *connection = G_DBUS_CONNECTION (object);
483 connection->priv->stream = g_value_dup_object (value);
487 connection->priv->guid = g_value_dup_string (value);
491 connection->priv->address = g_value_dup_string (value);
495 connection->priv->flags = g_value_get_flags (value);
498 case PROP_EXIT_ON_CLOSE:
499 g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
502 case PROP_AUTHENTICATION_OBSERVER:
503 connection->priv->authentication_observer = g_value_dup_object (value);
507 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
513 g_dbus_connection_real_closed (GDBusConnection *connection,
514 gboolean remote_peer_vanished,
517 if (remote_peer_vanished && connection->priv->exit_on_close)
519 g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
525 g_dbus_connection_class_init (GDBusConnectionClass *klass)
527 GObjectClass *gobject_class;
529 g_type_class_add_private (klass, sizeof (GDBusConnectionPrivate));
531 gobject_class = G_OBJECT_CLASS (klass);
533 gobject_class->finalize = g_dbus_connection_finalize;
534 gobject_class->dispose = g_dbus_connection_dispose;
535 gobject_class->set_property = g_dbus_connection_set_property;
536 gobject_class->get_property = g_dbus_connection_get_property;
538 klass->closed = g_dbus_connection_real_closed;
541 * GDBusConnection:stream:
543 * The underlying #GIOStream used for I/O.
547 g_object_class_install_property (gobject_class,
549 g_param_spec_object ("stream",
551 P_("The underlying streams used for I/O"),
555 G_PARAM_CONSTRUCT_ONLY |
556 G_PARAM_STATIC_NAME |
557 G_PARAM_STATIC_BLURB |
558 G_PARAM_STATIC_NICK));
561 * GDBusConnection:address:
563 * A D-Bus address specifying potential endpoints that can be used
564 * when establishing the connection.
568 g_object_class_install_property (gobject_class,
570 g_param_spec_string ("address",
572 P_("D-Bus address specifying potential socket endpoints"),
575 G_PARAM_CONSTRUCT_ONLY |
576 G_PARAM_STATIC_NAME |
577 G_PARAM_STATIC_BLURB |
578 G_PARAM_STATIC_NICK));
581 * GDBusConnection:flags:
583 * Flags from the #GDBusConnectionFlags enumeration.
587 g_object_class_install_property (gobject_class,
589 g_param_spec_flags ("flags",
592 G_TYPE_DBUS_CONNECTION_FLAGS,
593 G_DBUS_CONNECTION_FLAGS_NONE,
595 G_PARAM_CONSTRUCT_ONLY |
596 G_PARAM_STATIC_NAME |
597 G_PARAM_STATIC_BLURB |
598 G_PARAM_STATIC_NICK));
601 * GDBusConnection:guid:
603 * The GUID of the peer performing the role of server when
606 * If you are constructing a #GDBusConnection and pass
607 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
608 * #GDBusConnection:flags property then you MUST also set this
609 * property to a valid guid.
611 * If you are constructing a #GDBusConnection and pass
612 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
613 * #GDBusConnection:flags property you will be able to read the GUID
614 * of the other peer here after the connection has been successfully
619 g_object_class_install_property (gobject_class,
621 g_param_spec_string ("guid",
623 P_("GUID of the server peer"),
627 G_PARAM_CONSTRUCT_ONLY |
628 G_PARAM_STATIC_NAME |
629 G_PARAM_STATIC_BLURB |
630 G_PARAM_STATIC_NICK));
633 * GDBusConnection:unique-name:
635 * The unique name as assigned by the message bus or %NULL if the
636 * connection is not open or not a message bus connection.
640 g_object_class_install_property (gobject_class,
642 g_param_spec_string ("unique-name",
644 P_("Unique name of bus connection"),
647 G_PARAM_STATIC_NAME |
648 G_PARAM_STATIC_BLURB |
649 G_PARAM_STATIC_NICK));
652 * GDBusConnection:closed:
654 * A boolean specifying whether the connection has been closed.
658 g_object_class_install_property (gobject_class,
660 g_param_spec_boolean ("closed",
662 P_("Whether the connection is closed"),
665 G_PARAM_STATIC_NAME |
666 G_PARAM_STATIC_BLURB |
667 G_PARAM_STATIC_NICK));
670 * GDBusConnection:exit-on-close:
672 * A boolean specifying whether the process will be terminated (by
673 * calling <literal>raise(SIGTERM)</literal>) if the connection
674 * is closed by the remote peer.
678 g_object_class_install_property (gobject_class,
680 g_param_spec_boolean ("exit-on-close",
682 P_("Whether the process is terminated when the connection is closed"),
686 G_PARAM_STATIC_NAME |
687 G_PARAM_STATIC_BLURB |
688 G_PARAM_STATIC_NICK));
691 * GDBusConnection:capabilities:
693 * Flags from the #GDBusCapabilityFlags enumeration
694 * representing connection features negotiated with the other peer.
698 g_object_class_install_property (gobject_class,
699 PROP_CAPABILITY_FLAGS,
700 g_param_spec_flags ("capabilities",
703 G_TYPE_DBUS_CAPABILITY_FLAGS,
704 G_DBUS_CAPABILITY_FLAGS_NONE,
706 G_PARAM_STATIC_NAME |
707 G_PARAM_STATIC_BLURB |
708 G_PARAM_STATIC_NICK));
711 * GDBusConnection:authentication-observer:
713 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
717 g_object_class_install_property (gobject_class,
718 PROP_AUTHENTICATION_OBSERVER,
719 g_param_spec_object ("authentication-observer",
720 P_("Authentication Observer"),
721 P_("Object used to assist in the authentication process"),
722 G_TYPE_DBUS_AUTH_OBSERVER,
724 G_PARAM_CONSTRUCT_ONLY |
725 G_PARAM_STATIC_NAME |
726 G_PARAM_STATIC_BLURB |
727 G_PARAM_STATIC_NICK));
730 * GDBusConnection::closed:
731 * @connection: The #GDBusConnection emitting the signal.
732 * @remote_peer_vanished: %TRUE if @connection is closed because the
733 * remote peer closed its end of the connection.
734 * @error: A #GError with more details about the event or %NULL.
736 * Emitted when the connection is closed.
738 * The cause of this event can be
741 * If g_dbus_connection_close() is called. In this case
742 * @remote_peer_vanished is set to %FALSE and @error is %NULL.
745 * If the remote peer closes the connection. In this case
746 * @remote_peer_vanished is set to %TRUE and @error is set.
749 * If the remote peer sends invalid or malformed data. In this
750 * case @remote_peer_vanished is set to %FALSE and @error
755 * Upon receiving this signal, you should give up your reference to
756 * @connection. You are guaranteed that this signal is emitted only
761 signals[CLOSED_SIGNAL] = g_signal_new ("closed",
762 G_TYPE_DBUS_CONNECTION,
764 G_STRUCT_OFFSET (GDBusConnectionClass, closed),
767 _gio_marshal_VOID__BOOLEAN_BOXED,
775 g_dbus_connection_init (GDBusConnection *connection)
777 connection->priv = G_TYPE_INSTANCE_GET_PRIVATE (connection, G_TYPE_DBUS_CONNECTION, GDBusConnectionPrivate);
779 connection->priv->lock = g_mutex_new ();
780 connection->priv->init_lock = g_mutex_new ();
782 connection->priv->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
784 connection->priv->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
786 connection->priv->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
788 connection->priv->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
793 connection->priv->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
796 (GDestroyNotify) exported_object_free);
798 connection->priv->map_id_to_ei = g_hash_table_new (g_direct_hash,
801 connection->priv->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
804 (GDestroyNotify) exported_subtree_free);
806 connection->priv->map_id_to_es = g_hash_table_new (g_direct_hash,
809 connection->priv->main_context_at_construction = g_main_context_get_thread_default ();
810 if (connection->priv->main_context_at_construction != NULL)
811 g_main_context_ref (connection->priv->main_context_at_construction);
813 connection->priv->filters = g_ptr_array_new ();
817 * g_dbus_connection_get_stream:
818 * @connection: a #GDBusConnection
820 * Gets the underlying stream used for IO.
822 * Returns: the stream used for IO
827 g_dbus_connection_get_stream (GDBusConnection *connection)
829 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
830 return connection->priv->stream;
834 * g_dbus_connection_start_message_processing:
835 * @connection: A #GDBusConnection.
837 * If @connection was created with
838 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
839 * starts processing messages. Does nothing on if @connection wasn't
840 * created with this flag or if the method has already been called.
845 g_dbus_connection_start_message_processing (GDBusConnection *connection)
847 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
848 _g_dbus_worker_unfreeze (connection->priv->worker);
852 * g_dbus_connection_is_closed:
853 * @connection: A #GDBusConnection.
855 * Gets whether @connection is closed.
857 * Returns: %TRUE if the connection is closed, %FALSE otherwise.
862 g_dbus_connection_is_closed (GDBusConnection *connection)
864 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
865 return connection->priv->closed;
869 * g_dbus_connection_get_capabilities:
870 * @connection: A #GDBusConnection.
872 * Gets the capabilities negotiated with the remote peer
874 * Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration.
879 g_dbus_connection_get_capabilities (GDBusConnection *connection)
881 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
882 return connection->priv->capabilities;
885 /* ---------------------------------------------------------------------------------------------------- */
888 flush_in_thread_func (GSimpleAsyncResult *res,
890 GCancellable *cancellable)
895 if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
899 g_simple_async_result_set_from_error (res, error);
900 g_error_free (error);
905 * g_dbus_connection_flush:
906 * @connection: A #GDBusConnection.
907 * @cancellable: A #GCancellable or %NULL.
908 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
909 * care about the result.
910 * @user_data: The data to pass to @callback.
912 * Asynchronously flushes @connection, that is, writes all queued
913 * outgoing message to the transport and then flushes the transport
914 * (using g_output_stream_flush_async()). This is useful in programs
915 * that wants to emit a D-Bus signal and then exit
916 * immediately. Without flushing the connection, there is no guarantee
917 * that the message has been sent to the networking buffers in the OS
920 * This is an asynchronous method. When the operation is finished,
921 * @callback will be invoked in the <link
922 * linkend="g-main-context-push-thread-default">thread-default main
923 * loop</link> of the thread you are calling this method from. You can
924 * then call g_dbus_connection_flush_finish() to get the result of the
925 * operation. See g_dbus_connection_flush_sync() for the synchronous
931 g_dbus_connection_flush (GDBusConnection *connection,
932 GCancellable *cancellable,
933 GAsyncReadyCallback callback,
936 GSimpleAsyncResult *simple;
938 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
940 simple = g_simple_async_result_new (NULL,
943 g_dbus_connection_flush);
944 g_simple_async_result_run_in_thread (simple,
945 flush_in_thread_func,
948 g_object_unref (simple);
952 * g_dbus_connection_flush_finish:
953 * @connection: A #GDBusConnection.
954 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush().
955 * @error: Return location for error or %NULL.
957 * Finishes an operation started with g_dbus_connection_flush().
959 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
964 g_dbus_connection_flush_finish (GDBusConnection *connection,
968 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
973 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
974 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
975 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
977 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
979 if (g_simple_async_result_propagate_error (simple, error))
989 * g_dbus_connection_flush_sync:
990 * @connection: A #GDBusConnection.
991 * @cancellable: A #GCancellable or %NULL.
992 * @error: Return location for error or %NULL.
994 * Synchronously flushes @connection. The calling thread is blocked
995 * until this is done. See g_dbus_connection_flush() for the
996 * asynchronous version of this method and more details about what it
999 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1004 g_dbus_connection_flush_sync (GDBusConnection *connection,
1005 GCancellable *cancellable,
1010 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1014 if (connection->priv->closed)
1016 g_set_error_literal (error,
1019 _("The connection is closed"));
1023 ret = _g_dbus_worker_flush_sync (connection->priv->worker,
1031 /* ---------------------------------------------------------------------------------------------------- */
1035 GDBusConnection *connection;
1037 gboolean remote_peer_vanished;
1041 emit_closed_data_free (EmitClosedData *data)
1043 g_object_unref (data->connection);
1044 if (data->error != NULL)
1045 g_error_free (data->error);
1050 emit_closed_in_idle (gpointer user_data)
1052 EmitClosedData *data = user_data;
1055 g_object_notify (G_OBJECT (data->connection), "closed");
1056 g_signal_emit (data->connection,
1057 signals[CLOSED_SIGNAL],
1059 data->remote_peer_vanished,
1065 /* Can be called from any thread, must hold lock */
1067 set_closed_unlocked (GDBusConnection *connection,
1068 gboolean remote_peer_vanished,
1071 GSource *idle_source;
1072 EmitClosedData *data;
1074 CONNECTION_ENSURE_LOCK (connection);
1076 g_assert (!connection->priv->closed);
1078 connection->priv->closed = TRUE;
1080 data = g_new0 (EmitClosedData, 1);
1081 data->connection = g_object_ref (connection);
1082 data->remote_peer_vanished = remote_peer_vanished;
1083 data->error = error != NULL ? g_error_copy (error) : NULL;
1085 idle_source = g_idle_source_new ();
1086 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1087 g_source_set_callback (idle_source,
1088 emit_closed_in_idle,
1090 (GDestroyNotify) emit_closed_data_free);
1091 g_source_attach (idle_source, connection->priv->main_context_at_construction);
1092 g_source_unref (idle_source);
1095 /* ---------------------------------------------------------------------------------------------------- */
1098 * g_dbus_connection_close:
1099 * @connection: A #GDBusConnection.
1101 * Closes @connection. Note that this never causes the process to
1102 * exit (this might only happen if the other end of a shared message
1103 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1105 * Once the stream is closed, all operations will return
1106 * %G_IO_ERROR_CLOSED.
1108 * Note that closing a connection will not automatically flush the
1109 * connection so queued messages may be lost. Use
1110 * g_dbus_connection_flush() if you need such guarantees.
1112 * If @connection is already closed, this method does nothing.
1117 g_dbus_connection_close (GDBusConnection *connection)
1119 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1121 CONNECTION_LOCK (connection);
1122 if (!connection->priv->closed)
1124 GError *error = NULL;
1126 /* TODO: do this async */
1127 //g_debug ("closing connection %p's stream %p", connection, connection->priv->stream);
1128 if (!g_io_stream_close (connection->priv->stream, NULL, &error))
1130 g_warning ("Error closing stream: %s", error->message);
1131 g_error_free (error);
1134 set_closed_unlocked (connection, FALSE, NULL);
1136 CONNECTION_UNLOCK (connection);
1139 /* ---------------------------------------------------------------------------------------------------- */
1142 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
1143 GDBusMessage *message,
1144 volatile guint32 *out_serial,
1149 guint32 serial_to_use;
1152 CONNECTION_ENSURE_LOCK (connection);
1154 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1155 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1157 /* TODO: check all necessary headers are present */
1162 if (out_serial != NULL)
1165 if (connection->priv->closed)
1167 g_set_error_literal (error,
1170 _("The connection is closed"));
1174 blob = g_dbus_message_to_blob (message,
1176 connection->priv->capabilities,
1181 serial_to_use = g_dbus_message_get_serial (message);
1182 if (serial_to_use == 0)
1184 serial_to_use = ++connection->priv->last_serial; /* TODO: handle overflow */
1190 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
1193 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
1196 g_assert_not_reached ();
1201 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
1202 blob_size, serial_to_use, connection);
1203 g_printerr ("----\n");
1204 hexdump (blob, blob_size);
1205 g_printerr ("----\n");
1208 /* TODO: use connection->priv->auth to encode the blob */
1210 if (out_serial != NULL)
1211 *out_serial = serial_to_use;
1213 g_dbus_message_set_serial (message, serial_to_use);
1215 _g_dbus_worker_send_message (connection->priv->worker,
1219 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
1230 * g_dbus_connection_send_message:
1231 * @connection: A #GDBusConnection.
1232 * @message: A #GDBusMessage
1233 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1234 * @error: Return location for error or %NULL.
1236 * Asynchronously sends @message to the peer represented by @connection.
1238 * If g_dbus_message_get_serial() returns non-zero for @message, then
1239 * that value is used for the message serial number. Otherwise a
1240 * serial number will be assigned by @connection and set on @message
1241 * via g_dbus_message_set_serial(). If @out_serial is not %NULL, then
1242 * the serial number used will be written to this location prior to
1243 * submitting the message to the underlying transport.
1245 * If @connection is closed then the operation will fail with
1246 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
1247 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1249 * See <xref linkend="gdbus-server"/> and <xref
1250 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1251 * low-level API to send and receive UNIX file descriptors.
1253 * Returns: %TRUE if the message was well-formed and queued for
1254 * transmission, %FALSE if @error is set.
1259 g_dbus_connection_send_message (GDBusConnection *connection,
1260 GDBusMessage *message,
1261 volatile guint32 *out_serial,
1266 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1267 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1268 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1270 CONNECTION_LOCK (connection);
1271 ret = g_dbus_connection_send_message_unlocked (connection, message, out_serial, error);
1272 CONNECTION_UNLOCK (connection);
1276 /* ---------------------------------------------------------------------------------------------------- */
1280 volatile gint ref_count;
1281 GDBusConnection *connection;
1283 GSimpleAsyncResult *simple;
1285 GMainContext *main_context;
1287 GCancellable *cancellable;
1289 gulong cancellable_handler_id;
1291 GSource *timeout_source;
1296 static SendMessageData *
1297 send_message_data_ref (SendMessageData *data)
1299 g_atomic_int_inc (&data->ref_count);
1304 send_message_data_unref (SendMessageData *data)
1306 if (g_atomic_int_dec_and_test (&data->ref_count))
1308 g_assert (data->timeout_source == NULL);
1309 g_assert (data->simple == NULL);
1310 g_assert (data->cancellable_handler_id == 0);
1311 g_object_unref (data->connection);
1312 if (data->cancellable != NULL)
1313 g_object_unref (data->cancellable);
1314 if (data->main_context != NULL)
1315 g_main_context_unref (data->main_context);
1320 /* ---------------------------------------------------------------------------------------------------- */
1322 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
1324 send_message_with_reply_deliver (SendMessageData *data)
1326 CONNECTION_ENSURE_LOCK (data->connection);
1328 g_assert (!data->delivered);
1330 data->delivered = TRUE;
1332 g_simple_async_result_complete_in_idle (data->simple);
1333 g_object_unref (data->simple);
1334 data->simple = NULL;
1336 if (data->timeout_source != NULL)
1338 g_source_destroy (data->timeout_source);
1339 data->timeout_source = NULL;
1341 if (data->cancellable_handler_id > 0)
1343 g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
1344 data->cancellable_handler_id = 0;
1347 g_warn_if_fail (g_hash_table_remove (data->connection->priv->map_method_serial_to_send_message_data,
1348 GUINT_TO_POINTER (data->serial)));
1350 send_message_data_unref (data);
1353 /* ---------------------------------------------------------------------------------------------------- */
1355 /* must hold lock */
1357 send_message_data_deliver_reply_unlocked (SendMessageData *data,
1358 GDBusMessage *reply)
1360 if (data->delivered)
1363 g_simple_async_result_set_op_res_gpointer (data->simple,
1364 g_object_ref (reply),
1367 send_message_with_reply_deliver (data);
1373 /* ---------------------------------------------------------------------------------------------------- */
1376 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
1378 SendMessageData *data = user_data;
1380 CONNECTION_LOCK (data->connection);
1381 if (data->delivered)
1384 g_simple_async_result_set_error (data->simple,
1386 G_IO_ERROR_CANCELLED,
1387 _("Operation was cancelled"));
1389 send_message_with_reply_deliver (data);
1392 CONNECTION_UNLOCK (data->connection);
1396 /* Can be called from any thread with or without lock held */
1398 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
1401 SendMessageData *data = user_data;
1402 GSource *idle_source;
1404 /* postpone cancellation to idle handler since we may be called directly
1405 * via g_cancellable_connect() (e.g. holding lock)
1407 idle_source = g_idle_source_new ();
1408 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1409 g_source_set_callback (idle_source,
1410 send_message_with_reply_cancelled_idle_cb,
1411 send_message_data_ref (data),
1412 (GDestroyNotify) send_message_data_unref);
1413 g_source_attach (idle_source, data->main_context);
1414 g_source_unref (idle_source);
1417 /* ---------------------------------------------------------------------------------------------------- */
1420 send_message_with_reply_timeout_cb (gpointer user_data)
1422 SendMessageData *data = user_data;
1424 CONNECTION_LOCK (data->connection);
1425 if (data->delivered)
1428 g_simple_async_result_set_error (data->simple,
1430 G_IO_ERROR_TIMED_OUT,
1431 _("Timeout was reached"));
1433 send_message_with_reply_deliver (data);
1436 CONNECTION_UNLOCK (data->connection);
1441 /* ---------------------------------------------------------------------------------------------------- */
1444 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
1445 GDBusMessage *message,
1447 volatile guint32 *out_serial,
1448 GCancellable *cancellable,
1449 GAsyncReadyCallback callback,
1452 GSimpleAsyncResult *simple;
1453 SendMessageData *data;
1455 volatile guint32 serial;
1459 if (out_serial == NULL)
1460 out_serial = &serial;
1462 if (timeout_msec == -1)
1463 timeout_msec = 25 * 1000;
1465 simple = g_simple_async_result_new (G_OBJECT (connection),
1468 g_dbus_connection_send_message_with_reply);
1470 if (g_cancellable_is_cancelled (cancellable))
1472 g_simple_async_result_set_error (simple,
1474 G_IO_ERROR_CANCELLED,
1475 _("Operation was cancelled"));
1476 g_simple_async_result_complete_in_idle (simple);
1477 g_object_unref (simple);
1481 if (connection->priv->closed)
1483 g_simple_async_result_set_error (simple,
1486 _("The connection is closed"));
1487 g_simple_async_result_complete_in_idle (simple);
1488 g_object_unref (simple);
1493 if (!g_dbus_connection_send_message_unlocked (connection, message, out_serial, &error))
1495 g_simple_async_result_set_from_error (simple, error);
1496 g_simple_async_result_complete_in_idle (simple);
1497 g_object_unref (simple);
1501 data = g_new0 (SendMessageData, 1);
1502 data->ref_count = 1;
1503 data->connection = g_object_ref (connection);
1504 data->simple = simple;
1505 data->serial = *out_serial;
1506 data->main_context = g_main_context_get_thread_default ();
1507 if (data->main_context != NULL)
1508 g_main_context_ref (data->main_context);
1510 if (cancellable != NULL)
1512 data->cancellable = g_object_ref (cancellable);
1513 data->cancellable_handler_id = g_cancellable_connect (cancellable,
1514 G_CALLBACK (send_message_with_reply_cancelled_cb),
1515 send_message_data_ref (data),
1516 (GDestroyNotify) send_message_data_unref);
1517 g_object_set_data_full (G_OBJECT (simple),
1519 g_object_ref (cancellable),
1520 (GDestroyNotify) g_object_unref);
1523 data->timeout_source = g_timeout_source_new (timeout_msec);
1524 g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
1525 g_source_set_callback (data->timeout_source,
1526 send_message_with_reply_timeout_cb,
1527 send_message_data_ref (data),
1528 (GDestroyNotify) send_message_data_unref);
1529 g_source_attach (data->timeout_source, data->main_context);
1530 g_source_unref (data->timeout_source);
1532 g_hash_table_insert (connection->priv->map_method_serial_to_send_message_data,
1533 GUINT_TO_POINTER (*out_serial),
1541 * g_dbus_connection_send_message_with_reply:
1542 * @connection: A #GDBusConnection.
1543 * @message: A #GDBusMessage.
1544 * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
1545 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1546 * @cancellable: A #GCancellable or %NULL.
1547 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
1548 * care about the result.
1549 * @user_data: The data to pass to @callback.
1551 * Asynchronously sends @message to the peer represented by @connection.
1553 * If g_dbus_message_get_serial() returns non-zero for @message, then
1554 * that value is used for the message serial number. Otherwise a
1555 * serial number will be assigned by @connection and set on @message
1556 * via g_dbus_message_set_serial(). If @out_serial is not %NULL, then
1557 * the serial number used will be written to this location prior to
1558 * submitting the message to the underlying transport.
1560 * If @connection is closed then the operation will fail with
1561 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1562 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1563 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1565 * This is an asynchronous method. When the operation is finished, @callback will be invoked
1566 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
1567 * of the thread you are calling this method from. You can then call
1568 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
1569 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
1571 * See <xref linkend="gdbus-server"/> and <xref
1572 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1573 * low-level API to send and receive UNIX file descriptors.
1578 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
1579 GDBusMessage *message,
1581 volatile guint32 *out_serial,
1582 GCancellable *cancellable,
1583 GAsyncReadyCallback callback,
1586 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1587 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1588 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
1590 CONNECTION_LOCK (connection);
1591 g_dbus_connection_send_message_with_reply_unlocked (connection,
1598 CONNECTION_UNLOCK (connection);
1602 * g_dbus_connection_send_message_with_reply_finish:
1603 * @connection: a #GDBusConnection
1604 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
1605 * @error: Return location for error or %NULL.
1607 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
1609 * Note that @error is only set if a local in-process error
1610 * occured. That is to say that the returned #GDBusMessage object may
1611 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
1612 * g_dbus_message_to_gerror() to transcode this to a #GError.
1614 * See <xref linkend="gdbus-server"/> and <xref
1615 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1616 * low-level API to send and receive UNIX file descriptors.
1618 * Returns: A #GDBusMessage or %NULL if @error is set.
1623 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
1627 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1628 GDBusMessage *reply;
1629 GCancellable *cancellable;
1631 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1632 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1636 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
1638 if (g_simple_async_result_propagate_error (simple, error))
1641 reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
1642 cancellable = g_object_get_data (G_OBJECT (simple), "cancellable");
1643 if (cancellable != NULL && g_cancellable_is_cancelled (cancellable))
1645 g_object_unref (reply);
1647 g_set_error_literal (error,
1649 G_IO_ERROR_CANCELLED,
1650 _("Operation was cancelled"));
1656 /* ---------------------------------------------------------------------------------------------------- */
1661 GMainContext *context;
1663 } SendMessageSyncData;
1666 send_message_with_reply_sync_cb (GDBusConnection *connection,
1670 SendMessageSyncData *data = user_data;
1671 data->res = g_object_ref (res);
1672 g_main_loop_quit (data->loop);
1676 * g_dbus_connection_send_message_with_reply_sync:
1677 * @connection: A #GDBusConnection.
1678 * @message: A #GDBusMessage.
1679 * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
1680 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1681 * @cancellable: A #GCancellable or %NULL.
1682 * @error: Return location for error or %NULL.
1684 * Synchronously sends @message to the peer represented by @connection
1685 * and blocks the calling thread until a reply is received or the
1686 * timeout is reached. See g_dbus_connection_send_message_with_reply()
1687 * for the asynchronous version of this method.
1689 * If g_dbus_message_get_serial() returns non-zero for @message, then
1690 * that value is used for the message serial number. Otherwise a
1691 * serial number will be assigned by @connection and set on @message
1692 * via g_dbus_message_set_serial(). If @out_serial is not %NULL, then
1693 * the serial number used will be written to this location prior to
1694 * submitting the message to the underlying transport.
1696 * If @connection is closed then the operation will fail with
1697 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1698 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1699 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1701 * Note that @error is only set if a local in-process error
1702 * occured. That is to say that the returned #GDBusMessage object may
1703 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
1704 * g_dbus_message_to_gerror() to transcode this to a #GError.
1706 * See <xref linkend="gdbus-server"/> and <xref
1707 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1708 * low-level API to send and receive UNIX file descriptors.
1710 * Returns: A #GDBusMessage that is the reply to @message or %NULL if @error is set.
1715 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
1716 GDBusMessage *message,
1718 volatile guint32 *out_serial,
1719 GCancellable *cancellable,
1722 SendMessageSyncData *data;
1723 GDBusMessage *reply;
1725 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1726 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1727 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
1728 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1730 data = g_new0 (SendMessageSyncData, 1);
1731 data->context = g_main_context_new ();
1732 data->loop = g_main_loop_new (data->context, FALSE);
1734 g_main_context_push_thread_default (data->context);
1736 g_dbus_connection_send_message_with_reply (connection,
1741 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
1743 g_main_loop_run (data->loop);
1744 reply = g_dbus_connection_send_message_with_reply_finish (connection,
1748 g_main_context_pop_thread_default (data->context);
1750 g_main_context_unref (data->context);
1751 g_main_loop_unref (data->loop);
1752 g_object_unref (data->res);
1758 /* ---------------------------------------------------------------------------------------------------- */
1762 GDBusMessageFilterFunction func;
1769 GDBusMessageFilterFunction filter_function;
1771 GDestroyNotify user_data_free_func;
1774 /* Called in worker's thread - we must not block */
1776 on_worker_message_received (GDBusWorker *worker,
1777 GDBusMessage *message,
1780 GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
1781 FilterCallback *filters;
1782 gboolean consumed_by_filter;
1786 //g_debug ("in on_worker_message_received");
1788 g_object_ref (connection);
1790 /* First collect the set of callback functions */
1791 CONNECTION_LOCK (connection);
1792 num_filters = connection->priv->filters->len;
1793 filters = g_new0 (FilterCallback, num_filters);
1794 for (n = 0; n < num_filters; n++)
1796 FilterData *data = connection->priv->filters->pdata[n];
1797 filters[n].func = data->filter_function;
1798 filters[n].user_data = data->user_data;
1800 CONNECTION_UNLOCK (connection);
1802 /* the call the filters in order (without holding the lock) */
1803 consumed_by_filter = FALSE;
1804 for (n = 0; n < num_filters; n++)
1806 consumed_by_filter = filters[n].func (connection,
1809 filters[n].user_data);
1810 if (consumed_by_filter)
1814 /* Standard dispatch unless the filter ate the message */
1815 if (!consumed_by_filter)
1817 GDBusMessageType message_type;
1819 message_type = g_dbus_message_get_message_type (message);
1820 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
1822 guint32 reply_serial;
1823 SendMessageData *send_message_data;
1825 reply_serial = g_dbus_message_get_reply_serial (message);
1826 CONNECTION_LOCK (connection);
1827 send_message_data = g_hash_table_lookup (connection->priv->map_method_serial_to_send_message_data,
1828 GUINT_TO_POINTER (reply_serial));
1829 if (send_message_data != NULL)
1831 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
1832 send_message_data_deliver_reply_unlocked (send_message_data, message);
1836 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
1838 CONNECTION_UNLOCK (connection);
1840 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
1842 CONNECTION_LOCK (connection);
1843 distribute_signals (connection, message);
1844 CONNECTION_UNLOCK (connection);
1846 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
1848 CONNECTION_LOCK (connection);
1849 distribute_method_call (connection, message);
1850 CONNECTION_UNLOCK (connection);
1854 g_object_unref (connection);
1858 /* Called in worker's thread */
1860 on_worker_message_about_to_be_sent (GDBusWorker *worker,
1861 GDBusMessage *message,
1864 GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
1865 FilterCallback *filters;
1866 gboolean consumed_by_filter;
1870 //g_debug ("in on_worker_message_about_to_be_sent");
1872 g_object_ref (connection);
1874 /* First collect the set of callback functions */
1875 CONNECTION_LOCK (connection);
1876 num_filters = connection->priv->filters->len;
1877 filters = g_new0 (FilterCallback, num_filters);
1878 for (n = 0; n < num_filters; n++)
1880 FilterData *data = connection->priv->filters->pdata[n];
1881 filters[n].func = data->filter_function;
1882 filters[n].user_data = data->user_data;
1884 CONNECTION_UNLOCK (connection);
1886 /* the call the filters in order (without holding the lock) */
1887 consumed_by_filter = FALSE;
1888 for (n = 0; n < num_filters; n++)
1890 consumed_by_filter = filters[n].func (connection,
1893 filters[n].user_data);
1894 if (consumed_by_filter)
1898 g_object_unref (connection);
1901 return consumed_by_filter;
1904 /* Called in worker's thread - we must not block */
1906 on_worker_closed (GDBusWorker *worker,
1907 gboolean remote_peer_vanished,
1911 GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
1913 //g_debug ("in on_worker_closed: %s", error->message);
1915 CONNECTION_LOCK (connection);
1916 if (!connection->priv->closed)
1917 set_closed_unlocked (connection, remote_peer_vanished, error);
1918 CONNECTION_UNLOCK (connection);
1921 /* ---------------------------------------------------------------------------------------------------- */
1923 /* Determines the biggest set of capabilities we can support on this connection */
1924 static GDBusCapabilityFlags
1925 get_offered_capabilities_max (GDBusConnection *connection)
1927 GDBusCapabilityFlags ret;
1928 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
1930 if (G_IS_UNIX_CONNECTION (connection->priv->stream))
1931 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
1937 initable_init (GInitable *initable,
1938 GCancellable *cancellable,
1941 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
1944 /* This method needs to be idempotent to work with the singleton
1945 * pattern. See the docs for g_initable_init(). We implement this by
1948 * Unfortunately we can't use the main lock since the on_worker_*()
1949 * callbacks above needs the lock during initialization (for message
1950 * bus connections we do a synchronous Hello() call on the bus).
1952 g_mutex_lock (connection->priv->init_lock);
1956 if (connection->priv->is_initialized)
1958 if (connection->priv->stream != NULL)
1961 g_assert (connection->priv->initialization_error != NULL);
1964 g_assert (connection->priv->initialization_error == NULL);
1966 /* The user can pass multiple (but mutally exclusive) construct
1969 * - stream (of type GIOStream)
1970 * - address (of type gchar*)
1972 * At the end of the day we end up with a non-NULL GIOStream
1973 * object in connection->priv->stream.
1975 if (connection->priv->address != NULL)
1977 g_assert (connection->priv->stream == NULL);
1979 if ((connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
1980 (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
1982 g_set_error_literal (error,
1984 G_IO_ERROR_INVALID_ARGUMENT,
1985 _("Unsupported flags encountered when constructing a client-side connection"));
1989 connection->priv->stream = g_dbus_address_get_stream_sync (connection->priv->address,
1990 NULL, /* TODO: out_guid */
1992 &connection->priv->initialization_error);
1993 if (connection->priv->stream == NULL)
1996 else if (connection->priv->stream != NULL)
2002 g_assert_not_reached ();
2005 /* Authenticate the connection */
2006 if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
2008 g_assert (!(connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
2009 g_assert (connection->priv->guid != NULL);
2010 connection->priv->auth = _g_dbus_auth_new (connection->priv->stream);
2011 if (!_g_dbus_auth_run_server (connection->priv->auth,
2012 connection->priv->authentication_observer,
2013 connection->priv->guid,
2014 (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
2015 get_offered_capabilities_max (connection),
2016 &connection->priv->capabilities,
2017 &connection->priv->crendentials,
2019 &connection->priv->initialization_error))
2022 else if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
2024 g_assert (!(connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
2025 g_assert (connection->priv->guid == NULL);
2026 connection->priv->auth = _g_dbus_auth_new (connection->priv->stream);
2027 connection->priv->guid = _g_dbus_auth_run_client (connection->priv->auth,
2028 get_offered_capabilities_max (connection),
2029 &connection->priv->capabilities,
2031 &connection->priv->initialization_error);
2032 if (connection->priv->guid == NULL)
2036 if (connection->priv->authentication_observer != NULL)
2038 g_object_unref (connection->priv->authentication_observer);
2039 connection->priv->authentication_observer = NULL;
2042 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->priv->stream)
2044 //g_debug ("haz unix fd passing powers: %d", connection->priv->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
2049 * https://bugzilla.gnome.org/show_bug.cgi?id=616458
2053 if (G_IS_SOCKET_CONNECTION (connection->priv->stream))
2055 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->priv->stream)), FALSE);
2059 connection->priv->worker = _g_dbus_worker_new (connection->priv->stream,
2060 connection->priv->capabilities,
2061 (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING),
2062 on_worker_message_received,
2063 on_worker_message_about_to_be_sent,
2067 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
2068 if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2070 GVariant *hello_result;
2072 /* we could lift this restriction by adding code in gdbusprivate.c */
2073 if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
2075 g_set_error_literal (&connection->priv->initialization_error,
2078 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
2082 hello_result = g_dbus_connection_call_sync (connection,
2083 "org.freedesktop.DBus", /* name */
2084 "/org/freedesktop/DBus", /* path */
2085 "org.freedesktop.DBus", /* interface */
2087 NULL, /* parameters */
2088 G_VARIANT_TYPE ("(s)"),
2089 G_DBUS_CALL_FLAGS_NONE,
2091 NULL, /* TODO: cancellable */
2092 &connection->priv->initialization_error);
2093 if (hello_result == NULL)
2096 g_variant_get (hello_result, "(s)", &connection->priv->bus_unique_name);
2097 g_variant_unref (hello_result);
2098 //g_debug ("unique name is `%s'", connection->priv->bus_unique_name);
2101 connection->priv->is_initialized = TRUE;
2107 g_assert (connection->priv->initialization_error != NULL);
2108 g_propagate_error (error, g_error_copy (connection->priv->initialization_error));
2111 g_mutex_unlock (connection->priv->init_lock);
2117 initable_iface_init (GInitableIface *initable_iface)
2119 initable_iface->init = initable_init;
2122 /* ---------------------------------------------------------------------------------------------------- */
2125 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
2130 /* ---------------------------------------------------------------------------------------------------- */
2133 * g_dbus_connection_new:
2134 * @stream: A #GIOStream.
2135 * @guid: The GUID to use if a authenticating as a server or %NULL.
2136 * @flags: Flags describing how to make the connection.
2137 * @observer: A #GDBusAuthObserver or %NULL.
2138 * @cancellable: A #GCancellable or %NULL.
2139 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2140 * @user_data: The data to pass to @callback.
2142 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
2143 * with the end represented by @stream.
2145 * If @observer is not %NULL it may be used to control the
2146 * authentication process.
2148 * When the operation is finished, @callback will be invoked. You can
2149 * then call g_dbus_connection_new_finish() to get the result of the
2152 * This is a asynchronous failable constructor. See
2153 * g_dbus_connection_new_sync() for the synchronous
2159 g_dbus_connection_new (GIOStream *stream,
2161 GDBusConnectionFlags flags,
2162 GDBusAuthObserver *observer,
2163 GCancellable *cancellable,
2164 GAsyncReadyCallback callback,
2167 g_return_if_fail (G_IS_IO_STREAM (stream));
2168 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2176 "authentication-observer", observer,
2181 * g_dbus_connection_new_finish:
2182 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2183 * @error: Return location for error or %NULL.
2185 * Finishes an operation started with g_dbus_connection_new().
2187 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2192 g_dbus_connection_new_finish (GAsyncResult *res,
2196 GObject *source_object;
2198 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2199 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2201 source_object = g_async_result_get_source_object (res);
2202 g_assert (source_object != NULL);
2203 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2206 g_object_unref (source_object);
2208 return G_DBUS_CONNECTION (object);
2214 * g_dbus_connection_new_sync:
2215 * @stream: A #GIOStream.
2216 * @guid: The GUID to use if a authenticating as a server or %NULL.
2217 * @flags: Flags describing how to make the connection.
2218 * @observer: A #GDBusAuthObserver or %NULL.
2219 * @cancellable: A #GCancellable or %NULL.
2220 * @error: Return location for error or %NULL.
2222 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2223 * with the end represented by @stream.
2225 * If @observer is not %NULL it may be used to control the
2226 * authentication process.
2228 * This is a synchronous failable constructor. See
2229 * g_dbus_connection_new() for the asynchronous version.
2231 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2236 g_dbus_connection_new_sync (GIOStream *stream,
2238 GDBusConnectionFlags flags,
2239 GDBusAuthObserver *observer,
2240 GCancellable *cancellable,
2243 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2244 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2245 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2251 "authentication-observer", observer,
2255 /* ---------------------------------------------------------------------------------------------------- */
2258 * g_dbus_connection_new_for_address:
2259 * @address: A D-Bus address.
2260 * @flags: Flags describing how to make the connection.
2261 * @observer: A #GDBusAuthObserver or %NULL.
2262 * @cancellable: A #GCancellable or %NULL.
2263 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2264 * @user_data: The data to pass to @callback.
2266 * Asynchronously connects and sets up a D-Bus client connection for
2267 * exchanging D-Bus messages with an endpoint specified by @address
2268 * which must be in the D-Bus address format.
2270 * This constructor can only be used to initiate client-side
2271 * connections - use g_dbus_connection_new() if you need to act as the
2272 * server. In particular, @flags cannot contain the
2273 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2274 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2276 * When the operation is finished, @callback will be invoked. You can
2277 * then call g_dbus_connection_new_finish() to get the result of the
2280 * If @observer is not %NULL it may be used to control the
2281 * authentication process.
2283 * This is a asynchronous failable constructor. See
2284 * g_dbus_connection_new_for_address_sync() for the synchronous
2290 g_dbus_connection_new_for_address (const gchar *address,
2291 GDBusConnectionFlags flags,
2292 GDBusAuthObserver *observer,
2293 GCancellable *cancellable,
2294 GAsyncReadyCallback callback,
2297 g_return_if_fail (address != NULL);
2298 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2305 "authentication-observer", observer,
2310 * g_dbus_connection_new_for_address_finish:
2311 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2312 * @error: Return location for error or %NULL.
2314 * Finishes an operation started with g_dbus_connection_new_for_address().
2316 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2321 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
2325 GObject *source_object;
2327 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2328 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2330 source_object = g_async_result_get_source_object (res);
2331 g_assert (source_object != NULL);
2332 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2335 g_object_unref (source_object);
2337 return G_DBUS_CONNECTION (object);
2343 * g_dbus_connection_new_for_address_sync:
2344 * @address: A D-Bus address.
2345 * @flags: Flags describing how to make the connection.
2346 * @observer: A #GDBusAuthObserver or %NULL.
2347 * @cancellable: A #GCancellable or %NULL.
2348 * @error: Return location for error or %NULL.
2350 * Synchronously connects and sets up a D-Bus client connection for
2351 * exchanging D-Bus messages with an endpoint specified by @address
2352 * which must be in the D-Bus address format.
2354 * This constructor can only be used to initiate client-side
2355 * connections - use g_dbus_connection_new_sync() if you need to act
2356 * as the server. In particular, @flags cannot contain the
2357 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2358 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2360 * This is a synchronous failable constructor. See
2361 * g_dbus_connection_new_for_address() for the asynchronous version.
2363 * If @observer is not %NULL it may be used to control the
2364 * authentication process.
2366 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2371 g_dbus_connection_new_for_address_sync (const gchar *address,
2372 GDBusConnectionFlags flags,
2373 GDBusAuthObserver *observer,
2374 GCancellable *cancellable,
2377 g_return_val_if_fail (address != NULL, NULL);
2378 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2379 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2384 "authentication-observer", observer,
2388 /* ---------------------------------------------------------------------------------------------------- */
2391 * g_dbus_connection_set_exit_on_close:
2392 * @connection: A #GDBusConnection.
2393 * @exit_on_close: Whether the process should be terminated
2394 * when @connection is closed by the remote peer.
2396 * Sets whether the process should be terminated when @connection is
2397 * closed by the remote peer. See #GDBusConnection:exit-on-close for
2403 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
2404 gboolean exit_on_close)
2406 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2407 connection->priv->exit_on_close = exit_on_close;
2411 * g_dbus_connection_get_exit_on_close:
2412 * @connection: A #GDBusConnection.
2414 * Gets whether the process is terminated when @connection is
2415 * closed by the remote peer. See
2416 * #GDBusConnection:exit-on-close for more details.
2418 * Returns: Whether the process is terminated when @connection is
2419 * closed by the remote peer.
2424 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
2426 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2427 return connection->priv->exit_on_close;
2431 * g_dbus_connection_get_guid:
2432 * @connection: A #GDBusConnection.
2434 * The GUID of the peer performing the role of server when
2435 * authenticating. See #GDBusConnection:guid for more details.
2437 * Returns: The GUID. Do not free this string, it is owned by
2443 g_dbus_connection_get_guid (GDBusConnection *connection)
2445 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2446 return connection->priv->guid;
2450 * g_dbus_connection_get_unique_name:
2451 * @connection: A #GDBusConnection.
2453 * Gets the unique name of @connection as assigned by the message
2454 * bus. This can also be used to figure out if @connection is a
2455 * message bus connection.
2457 * Returns: The unique name or %NULL if @connection is not a message
2458 * bus connection. Do not free this string, it is owned by
2464 g_dbus_connection_get_unique_name (GDBusConnection *connection)
2466 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2467 return connection->priv->bus_unique_name;
2471 * g_dbus_connection_get_peer_credentials:
2472 * @connection: A #GDBusConnection.
2474 * Gets the credentials of the authenticated peer. This will always
2475 * return %NULL unless @connection acted as a server
2476 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
2477 * when set up and the client passed credentials as part of the
2478 * authentication process.
2480 * In a message bus setup, the message bus is always the server and
2481 * each application is a client. So this method will always return
2482 * %NULL for message bus clients.
2484 * Returns: A #GCredentials or %NULL if not available. Do not free
2485 * this object, it is owned by @connection.
2490 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
2492 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2493 return connection->priv->crendentials;
2496 /* ---------------------------------------------------------------------------------------------------- */
2498 static guint _global_filter_id = 1;
2501 * g_dbus_connection_add_filter:
2502 * @connection: A #GDBusConnection.
2503 * @filter_function: A filter function.
2504 * @user_data: User data to pass to @filter_function.
2505 * @user_data_free_func: Function to free @user_data with when filter
2506 * is removed or %NULL.
2508 * Adds a message filter. Filters are handlers that are run on all
2509 * incoming and outgoing messages, prior to standard dispatch. Filters
2510 * are run in the order that they were added. The same handler can be
2511 * added as a filter more than once, in which case it will be run more
2512 * than once. Filters added during a filter callback won't be run on
2513 * the message being processed.
2515 * Note that filters are run in a dedicated message handling thread so
2516 * they can't block and, generally, can't do anything but signal a
2517 * worker thread. Also note that filters are rarely needed - use API
2518 * such as g_dbus_connection_send_message_with_reply(),
2519 * g_dbus_connection_signal_subscribe() or
2520 * g_dbus_connection_call() instead.
2522 * If a filter consumes an incoming message (by returning %TRUE), the
2523 * message is not dispatched anywhere else - not even the standard
2524 * dispatch machinery (that API such as
2525 * g_dbus_connection_signal_subscribe() and
2526 * g_dbus_connection_send_message_with_reply() relies on) will see the
2527 * message. Similary, if a filter consumes an outgoing message, the
2528 * message will not be sent to the other peer.
2530 * Returns: A filter identifier that can be used with
2531 * g_dbus_connection_remove_filter().
2536 g_dbus_connection_add_filter (GDBusConnection *connection,
2537 GDBusMessageFilterFunction filter_function,
2539 GDestroyNotify user_data_free_func)
2543 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2544 g_return_val_if_fail (filter_function != NULL, 0);
2546 CONNECTION_LOCK (connection);
2547 data = g_new0 (FilterData, 1);
2548 data->id = _global_filter_id++; /* TODO: overflow etc. */
2549 data->filter_function = filter_function;
2550 data->user_data = user_data;
2551 data->user_data_free_func = user_data_free_func;
2552 g_ptr_array_add (connection->priv->filters, data);
2553 CONNECTION_UNLOCK (connection);
2558 /* only called from finalize(), removes all filters */
2560 purge_all_filters (GDBusConnection *connection)
2563 for (n = 0; n < connection->priv->filters->len; n++)
2565 FilterData *data = connection->priv->filters->pdata[n];
2566 if (data->user_data_free_func != NULL)
2567 data->user_data_free_func (data->user_data);
2573 * g_dbus_connection_remove_filter:
2574 * @connection: a #GDBusConnection
2575 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
2582 g_dbus_connection_remove_filter (GDBusConnection *connection,
2586 FilterData *to_destroy;
2588 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2590 CONNECTION_LOCK (connection);
2592 for (n = 0; n < connection->priv->filters->len; n++)
2594 FilterData *data = connection->priv->filters->pdata[n];
2595 if (data->id == filter_id)
2597 g_ptr_array_remove_index (connection->priv->filters, n);
2602 CONNECTION_UNLOCK (connection);
2604 /* do free without holding lock */
2605 if (to_destroy != NULL)
2607 if (to_destroy->user_data_free_func != NULL)
2608 to_destroy->user_data_free_func (to_destroy->user_data);
2609 g_free (to_destroy);
2613 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
2617 /* ---------------------------------------------------------------------------------------------------- */
2623 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
2624 gchar *interface_name;
2628 GArray *subscribers;
2633 GDBusSignalCallback callback;
2635 GDestroyNotify user_data_free_func;
2637 GMainContext *context;
2641 signal_data_free (SignalData *signal_data)
2643 g_free (signal_data->rule);
2644 g_free (signal_data->sender);
2645 g_free (signal_data->sender_unique_name);
2646 g_free (signal_data->interface_name);
2647 g_free (signal_data->member);
2648 g_free (signal_data->object_path);
2649 g_free (signal_data->arg0);
2650 g_array_free (signal_data->subscribers, TRUE);
2651 g_free (signal_data);
2655 args_to_rule (const gchar *sender,
2656 const gchar *interface_name,
2657 const gchar *member,
2658 const gchar *object_path,
2663 rule = g_string_new ("type='signal'");
2665 g_string_append_printf (rule, ",sender='%s'", sender);
2666 if (interface_name != NULL)
2667 g_string_append_printf (rule, ",interface='%s'", interface_name);
2669 g_string_append_printf (rule, ",member='%s'", member);
2670 if (object_path != NULL)
2671 g_string_append_printf (rule, ",path='%s'", object_path);
2673 g_string_append_printf (rule, ",arg0='%s'", arg0);
2675 return g_string_free (rule, FALSE);
2678 static guint _global_subscriber_id = 1;
2679 static guint _global_registration_id = 1;
2680 static guint _global_subtree_registration_id = 1;
2682 /* ---------------------------------------------------------------------------------------------------- */
2684 /* must hold lock when calling */
2686 add_match_rule (GDBusConnection *connection,
2687 const gchar *match_rule)
2690 GDBusMessage *message;
2692 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
2693 "/org/freedesktop/DBus", /* path */
2694 "org.freedesktop.DBus", /* interface */
2696 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
2698 if (!g_dbus_connection_send_message_unlocked (connection,
2703 g_critical ("Error while sending AddMatch() message: %s", error->message);
2704 g_error_free (error);
2706 g_object_unref (message);
2709 /* ---------------------------------------------------------------------------------------------------- */
2711 /* must hold lock when calling */
2713 remove_match_rule (GDBusConnection *connection,
2714 const gchar *match_rule)
2717 GDBusMessage *message;
2719 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
2720 "/org/freedesktop/DBus", /* path */
2721 "org.freedesktop.DBus", /* interface */
2723 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
2726 if (!g_dbus_connection_send_message_unlocked (connection,
2731 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
2732 g_error_free (error);
2734 g_object_unref (message);
2737 /* ---------------------------------------------------------------------------------------------------- */
2740 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
2742 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
2743 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
2744 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
2745 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
2746 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
2749 /* ---------------------------------------------------------------------------------------------------- */
2752 * g_dbus_connection_signal_subscribe:
2753 * @connection: A #GDBusConnection.
2754 * @sender: Sender name to match on (unique or well-known name) or %NULL to listen from all senders.
2755 * @interface_name: D-Bus interface name to match on or %NULL to match on all interfaces.
2756 * @member: D-Bus signal name to match on or %NULL to match on all signals.
2757 * @object_path: Object path to match on or %NULL to match on all object paths.
2758 * @arg0: Contents of first string argument to match on or %NULL to match on all kinds of arguments.
2759 * @callback: Callback to invoke when there is a signal matching the requested data.
2760 * @user_data: User data to pass to @callback.
2761 * @user_data_free_func: Function to free @user_data with when subscription is removed or %NULL.
2763 * Subscribes to signals on @connection and invokes @callback with a
2764 * whenever the signal is received. Note that @callback
2765 * will be invoked in the <link
2766 * linkend="g-main-context-push-thread-default">thread-default main
2767 * loop</link> of the thread you are calling this method from.
2769 * If @connection is not a message bus connection, @sender must be
2772 * If @sender is a well-known name note that @callback is invoked with
2773 * the unique name for the owner of @sender, not the well-known name
2774 * as one would expect. This is because the message bus rewrites the
2775 * name. As such, to avoid certain race conditions, users should be
2776 * tracking the name owner of the well-known name and use that when
2777 * processing the received signal.
2779 * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
2784 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
2785 const gchar *sender,
2786 const gchar *interface_name,
2787 const gchar *member,
2788 const gchar *object_path,
2790 GDBusSignalCallback callback,
2792 GDestroyNotify user_data_free_func)
2795 SignalData *signal_data;
2796 SignalSubscriber subscriber;
2797 GPtrArray *signal_data_array;
2798 const gchar *sender_unique_name;
2800 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
2801 * an OOM condition. We might want to change that but that would involve making
2802 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
2803 * handle that. And there's really no sensible way of handling this short of retrying
2804 * to add the match rule... and then there's the little thing that, hey, maybe there's
2805 * a reason the bus in an OOM condition.
2807 * Doable, but not really sure it's worth it...
2810 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2811 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
2812 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
2813 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
2814 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
2815 g_return_val_if_fail (callback != NULL, 0);
2817 CONNECTION_LOCK (connection);
2819 rule = args_to_rule (sender, interface_name, member, object_path, arg0);
2821 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
2822 sender_unique_name = sender;
2824 sender_unique_name = "";
2826 subscriber.callback = callback;
2827 subscriber.user_data = user_data;
2828 subscriber.user_data_free_func = user_data_free_func;
2829 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
2830 subscriber.context = g_main_context_get_thread_default ();
2831 if (subscriber.context != NULL)
2832 g_main_context_ref (subscriber.context);
2834 /* see if we've already have this rule */
2835 signal_data = g_hash_table_lookup (connection->priv->map_rule_to_signal_data, rule);
2836 if (signal_data != NULL)
2838 g_array_append_val (signal_data->subscribers, subscriber);
2843 signal_data = g_new0 (SignalData, 1);
2844 signal_data->rule = rule;
2845 signal_data->sender = g_strdup (sender);
2846 signal_data->sender_unique_name = g_strdup (sender_unique_name);
2847 signal_data->interface_name = g_strdup (interface_name);
2848 signal_data->member = g_strdup (member);
2849 signal_data->object_path = g_strdup (object_path);
2850 signal_data->arg0 = g_strdup (arg0);
2851 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2852 g_array_append_val (signal_data->subscribers, subscriber);
2854 g_hash_table_insert (connection->priv->map_rule_to_signal_data,
2858 /* Add the match rule to the bus...
2860 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
2861 * always send such messages to us.
2863 if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2865 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
2866 add_match_rule (connection, signal_data->rule);
2869 signal_data_array = g_hash_table_lookup (connection->priv->map_sender_unique_name_to_signal_data_array,
2870 signal_data->sender_unique_name);
2871 if (signal_data_array == NULL)
2873 signal_data_array = g_ptr_array_new ();
2874 g_hash_table_insert (connection->priv->map_sender_unique_name_to_signal_data_array,
2875 g_strdup (signal_data->sender_unique_name),
2878 g_ptr_array_add (signal_data_array, signal_data);
2881 g_hash_table_insert (connection->priv->map_id_to_signal_data,
2882 GUINT_TO_POINTER (subscriber.id),
2885 CONNECTION_UNLOCK (connection);
2887 return subscriber.id;
2890 /* ---------------------------------------------------------------------------------------------------- */
2892 /* must hold lock when calling this */
2894 unsubscribe_id_internal (GDBusConnection *connection,
2895 guint subscription_id,
2896 GArray *out_removed_subscribers)
2898 SignalData *signal_data;
2899 GPtrArray *signal_data_array;
2902 signal_data = g_hash_table_lookup (connection->priv->map_id_to_signal_data,
2903 GUINT_TO_POINTER (subscription_id));
2904 if (signal_data == NULL)
2906 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
2910 for (n = 0; n < signal_data->subscribers->len; n++)
2912 SignalSubscriber *subscriber;
2914 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
2915 if (subscriber->id != subscription_id)
2918 g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_signal_data,
2919 GUINT_TO_POINTER (subscription_id)));
2920 g_array_append_val (out_removed_subscribers, *subscriber);
2921 g_array_remove_index (signal_data->subscribers, n);
2923 if (signal_data->subscribers->len == 0)
2925 g_warn_if_fail (g_hash_table_remove (connection->priv->map_rule_to_signal_data, signal_data->rule));
2927 signal_data_array = g_hash_table_lookup (connection->priv->map_sender_unique_name_to_signal_data_array,
2928 signal_data->sender_unique_name);
2929 g_warn_if_fail (signal_data_array != NULL);
2930 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
2932 if (signal_data_array->len == 0)
2934 g_warn_if_fail (g_hash_table_remove (connection->priv->map_sender_unique_name_to_signal_data_array,
2935 signal_data->sender_unique_name));
2938 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
2939 if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2941 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
2942 if (!connection->priv->closed)
2943 remove_match_rule (connection, signal_data->rule);
2945 signal_data_free (signal_data);
2951 g_assert_not_reached ();
2958 * g_dbus_connection_signal_unsubscribe:
2959 * @connection: A #GDBusConnection.
2960 * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
2962 * Unsubscribes from signals.
2967 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
2968 guint subscription_id)
2970 GArray *subscribers;
2973 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2975 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
2977 CONNECTION_LOCK (connection);
2978 unsubscribe_id_internal (connection,
2981 CONNECTION_UNLOCK (connection);
2984 g_assert (subscribers->len == 0 || subscribers->len == 1);
2986 /* call GDestroyNotify without lock held */
2987 for (n = 0; n < subscribers->len; n++)
2989 SignalSubscriber *subscriber;
2990 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
2991 if (subscriber->user_data_free_func != NULL)
2992 subscriber->user_data_free_func (subscriber->user_data);
2993 if (subscriber->context != NULL)
2994 g_main_context_unref (subscriber->context);
2997 g_array_free (subscribers, TRUE);
3000 /* ---------------------------------------------------------------------------------------------------- */
3004 guint subscription_id;
3005 GDBusSignalCallback callback;
3007 GDBusMessage *message;
3008 GDBusConnection *connection;
3009 const gchar *sender;
3011 const gchar *interface;
3012 const gchar *member;
3015 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
3019 emit_signal_instance_in_idle_cb (gpointer data)
3021 SignalInstance *signal_instance = data;
3022 GVariant *parameters;
3023 gboolean has_subscription;
3025 parameters = g_dbus_message_get_body (signal_instance->message);
3026 if (parameters == NULL)
3028 parameters = g_variant_new ("()");
3029 g_variant_ref_sink (parameters);
3033 g_variant_ref_sink (parameters);
3037 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
3038 signal_instance->subscription_id,
3039 signal_instance->sender,
3040 signal_instance->path,
3041 signal_instance->interface,
3042 signal_instance->member,
3043 g_variant_print (parameters, TRUE));
3046 /* Careful here, don't do the callback if we no longer has the subscription */
3047 CONNECTION_LOCK (signal_instance->connection);
3048 has_subscription = FALSE;
3049 if (g_hash_table_lookup (signal_instance->connection->priv->map_id_to_signal_data,
3050 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
3051 has_subscription = TRUE;
3052 CONNECTION_UNLOCK (signal_instance->connection);
3054 if (has_subscription)
3055 signal_instance->callback (signal_instance->connection,
3056 signal_instance->sender,
3057 signal_instance->path,
3058 signal_instance->interface,
3059 signal_instance->member,
3061 signal_instance->user_data);
3063 if (parameters != NULL)
3064 g_variant_unref (parameters);
3070 signal_instance_free (SignalInstance *signal_instance)
3072 g_object_unref (signal_instance->message);
3073 g_object_unref (signal_instance->connection);
3074 g_free (signal_instance);
3077 /* called in message handler thread WITH lock held */
3079 schedule_callbacks (GDBusConnection *connection,
3080 GPtrArray *signal_data_array,
3081 GDBusMessage *message,
3082 const gchar *sender)
3085 const gchar *interface;
3086 const gchar *member;
3095 interface = g_dbus_message_get_interface (message);
3096 member = g_dbus_message_get_member (message);
3097 path = g_dbus_message_get_path (message);
3098 arg0 = g_dbus_message_get_arg0 (message);
3101 g_print ("In schedule_callbacks:\n"
3103 " interface = `%s'\n"
3114 /* TODO: if this is slow, then we can change signal_data_array into
3115 * map_object_path_to_signal_data_array or something.
3117 for (n = 0; n < signal_data_array->len; n++)
3119 SignalData *signal_data = signal_data_array->pdata[n];
3121 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
3124 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
3127 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
3130 if (signal_data->arg0 != NULL && g_strcmp0 (signal_data->arg0, arg0) != 0)
3133 for (m = 0; m < signal_data->subscribers->len; m++)
3135 SignalSubscriber *subscriber;
3136 GSource *idle_source;
3137 SignalInstance *signal_instance;
3139 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
3141 signal_instance = g_new0 (SignalInstance, 1);
3142 signal_instance->subscription_id = subscriber->id;
3143 signal_instance->callback = subscriber->callback;
3144 signal_instance->user_data = subscriber->user_data;
3145 signal_instance->message = g_object_ref (message);
3146 signal_instance->connection = g_object_ref (connection);
3147 signal_instance->sender = sender;
3148 signal_instance->path = path;
3149 signal_instance->interface = interface;
3150 signal_instance->member = member;
3152 idle_source = g_idle_source_new ();
3153 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3154 g_source_set_callback (idle_source,
3155 emit_signal_instance_in_idle_cb,
3157 (GDestroyNotify) signal_instance_free);
3158 g_source_attach (idle_source, subscriber->context);
3159 g_source_unref (idle_source);
3164 /* called in message handler thread with lock held */
3166 distribute_signals (GDBusConnection *connection,
3167 GDBusMessage *message)
3169 GPtrArray *signal_data_array;
3170 const gchar *sender;
3172 sender = g_dbus_message_get_sender (message);
3174 if (G_UNLIKELY (_g_dbus_debug_signal ()))
3176 _g_dbus_debug_print_lock ();
3177 g_print ("========================================================================\n"
3178 "GDBus-debug:Signal:\n"
3179 " >>>> SIGNAL %s.%s\n"
3181 " sent by name %s\n",
3182 g_dbus_message_get_interface (message),
3183 g_dbus_message_get_member (message),
3184 g_dbus_message_get_path (message),
3185 sender != NULL ? sender : "(none)");
3186 _g_dbus_debug_print_unlock ();
3189 /* collect subscribers that match on sender */
3192 signal_data_array = g_hash_table_lookup (connection->priv->map_sender_unique_name_to_signal_data_array, sender);
3193 if (signal_data_array != NULL)
3194 schedule_callbacks (connection, signal_data_array, message, sender);
3197 /* collect subscribers not matching on sender */
3198 signal_data_array = g_hash_table_lookup (connection->priv->map_sender_unique_name_to_signal_data_array, "");
3199 if (signal_data_array != NULL)
3200 schedule_callbacks (connection, signal_data_array, message, sender);
3203 /* ---------------------------------------------------------------------------------------------------- */
3205 /* only called from finalize(), removes all subscriptions */
3207 purge_all_signal_subscriptions (GDBusConnection *connection)
3209 GHashTableIter iter;
3212 GArray *subscribers;
3215 ids = g_array_new (FALSE, FALSE, sizeof (guint));
3216 g_hash_table_iter_init (&iter, connection->priv->map_id_to_signal_data);
3217 while (g_hash_table_iter_next (&iter, &key, NULL))
3219 guint subscription_id = GPOINTER_TO_UINT (key);
3220 g_array_append_val (ids, subscription_id);
3223 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3224 for (n = 0; n < ids->len; n++)
3226 guint subscription_id = g_array_index (ids, guint, n);
3227 unsubscribe_id_internal (connection,
3231 g_array_free (ids, TRUE);
3233 /* call GDestroyNotify without lock held */
3234 for (n = 0; n < subscribers->len; n++)
3236 SignalSubscriber *subscriber;
3237 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3238 if (subscriber->user_data_free_func != NULL)
3239 subscriber->user_data_free_func (subscriber->user_data);
3240 if (subscriber->context != NULL)
3241 g_main_context_unref (subscriber->context);
3244 g_array_free (subscribers, TRUE);
3247 /* ---------------------------------------------------------------------------------------------------- */
3249 struct ExportedObject
3252 GDBusConnection *connection;
3254 /* maps gchar* -> ExportedInterface* */
3255 GHashTable *map_if_name_to_ei;
3258 /* only called with lock held */
3260 exported_object_free (ExportedObject *eo)
3262 g_free (eo->object_path);
3263 g_hash_table_unref (eo->map_if_name_to_ei);
3272 gchar *interface_name;
3273 const GDBusInterfaceVTable *vtable;
3274 const GDBusInterfaceInfo *interface_info;
3276 GMainContext *context;
3278 GDestroyNotify user_data_free_func;
3279 } ExportedInterface;
3281 /* called with lock held */
3283 exported_interface_free (ExportedInterface *ei)
3285 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
3287 if (ei->user_data_free_func != NULL)
3288 /* TODO: push to thread-default mainloop */
3289 ei->user_data_free_func (ei->user_data);
3291 if (ei->context != NULL)
3292 g_main_context_unref (ei->context);
3294 g_free (ei->interface_name);
3298 /* ---------------------------------------------------------------------------------------------------- */
3300 /* Convenience function to check if @registration_id (if not zero) or
3301 * @subtree_registration_id (if not zero) has been unregistered. If
3302 * so, returns %TRUE.
3304 * Caller must *not* hold lock.
3307 has_object_been_unregistered (GDBusConnection *connection,
3308 guint registration_id,
3309 guint subtree_registration_id)
3313 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3317 CONNECTION_LOCK (connection);
3318 if (registration_id != 0 && g_hash_table_lookup (connection->priv->map_id_to_ei,
3319 GUINT_TO_POINTER (registration_id)) == NULL)
3323 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->priv->map_id_to_es,
3324 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
3328 CONNECTION_UNLOCK (connection);
3333 /* ---------------------------------------------------------------------------------------------------- */
3337 GDBusConnection *connection;
3338 GDBusMessage *message;
3340 const gchar *property_name;
3341 const GDBusInterfaceVTable *vtable;
3342 const GDBusInterfaceInfo *interface_info;
3343 const GDBusPropertyInfo *property_info;
3344 guint registration_id;
3345 guint subtree_registration_id;
3349 property_data_free (PropertyData *data)
3351 g_object_unref (data->connection);
3352 g_object_unref (data->message);
3356 /* called in thread where object was registered - no locks held */
3358 invoke_get_property_in_idle_cb (gpointer _data)
3360 PropertyData *data = _data;
3363 GDBusMessage *reply;
3365 if (has_object_been_unregistered (data->connection,
3366 data->registration_id,
3367 data->subtree_registration_id))
3369 reply = g_dbus_message_new_method_error (data->message,
3370 "org.freedesktop.DBus.Error.UnknownMethod",
3371 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
3372 g_dbus_message_get_path (data->message));
3373 g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3374 g_object_unref (reply);
3379 value = data->vtable->get_property (data->connection,
3380 g_dbus_message_get_sender (data->message),
3381 g_dbus_message_get_path (data->message),
3382 data->interface_info->name,
3383 data->property_name,
3390 g_assert_no_error (error);
3392 g_variant_ref_sink (value);
3393 reply = g_dbus_message_new_method_reply (data->message);
3394 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
3395 g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3396 g_variant_unref (value);
3397 g_object_unref (reply);
3401 gchar *dbus_error_name;
3402 g_assert (error != NULL);
3403 dbus_error_name = g_dbus_error_encode_gerror (error);
3404 reply = g_dbus_message_new_method_error_literal (data->message,
3407 g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3408 g_free (dbus_error_name);
3409 g_error_free (error);
3410 g_object_unref (reply);
3417 /* called in thread where object was registered - no locks held */
3419 invoke_set_property_in_idle_cb (gpointer _data)
3421 PropertyData *data = _data;
3423 GDBusMessage *reply;
3429 g_variant_get (g_dbus_message_get_body (data->message),
3435 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
3436 * of the given value is wrong
3438 if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
3440 reply = g_dbus_message_new_method_error (data->message,
3441 "org.freedesktop.DBus.Error.InvalidArgs",
3442 _("Error setting property `%s': Expected type `%s' but got `%s'"),
3443 data->property_info->name,
3444 data->property_info->signature,
3445 g_variant_get_type_string (value));
3449 if (!data->vtable->set_property (data->connection,
3450 g_dbus_message_get_sender (data->message),
3451 g_dbus_message_get_path (data->message),
3452 data->interface_info->name,
3453 data->property_name,
3458 gchar *dbus_error_name;
3459 g_assert (error != NULL);
3460 dbus_error_name = g_dbus_error_encode_gerror (error);
3461 reply = g_dbus_message_new_method_error_literal (data->message,
3464 g_free (dbus_error_name);
3465 g_error_free (error);
3469 reply = g_dbus_message_new_method_reply (data->message);
3473 g_assert (reply != NULL);
3474 g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3475 g_object_unref (reply);
3480 /* called with lock held */
3482 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
3483 GDBusMessage *message,
3484 guint registration_id,
3485 guint subtree_registration_id,
3487 const GDBusInterfaceInfo *interface_info,
3488 const GDBusInterfaceVTable *vtable,
3489 GMainContext *main_context,
3493 const char *interface_name;
3494 const char *property_name;
3495 const GDBusPropertyInfo *property_info;
3496 GSource *idle_source;
3497 PropertyData *property_data;
3498 GDBusMessage *reply;
3503 g_variant_get (g_dbus_message_get_body (message),
3508 g_variant_get (g_dbus_message_get_body (message),
3517 if (vtable == NULL || vtable->get_property == NULL)
3522 if (vtable == NULL || vtable->set_property == NULL)
3526 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
3528 property_info = NULL;
3530 /* TODO: the cost of this is O(n) - it might be worth caching the result */
3531 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
3532 if (property_info == NULL)
3534 reply = g_dbus_message_new_method_error (message,
3535 "org.freedesktop.DBus.Error.InvalidArgs",
3536 _("No such property `%s'"),
3538 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3539 g_object_unref (reply);
3544 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
3546 reply = g_dbus_message_new_method_error (message,
3547 "org.freedesktop.DBus.Error.InvalidArgs",
3548 _("Property `%s' is not readable"),
3550 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3551 g_object_unref (reply);
3555 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
3557 reply = g_dbus_message_new_method_error (message,
3558 "org.freedesktop.DBus.Error.InvalidArgs",
3559 _("Property `%s' is not writable"),
3561 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
3562 g_object_unref (reply);
3567 /* ok, got the property info - call user code in an idle handler */
3568 property_data = g_new0 (PropertyData, 1);
3569 property_data->connection = g_object_ref (connection);
3570 property_data->message = g_object_ref (message);
3571 property_data->user_data = user_data;
3572 property_data->property_name = property_name;
3573 property_data->vtable = vtable;
3574 property_data->interface_info = interface_info;
3575 property_data->property_info = property_info;
3576 property_data->registration_id = registration_id;
3577 property_data->subtree_registration_id = subtree_registration_id;
3579 idle_source = g_idle_source_new ();
3580 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3581 g_source_set_callback (idle_source,
3582 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
3584 (GDestroyNotify) property_data_free);
3585 g_source_attach (idle_source, main_context);
3586 g_source_unref (idle_source);
3594 /* called with lock held */
3596 handle_getset_property (GDBusConnection *connection,
3598 GDBusMessage *message,
3601 ExportedInterface *ei;
3603 const char *interface_name;
3604 const char *property_name;
3609 g_variant_get (g_dbus_message_get_body (message),
3614 g_variant_get (g_dbus_message_get_body (message),
3620 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
3621 * no such interface registered
3623 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3626 GDBusMessage *reply;
3627 reply = g_dbus_message_new_method_error (message,
3628 "org.freedesktop.DBus.Error.InvalidArgs",
3629 _("No such interface `%s'"),
3631 g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
3632 g_object_unref (reply);
3637 handled = validate_and_maybe_schedule_property_getset (eo->connection,
3650 /* ---------------------------------------------------------------------------------------------------- */
3654 GDBusConnection *connection;
3655 GDBusMessage *message;
3657 const GDBusInterfaceVTable *vtable;
3658 const GDBusInterfaceInfo *interface_info;
3659 guint registration_id;
3660 guint subtree_registration_id;
3661 } PropertyGetAllData;
3664 property_get_all_data_free (PropertyData *data)
3666 g_object_unref (data->connection);
3667 g_object_unref (data->message);
3671 /* called in thread where object was registered - no locks held */
3673 invoke_get_all_properties_in_idle_cb (gpointer _data)
3675 PropertyGetAllData *data = _data;
3676 GVariantBuilder builder;
3678 GDBusMessage *reply;
3681 if (has_object_been_unregistered (data->connection,
3682 data->registration_id,
3683 data->subtree_registration_id))
3685 reply = g_dbus_message_new_method_error (data->message,
3686 "org.freedesktop.DBus.Error.UnknownMethod",
3687 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
3688 g_dbus_message_get_path (data->message));
3689 g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3690 g_object_unref (reply);
3696 /* TODO: Right now we never fail this call - we just omit values if
3697 * a get_property() call is failing.
3699 * We could fail the whole call if just a single get_property() call
3700 * returns an error. We need clarification in the D-Bus spec about this.
3702 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
3703 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
3704 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
3706 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
3709 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
3712 value = data->vtable->get_property (data->connection,
3713 g_dbus_message_get_sender (data->message),
3714 g_dbus_message_get_path (data->message),
3715 data->interface_info->name,
3716 property_info->name,
3723 g_variant_builder_add (&builder,
3725 property_info->name,
3728 g_variant_builder_close (&builder);
3730 reply = g_dbus_message_new_method_reply (data->message);
3731 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
3732 g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
3733 g_object_unref (reply);
3739 /* called with lock held */
3741 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
3742 GDBusMessage *message,
3743 guint registration_id,
3744 guint subtree_registration_id,
3745 const GDBusInterfaceInfo *interface_info,
3746 const GDBusInterfaceVTable *vtable,
3747 GMainContext *main_context,
3751 const char *interface_name;
3752 GSource *idle_source;
3753 PropertyGetAllData *property_get_all_data;
3757 g_variant_get (g_dbus_message_get_body (message),
3761 if (vtable == NULL || vtable->get_property == NULL)
3764 /* ok, got the property info - call user in an idle handler */
3765 property_get_all_data = g_new0 (PropertyGetAllData, 1);
3766 property_get_all_data->connection = g_object_ref (connection);
3767 property_get_all_data->message = g_object_ref (message);
3768 property_get_all_data->user_data = user_data;
3769 property_get_all_data->vtable = vtable;
3770 property_get_all_data->interface_info = interface_info;
3771 property_get_all_data->registration_id = registration_id;
3772 property_get_all_data->subtree_registration_id = subtree_registration_id;
3774 idle_source = g_idle_source_new ();
3775 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3776 g_source_set_callback (idle_source,
3777 invoke_get_all_properties_in_idle_cb,
3778 property_get_all_data,
3779 (GDestroyNotify) property_get_all_data_free);
3780 g_source_attach (idle_source, main_context);
3781 g_source_unref (idle_source);
3789 /* called with lock held */
3791 handle_get_all_properties (GDBusConnection *connection,
3793 GDBusMessage *message)
3795 ExportedInterface *ei;
3797 const char *interface_name;
3801 g_variant_get (g_dbus_message_get_body (message),
3805 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
3806 * no such interface registered
3808 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3811 GDBusMessage *reply;
3812 reply = g_dbus_message_new_method_error (message,
3813 "org.freedesktop.DBus.Error.InvalidArgs",
3814 _("No such interface"),
3816 g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
3817 g_object_unref (reply);
3822 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
3834 /* ---------------------------------------------------------------------------------------------------- */
3836 static const gchar introspect_header[] =
3837 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
3838 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
3839 "<!-- GDBus " PACKAGE_VERSION " -->\n"
3842 static const gchar introspect_tail[] =
3845 static const gchar introspect_standard_interfaces[] =
3846 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
3847 " <method name=\"Get\">\n"
3848 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3849 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
3850 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
3852 " <method name=\"GetAll\">\n"
3853 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3854 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
3856 " <method name=\"Set\">\n"
3857 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
3858 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
3859 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
3861 " <signal name=\"PropertiesChanged\">\n"
3862 " <arg type=\"s\" name=\"interface_name\"/>\n"
3863 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
3864 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
3867 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
3868 " <method name=\"Introspect\">\n"
3869 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
3872 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
3873 " <method name=\"Ping\"/>\n"
3874 " <method name=\"GetMachineId\">\n"
3875 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
3880 introspect_append_header (GString *s)
3882 g_string_append (s, introspect_header);
3886 introspect_append_standard_interfaces (GString *s)
3888 g_string_append (s, introspect_standard_interfaces);
3892 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
3894 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
3900 begin = object_path + path_len;
3901 end = strchr (begin, '/');
3903 s = g_strndup (begin, end - begin);
3905 s = g_strdup (begin);
3907 if (g_hash_table_lookup (set, s) == NULL)
3908 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
3914 /* TODO: we want a nicer public interface for this */
3916 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
3921 GHashTableIter hash_iter;
3922 const gchar *object_path;
3928 CONNECTION_ENSURE_LOCK (connection);
3930 path_len = strlen (path);
3934 set = g_hash_table_new (g_str_hash, g_str_equal);
3936 g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_eo);
3937 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
3938 maybe_add_path (path, path_len, object_path, set);
3940 g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_es);
3941 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
3942 maybe_add_path (path, path_len, object_path, set);
3944 p = g_ptr_array_new ();
3945 keys = g_hash_table_get_keys (set);
3946 for (l = keys; l != NULL; l = l->next)
3947 g_ptr_array_add (p, l->data);
3948 g_hash_table_unref (set);
3951 g_ptr_array_add (p, NULL);
3952 ret = (gchar **) g_ptr_array_free (p, FALSE);
3957 g_dbus_connection_list_registered (GDBusConnection *connection,
3961 CONNECTION_LOCK (connection);
3962 ret = g_dbus_connection_list_registered_unlocked (connection, path);
3963 CONNECTION_UNLOCK (connection);
3967 /* called in message handler thread with lock held */
3969 handle_introspect (GDBusConnection *connection,
3971 GDBusMessage *message)
3975 GDBusMessage *reply;
3976 GHashTableIter hash_iter;
3977 ExportedInterface *ei;
3980 /* first the header with the standard interfaces */
3981 s = g_string_sized_new (sizeof (introspect_header) +
3982 sizeof (introspect_standard_interfaces) +
3983 sizeof (introspect_tail));
3984 introspect_append_header (s);
3985 introspect_append_standard_interfaces (s);
3987 /* then include the registered interfaces */
3988 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
3989 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
3990 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
3992 /* finally include nodes registered below us */
3993 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
3994 for (n = 0; registered != NULL && registered[n] != NULL; n++)
3995 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
3996 g_strfreev (registered);
3997 g_string_append (s, introspect_tail);
3999 reply = g_dbus_message_new_method_reply (message);
4000 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4001 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
4002 g_object_unref (reply);
4003 g_string_free (s, TRUE);
4008 /* called in thread where object was registered - no locks held */
4010 call_in_idle_cb (gpointer user_data)
4012 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
4013 GDBusInterfaceVTable *vtable;
4014 guint registration_id;
4015 guint subtree_registration_id;
4017 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
4018 g_assert (vtable != NULL && vtable->method_call != NULL);
4020 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
4021 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
4023 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
4025 subtree_registration_id))
4027 GDBusMessage *reply;
4028 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
4029 "org.freedesktop.DBus.Error.UnknownMethod",
4030 _("No such interface `%s' on object at path %s"),
4031 g_dbus_method_invocation_get_interface_name (invocation),
4032 g_dbus_method_invocation_get_object_path (invocation));
4033 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, NULL, NULL);
4034 g_object_unref (reply);
4038 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
4039 g_dbus_method_invocation_get_sender (invocation),
4040 g_dbus_method_invocation_get_object_path (invocation),
4041 g_dbus_method_invocation_get_interface_name (invocation),
4042 g_dbus_method_invocation_get_method_name (invocation),
4043 g_dbus_method_invocation_get_parameters (invocation),
4044 g_object_ref (invocation),
4045 g_dbus_method_invocation_get_user_data (invocation));
4051 /* called in message handler thread with lock held */
4053 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
4054 GDBusMessage *message,
4055 guint registration_id,
4056 guint subtree_registration_id,
4057 const GDBusInterfaceInfo *interface_info,
4058 const GDBusInterfaceVTable *vtable,
4059 GMainContext *main_context,
4062 GDBusMethodInvocation *invocation;
4063 const GDBusMethodInfo *method_info;
4064 GDBusMessage *reply;
4065 GVariant *parameters;
4066 GSource *idle_source;
4068 GVariantType *in_type;
4072 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4073 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
4075 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
4076 * error to the caller
4078 if (method_info == NULL)
4080 reply = g_dbus_message_new_method_error (message,
4081 "org.freedesktop.DBus.Error.UnknownMethod",
4082 _("No such method `%s'"),
4083 g_dbus_message_get_member (message));
4084 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
4085 g_object_unref (reply);
4090 parameters = g_dbus_message_get_body (message);
4091 if (parameters == NULL)
4093 parameters = g_variant_new ("()");
4094 g_variant_ref_sink (parameters);
4098 g_variant_ref (parameters);
4101 /* Check that the incoming args are of the right type - if they are not, return
4102 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
4104 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
4105 if (!g_variant_is_of_type (parameters, in_type))
4109 type_string = g_variant_type_dup_string (in_type);
4111 reply = g_dbus_message_new_method_error (message,
4112 "org.freedesktop.DBus.Error.InvalidArgs",
4113 _("Type of message, `%s', does not match expected type `%s'"),
4114 g_variant_get_type_string (parameters),
4116 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
4117 g_variant_type_free (in_type);
4118 g_variant_unref (parameters);
4119 g_object_unref (reply);
4120 g_free (type_string);
4124 g_variant_type_free (in_type);
4126 /* schedule the call in idle */
4127 invocation = g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
4128 g_dbus_message_get_path (message),
4129 g_dbus_message_get_interface (message),
4130 g_dbus_message_get_member (message),
4136 g_variant_unref (parameters);
4138 /* TODO: would be nicer with a real MethodData like we already
4139 * have PropertyData and PropertyGetAllData... */
4140 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
4141 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
4142 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
4144 idle_source = g_idle_source_new ();
4145 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4146 g_source_set_callback (idle_source,
4150 g_source_attach (idle_source, main_context);
4151 g_source_unref (idle_source);
4159 /* ---------------------------------------------------------------------------------------------------- */
4161 /* called in message handler thread with lock held */
4163 obj_message_func (GDBusConnection *connection,
4165 GDBusMessage *message)
4167 const gchar *interface_name;
4168 const gchar *member;
4169 const gchar *signature;
4174 interface_name = g_dbus_message_get_interface (message);
4175 member = g_dbus_message_get_member (message);
4176 signature = g_dbus_message_get_signature (message);
4178 /* see if we have an interface for handling this call */
4179 if (interface_name != NULL)
4181 ExportedInterface *ei;
4182 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4185 /* we do - invoke the handler in idle in the right thread */
4187 /* handle no vtable or handler being present */
4188 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
4191 handled = validate_and_maybe_schedule_method_call (connection,
4203 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
4204 g_strcmp0 (member, "Introspect") == 0 &&
4205 g_strcmp0 (signature, "") == 0)
4207 handled = handle_introspect (connection, eo, message);
4210 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4211 g_strcmp0 (member, "Get") == 0 &&
4212 g_strcmp0 (signature, "ss") == 0)
4214 handled = handle_getset_property (connection, eo, message, TRUE);
4217 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4218 g_strcmp0 (member, "Set") == 0 &&
4219 g_strcmp0 (signature, "ssv") == 0)
4221 handled = handle_getset_property (connection, eo, message, FALSE);
4224 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4225 g_strcmp0 (member, "GetAll") == 0 &&
4226 g_strcmp0 (signature, "s") == 0)
4228 handled = handle_get_all_properties (connection, eo, message);
4237 * g_dbus_connection_register_object:
4238 * @connection: A #GDBusConnection.
4239 * @object_path: The object path to register at.
4240 * @interface_info: Introspection data for the interface.
4241 * @vtable: A #GDBusInterfaceVTable to call into or %NULL.
4242 * @user_data: Data to pass to functions in @vtable.
4243 * @user_data_free_func: Function to call when the object path is unregistered.
4244 * @error: Return location for error or %NULL.
4246 * Registers callbacks for exported objects at @object_path with the
4247 * D-Bus interface that is described in @interface_info.
4249 * Calls to functions in @vtable (and @user_data_free_func) will
4250 * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
4251 * loop</link> of the thread you are calling this method from.
4253 * Note that all #GVariant values passed to functions in @vtable will match
4254 * the signature given in @interface_info - if a remote caller passes
4255 * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
4256 * is returned to the remote caller.
4258 * Additionally, if the remote caller attempts to invoke methods or
4259 * access properties not mentioned in @interface_info the
4260 * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
4261 * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
4262 * are returned to the caller.
4264 * It is considered a programming error if the
4265 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
4266 * #GVariant of incorrect type.
4268 * If an existing callback is already registered at @object_path and
4269 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
4271 * Note that @vtable is not copied, so the struct you pass must exist until
4272 * the path is unregistered. One possibility is to free @vtable at the
4273 * same time as @user_data when @user_data_free_func is called.
4275 * GDBus automatically implements the standard D-Bus interfaces
4276 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
4277 * and org.freedesktop.Peer, so you don't have to implement those for
4278 * the objects you export. You <emphasis>can</emphasis> implement
4279 * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
4280 * and setting of properties asynchronously.
4282 * See <xref linkend="gdbus-server"/> for an example of how to use this method.
4284 * Returns: 0 if @error is set, otherwise a registration id (never 0)
4285 * that can be used with g_dbus_connection_unregister_object() .
4290 g_dbus_connection_register_object (GDBusConnection *connection,
4291 const gchar *object_path,
4292 const GDBusInterfaceInfo *interface_info,
4293 const GDBusInterfaceVTable *vtable,
4295 GDestroyNotify user_data_free_func,
4299 ExportedInterface *ei;
4302 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4303 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
4304 g_return_val_if_fail (interface_info != NULL, 0);
4305 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
4306 g_return_val_if_fail (error == NULL || *error == NULL, 0);
4310 CONNECTION_LOCK (connection);
4312 eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
4315 eo = g_new0 (ExportedObject, 1);
4316 eo->object_path = g_strdup (object_path);
4317 eo->connection = connection;
4318 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
4321 (GDestroyNotify) exported_interface_free);
4322 g_hash_table_insert (connection->priv->map_object_path_to_eo, eo->object_path, eo);
4325 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
4331 _("An object is already exported for the interface %s at %s"),
4332 interface_info->name,
4337 ei = g_new0 (ExportedInterface, 1);
4338 ei->id = _global_registration_id++; /* TODO: overflow etc. */
4340 ei->user_data = user_data;
4341 ei->user_data_free_func = user_data_free_func;
4342 ei->vtable = vtable;
4343 ei->interface_info = g_dbus_interface_info_ref ((GDBusInterfaceInfo *) interface_info);
4344 ei->interface_name = g_strdup (interface_info->name);
4345 ei->context = g_main_context_get_thread_default ();
4346 if (ei->context != NULL)
4347 g_main_context_ref (ei->context);
4349 g_hash_table_insert (eo->map_if_name_to_ei,
4350 (gpointer) ei->interface_name,
4352 g_hash_table_insert (connection->priv->map_id_to_ei,
4353 GUINT_TO_POINTER (ei->id),
4359 CONNECTION_UNLOCK (connection);
4365 * g_dbus_connection_unregister_object:
4366 * @connection: A #GDBusConnection.
4367 * @registration_id: A registration id obtained from g_dbus_connection_register_object().
4369 * Unregisters an object.
4371 * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
4376 g_dbus_connection_unregister_object (GDBusConnection *connection,
4377 guint registration_id)
4379 ExportedInterface *ei;
4383 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4387 CONNECTION_LOCK (connection);
4389 ei = g_hash_table_lookup (connection->priv->map_id_to_ei,
4390 GUINT_TO_POINTER (registration_id));
4396 g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
4397 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
4398 /* unregister object path if we have no more exported interfaces */
4399 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
4400 g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_eo,
4406 CONNECTION_UNLOCK (connection);
4411 /* ---------------------------------------------------------------------------------------------------- */
4414 * g_dbus_connection_emit_signal:
4415 * @connection: A #GDBusConnection.
4416 * @destination_bus_name: The unique bus name for the destination for the signal or %NULL to emit to all listeners.
4417 * @object_path: Path of remote object.
4418 * @interface_name: D-Bus interface to emit a signal on.
4419 * @signal_name: The name of the signal to emit.
4420 * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
4421 * @error: Return location for error or %NULL.
4425 * If the parameters GVariant is floating, it is consumed.
4427 * This can only fail if @parameters is not compatible with the D-Bus protocol.
4429 * Returns: %TRUE unless @error is set.
4434 g_dbus_connection_emit_signal (GDBusConnection *connection,
4435 const gchar *destination_bus_name,
4436 const gchar *object_path,
4437 const gchar *interface_name,
4438 const gchar *signal_name,
4439 GVariant *parameters,
4442 GDBusMessage *message;
4448 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4449 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
4450 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
4451 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
4452 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
4453 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
4455 if (G_UNLIKELY (_g_dbus_debug_emission ()))
4457 _g_dbus_debug_print_lock ();
4458 g_print ("========================================================================\n"
4459 "GDBus-debug:Emission:\n"
4460 " >>>> SIGNAL EMISSION %s.%s()\n"
4462 " destination %s\n",
4463 interface_name, signal_name,
4465 destination_bus_name != NULL ? destination_bus_name : "(none)");
4466 _g_dbus_debug_print_unlock ();
4469 message = g_dbus_message_new_signal (object_path,
4473 if (destination_bus_name != NULL)
4474 g_dbus_message_set_header (message,
4475 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
4476 g_variant_new_string (destination_bus_name));
4478 if (parameters != NULL)
4479 g_dbus_message_set_body (message, parameters);
4481 ret = g_dbus_connection_send_message (connection, message, NULL, error);
4482 g_object_unref (message);
4488 add_call_flags (GDBusMessage *message,
4489 GDBusCallFlags flags)
4491 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
4492 g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
4496 decode_method_reply (GDBusMessage *reply,
4497 const gchar *method_name,
4498 const GVariantType *reply_type,
4504 switch (g_dbus_message_get_message_type (reply))
4506 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
4507 result = g_dbus_message_get_body (reply);
4510 result = g_variant_new ("()");
4511 g_variant_ref_sink (result);
4515 g_variant_ref (result);
4518 if (!g_variant_is_of_type (result, reply_type))
4520 gchar *type_string = g_variant_type_dup_string (reply_type);
4524 G_IO_ERROR_INVALID_ARGUMENT,
4525 _("Method `%s' returned type `%s', but expected `%s'"),
4526 method_name, g_variant_get_type_string (result), type_string);
4528 g_variant_unref (result);
4529 g_free (type_string);
4534 case G_DBUS_MESSAGE_TYPE_ERROR:
4535 g_dbus_message_to_gerror (reply, error);
4539 g_assert_not_reached ();
4549 GSimpleAsyncResult *simple;
4550 GVariantType *reply_type;
4551 gchar *method_name; /* for error message */
4556 g_dbus_connection_call_done (GObject *source,
4557 GAsyncResult *result,
4560 GDBusConnection *connection = G_DBUS_CONNECTION (source);
4561 CallState *state = user_data;
4563 GDBusMessage *reply;
4567 reply = g_dbus_connection_send_message_with_reply_finish (connection,
4571 if (G_UNLIKELY (_g_dbus_debug_call ()))
4573 _g_dbus_debug_print_lock ();
4574 g_print ("========================================================================\n"
4575 "GDBus-debug:Call:\n"
4576 " >>>> ASYNC COMPLETE %s() (serial %d)\n"
4582 g_print ("SUCCESS\n");
4586 g_print ("FAILED: %s\n",
4589 _g_dbus_debug_print_unlock ();
4595 value = decode_method_reply (reply, state->method_name,
4596 state->reply_type, &error);
4597 g_object_unref (reply);
4604 g_simple_async_result_set_from_error (state->simple, error);
4605 g_error_free (error);
4608 g_simple_async_result_set_op_res_gpointer (state->simple, value,
4609 (GDestroyNotify) g_variant_unref);
4611 g_simple_async_result_complete (state->simple);
4612 g_variant_type_free (state->reply_type);
4613 g_object_unref (state->simple);
4614 g_free (state->method_name);
4616 g_slice_free (CallState, state);
4620 * g_dbus_connection_call:
4621 * @connection: A #GDBusConnection.
4622 * @bus_name: A unique or well-known bus name or %NULL if @connection is not a message bus connection.
4623 * @object_path: Path of remote object.
4624 * @interface_name: D-Bus interface to invoke method on.
4625 * @method_name: The name of the method to invoke.
4626 * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
4627 * @reply_type: The expected type of the reply, or %NULL.
4628 * @flags: Flags from the #GDBusCallFlags enumeration.
4629 * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
4630 * @cancellable: A #GCancellable or %NULL.
4631 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
4632 * care about the result of the method invocation.
4633 * @user_data: The data to pass to @callback.
4635 * Asynchronously invokes the @method_name method on the
4636 * @interface_name D-Bus interface on the remote object at
4637 * @object_path owned by @bus_name.
4639 * If @connection is closed then the operation will fail with
4640 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
4641 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
4642 * not compatible with the D-Bus protocol, the operation fails with
4643 * %G_IO_ERROR_INVALID_ARGUMENT.
4645 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
4646 * error will be raised if it does not match. Said another way, if you give a @reply_type
4647 * then any non-%NULL return value will be of this type.
4649 * If the @parameters #GVariant is floating, it is consumed. This allows
4650 * convenient 'inline' use of g_variant_new(), e.g.:
4652 * g_dbus_connection_call (connection,
4653 * "org.freedesktop.StringThings",
4654 * "/org/freedesktop/StringThings",
4655 * "org.freedesktop.StringThings",
4657 * g_variant_new ("(ss)",
4661 * G_DBUS_CALL_FLAGS_NONE,
4664 * (GAsyncReadyCallback) two_strings_done,
4668 * This is an asynchronous method. When the operation is finished, @callback will be invoked
4669 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
4670 * of the thread you are calling this method from. You can then call
4671 * g_dbus_connection_call_finish() to get the result of the operation.
4672 * See g_dbus_connection_call_sync() for the synchronous version of this
4678 g_dbus_connection_call (GDBusConnection *connection,
4679 const gchar *bus_name,
4680 const gchar *object_path,
4681 const gchar *interface_name,
4682 const gchar *method_name,
4683 GVariant *parameters,
4684 const GVariantType *reply_type,
4685 GDBusCallFlags flags,
4687 GCancellable *cancellable,
4688 GAsyncReadyCallback callback,
4691 GDBusMessage *message;
4694 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
4695 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
4696 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
4697 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
4698 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
4699 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
4700 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
4702 state = g_slice_new (CallState);
4703 state->simple = g_simple_async_result_new (G_OBJECT (connection),
4704 callback, user_data,
4705 g_dbus_connection_call);
4706 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
4708 if (reply_type == NULL)
4709 reply_type = G_VARIANT_TYPE_ANY;
4711 state->reply_type = g_variant_type_copy (reply_type);
4713 message = g_dbus_message_new_method_call (bus_name,
4717 add_call_flags (message, flags);
4718 if (parameters != NULL)
4719 g_dbus_message_set_body (message, parameters);
4721 g_dbus_connection_send_message_with_reply (connection,
4726 g_dbus_connection_call_done,
4729 if (G_UNLIKELY (_g_dbus_debug_call ()))
4731 _g_dbus_debug_print_lock ();
4732 g_print ("========================================================================\n"
4733 "GDBus-debug:Call:\n"
4734 " >>>> ASYNC %s.%s()\n"
4736 " owned by name %s (serial %d)\n",
4740 bus_name != NULL ? bus_name : "(none)",
4742 _g_dbus_debug_print_unlock ();
4745 if (message != NULL)
4746 g_object_unref (message);
4750 * g_dbus_connection_call_finish:
4751 * @connection: A #GDBusConnection.
4752 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
4753 * @error: Return location for error or %NULL.
4755 * Finishes an operation started with g_dbus_connection_call().
4757 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
4758 * return values. Free with g_variant_unref().
4763 g_dbus_connection_call_finish (GDBusConnection *connection,
4767 GSimpleAsyncResult *simple;
4769 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
4770 g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
4771 g_dbus_connection_call), NULL);
4772 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
4774 simple = G_SIMPLE_ASYNC_RESULT (res);
4776 if (g_simple_async_result_propagate_error (simple, error))
4779 return g_variant_ref (g_simple_async_result_get_op_res_gpointer (simple));
4782 /* ---------------------------------------------------------------------------------------------------- */
4785 * g_dbus_connection_call_sync:
4786 * @connection: A #GDBusConnection.
4787 * @bus_name: A unique or well-known bus name.
4788 * @object_path: Path of remote object.
4789 * @interface_name: D-Bus interface to invoke method on.
4790 * @method_name: The name of the method to invoke.
4791 * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
4792 * @reply_type: The expected type of the reply, or %NULL.
4793 * @flags: Flags from the #GDBusCallFlags enumeration.
4794 * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
4795 * @cancellable: A #GCancellable or %NULL.
4796 * @error: Return location for error or %NULL.
4798 * Synchronously invokes the @method_name method on the
4799 * @interface_name D-Bus interface on the remote object at
4800 * @object_path owned by @bus_name.
4802 * If @connection is closed then the operation will fail with
4803 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
4804 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
4805 * contains a value not compatible with the D-Bus protocol, the operation
4806 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
4808 * If @reply_type is non-%NULL then the reply will be checked for having
4809 * this type and an error will be raised if it does not match. Said
4810 * another way, if you give a @reply_type then any non-%NULL return
4811 * value will be of this type.
4813 * If the @parameters #GVariant is floating, it is consumed.
4814 * This allows convenient 'inline' use of g_variant_new(), e.g.:
4816 * g_dbus_connection_call_sync (connection,
4817 * "org.freedesktop.StringThings",
4818 * "/org/freedesktop/StringThings",
4819 * "org.freedesktop.StringThings",
4821 * g_variant_new ("(ss)",
4825 * G_DBUS_CALL_FLAGS_NONE,
4831 * The calling thread is blocked until a reply is received. See
4832 * g_dbus_connection_call() for the asynchronous version of
4835 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
4836 * return values. Free with g_variant_unref().
4841 g_dbus_connection_call_sync (GDBusConnection *connection,
4842 const gchar *bus_name,
4843 const gchar *object_path,
4844 const gchar *interface_name,
4845 const gchar *method_name,
4846 GVariant *parameters,
4847 const GVariantType *reply_type,
4848 GDBusCallFlags flags,
4850 GCancellable *cancellable,
4853 GDBusMessage *message;
4854 GDBusMessage *reply;
4856 GError *local_error;
4862 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
4863 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
4864 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
4865 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
4866 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
4867 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
4868 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
4870 if (reply_type == NULL)
4871 reply_type = G_VARIANT_TYPE_ANY;
4873 message = g_dbus_message_new_method_call (bus_name,
4877 add_call_flags (message, flags);
4878 if (parameters != NULL)
4879 g_dbus_message_set_body (message, parameters);
4881 if (G_UNLIKELY (_g_dbus_debug_call ()))
4883 _g_dbus_debug_print_lock ();
4884 g_print ("========================================================================\n"
4885 "GDBus-debug:Call:\n"
4886 " >>>> SYNC %s.%s()\n"
4888 " owned by name %s\n",
4892 bus_name != NULL ? bus_name : "(none)");
4893 _g_dbus_debug_print_unlock ();
4897 reply = g_dbus_connection_send_message_with_reply_sync (connection,
4900 NULL, /* volatile guint32 *out_serial */
4904 if (G_UNLIKELY (_g_dbus_debug_call ()))
4906 _g_dbus_debug_print_lock ();
4907 g_print ("========================================================================\n"
4908 "GDBus-debug:Call:\n"
4909 " <<<< SYNC COMPLETE %s.%s()\n"
4915 g_print ("SUCCESS\n");
4919 g_print ("FAILED: %s\n",
4920 local_error->message);
4922 _g_dbus_debug_print_unlock ();
4928 *error = local_error;
4930 g_error_free (local_error);
4934 result = decode_method_reply (reply, method_name, reply_type, error);
4937 if (message != NULL)
4938 g_object_unref (message);
4940 g_object_unref (reply);
4945 /* ---------------------------------------------------------------------------------------------------- */
4947 struct ExportedSubtree
4951 GDBusConnection *connection;
4952 const GDBusSubtreeVTable *vtable;
4953 GDBusSubtreeFlags flags;
4955 GMainContext *context;
4957 GDestroyNotify user_data_free_func;
4961 exported_subtree_free (ExportedSubtree *es)
4963 if (es->user_data_free_func != NULL)
4964 /* TODO: push to thread-default mainloop */
4965 es->user_data_free_func (es->user_data);
4967 if (es->context != NULL)
4968 g_main_context_unref (es->context);
4970 g_free (es->object_path);
4974 /* called without lock held */
4976 handle_subtree_introspect (GDBusConnection *connection,
4977 ExportedSubtree *es,
4978 GDBusMessage *message)
4982 GDBusMessage *reply;
4985 const gchar *sender;
4986 const gchar *requested_object_path;
4987 const gchar *requested_node;
4988 GPtrArray *interfaces;
4990 gchar **subnode_paths;
4994 requested_object_path = g_dbus_message_get_path (message);
4995 sender = g_dbus_message_get_sender (message);
4996 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
4998 s = g_string_new (NULL);
4999 introspect_append_header (s);
5001 /* Strictly we don't need the children in dynamic mode, but we avoid the
5002 * conditionals to preserve code clarity
5004 children = es->vtable->enumerate (es->connection,
5011 requested_node = strrchr (requested_object_path, '/') + 1;
5013 /* Assert existence of object if we are not dynamic */
5014 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
5015 !_g_strv_has_string ((const gchar * const *) children, requested_node))
5020 requested_node = "/";
5023 interfaces = es->vtable->introspect (es->connection,
5028 if (interfaces != NULL)
5030 if (interfaces->len > 0)
5032 /* we're in business */
5033 introspect_append_standard_interfaces (s);
5035 for (n = 0; n < interfaces->len; n++)
5037 const GDBusInterfaceInfo *interface_info = interfaces->pdata[n];
5038 g_dbus_interface_info_generate_xml (interface_info, 2, s);
5041 g_ptr_array_unref (interfaces);
5044 /* then include <node> entries from the Subtree for the root */
5047 for (n = 0; children != NULL && children[n] != NULL; n++)
5048 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
5051 /* finally include nodes registered below us */
5052 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
5053 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
5054 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
5055 g_strfreev (subnode_paths);
5057 g_string_append (s, "</node>\n");
5059 reply = g_dbus_message_new_method_reply (message);
5060 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5061 g_dbus_connection_send_message (connection, reply, NULL, NULL);
5062 g_object_unref (reply);
5067 g_string_free (s, TRUE);
5068 g_strfreev (children);
5072 /* called without lock held */
5074 handle_subtree_method_invocation (GDBusConnection *connection,
5075 ExportedSubtree *es,
5076 GDBusMessage *message)
5079 const gchar *sender;
5080 const gchar *interface_name;
5081 const gchar *member;
5082 const gchar *signature;
5083 const gchar *requested_object_path;
5084 const gchar *requested_node;
5087 const GDBusInterfaceInfo *interface_info;
5088 const GDBusInterfaceVTable *interface_vtable;
5089 gpointer interface_user_data;
5091 GPtrArray *interfaces;
5092 gboolean is_property_get;
5093 gboolean is_property_set;
5094 gboolean is_property_get_all;
5099 requested_object_path = g_dbus_message_get_path (message);
5100 sender = g_dbus_message_get_sender (message);
5101 interface_name = g_dbus_message_get_interface (message);
5102 member = g_dbus_message_get_member (message);
5103 signature = g_dbus_message_get_signature (message);
5104 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
5106 is_property_get = FALSE;
5107 is_property_set = FALSE;
5108 is_property_get_all = FALSE;
5109 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
5111 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
5112 is_property_get = TRUE;
5113 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
5114 is_property_set = TRUE;
5115 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
5116 is_property_get_all = TRUE;
5119 children = es->vtable->enumerate (es->connection,
5126 requested_node = strrchr (requested_object_path, '/') + 1;
5128 /* If not dynamic, skip if requested node is not part of children */
5129 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
5130 !_g_strv_has_string ((const gchar * const *) children, requested_node))
5135 requested_node = "/";
5138 /* get introspection data for the node */
5139 interfaces = es->vtable->introspect (es->connection,
5141 requested_object_path,
5144 g_assert (interfaces != NULL);
5145 interface_info = NULL;
5146 for (n = 0; n < interfaces->len; n++)
5148 const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
5149 if (g_strcmp0 (id_n->name, interface_name) == 0)
5150 interface_info = id_n;
5153 /* dispatch the call if the user wants to handle it */
5154 if (interface_info != NULL)
5156 /* figure out where to dispatch the method call */
5157 interface_user_data = NULL;
5158 interface_vtable = es->vtable->dispatch (es->connection,
5163 &interface_user_data,
5165 if (interface_vtable == NULL)
5168 CONNECTION_LOCK (connection);
5169 handled = validate_and_maybe_schedule_method_call (es->connection,
5176 interface_user_data);
5177 CONNECTION_UNLOCK (connection);
5179 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
5180 else if (is_property_get || is_property_set || is_property_get_all)
5182 if (is_property_get)
5183 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
5184 else if (is_property_set)
5185 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
5186 else if (is_property_get_all)
5187 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
5189 g_assert_not_reached ();
5191 /* see if the object supports this interface at all */
5192 for (n = 0; n < interfaces->len; n++)
5194 const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
5195 if (g_strcmp0 (id_n->name, interface_name) == 0)
5196 interface_info = id_n;
5199 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
5200 * claims it won't support the interface
5202 if (interface_info == NULL)
5204 GDBusMessage *reply;
5205 reply = g_dbus_message_new_method_error (message,
5206 "org.freedesktop.DBus.Error.InvalidArgs",
5207 _("No such interface `%s'"),
5209 g_dbus_connection_send_message (es->connection, reply, NULL, NULL);
5210 g_object_unref (reply);
5215 /* figure out where to dispatch the property get/set/getall calls */
5216 interface_user_data = NULL;
5217 interface_vtable = es->vtable->dispatch (es->connection,
5222 &interface_user_data,
5224 if (interface_vtable == NULL)
5227 if (is_property_get || is_property_set)
5229 CONNECTION_LOCK (connection);
5230 handled = validate_and_maybe_schedule_property_getset (es->connection,
5238 interface_user_data);
5239 CONNECTION_UNLOCK (connection);
5241 else if (is_property_get_all)
5243 CONNECTION_LOCK (connection);
5244 handled = validate_and_maybe_schedule_property_get_all (es->connection,
5251 interface_user_data);
5252 CONNECTION_UNLOCK (connection);
5257 if (interfaces != NULL)
5258 g_ptr_array_unref (interfaces);
5259 g_strfreev (children);
5265 GDBusMessage *message;
5266 ExportedSubtree *es;
5267 } SubtreeDeferredData;
5270 subtree_deferred_data_free (SubtreeDeferredData *data)
5272 g_object_unref (data->message);
5276 /* called without lock held in the thread where the caller registered the subtree */
5278 process_subtree_vtable_message_in_idle_cb (gpointer _data)
5280 SubtreeDeferredData *data = _data;
5285 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
5286 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
5287 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
5288 handled = handle_subtree_introspect (data->es->connection,
5292 handled = handle_subtree_method_invocation (data->es->connection,
5298 CONNECTION_LOCK (data->es->connection);
5299 handled = handle_generic_unlocked (data->es->connection, data->message);
5300 CONNECTION_UNLOCK (data->es->connection);
5303 /* if we couldn't handle the request, just bail with the UnknownMethod error */
5306 GDBusMessage *reply;
5307 reply = g_dbus_message_new_method_error (data->message,
5308 "org.freedesktop.DBus.Error.UnknownMethod",
5309 _("Method `%s' on interface `%s' with signature `%s' does not exist"),
5310 g_dbus_message_get_member (data->message),
5311 g_dbus_message_get_interface (data->message),
5312 g_dbus_message_get_signature (data->message));
5313 g_dbus_connection_send_message (data->es->connection, reply, NULL, NULL);
5314 g_object_unref (reply);
5320 /* called in message handler thread with lock held */
5322 subtree_message_func (GDBusConnection *connection,
5323 ExportedSubtree *es,
5324 GDBusMessage *message)
5326 GSource *idle_source;
5327 SubtreeDeferredData *data;
5329 data = g_new0 (SubtreeDeferredData, 1);
5330 data->message = g_object_ref (message);
5333 /* defer this call to an idle handler in the right thread */
5334 idle_source = g_idle_source_new ();
5335 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
5336 g_source_set_callback (idle_source,
5337 process_subtree_vtable_message_in_idle_cb,
5339 (GDestroyNotify) subtree_deferred_data_free);
5340 g_source_attach (idle_source, es->context);
5341 g_source_unref (idle_source);
5343 /* since we own the entire subtree, handlers for objects not in the subtree have been
5344 * tried already by libdbus-1 - so we just need to ensure that we're always going
5345 * to reply to the message
5351 * g_dbus_connection_register_subtree:
5352 * @connection: A #GDBusConnection.
5353 * @object_path: The object path to register the subtree at.
5354 * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
5355 * @flags: Flags used to fine tune the behavior of the subtree.
5356 * @user_data: Data to pass to functions in @vtable.
5357 * @user_data_free_func: Function to call when the subtree is unregistered.
5358 * @error: Return location for error or %NULL.
5360 * Registers a whole subtree of <quote>dynamic</quote> objects.
5362 * The @enumerate and @introspection functions in @vtable are used to
5363 * convey, to remote callers, what nodes exist in the subtree rooted
5366 * When handling remote calls into any node in the subtree, first the
5367 * @enumerate function is used to check if the node exists. If the node exists
5368 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
5369 * the @introspection function is used to check if the node supports the
5370 * requested method. If so, the @dispatch function is used to determine
5371 * where to dispatch the call. The collected #GDBusInterfaceVTable and
5372 * #gpointer will be used to call into the interface vtable for processing
5375 * All calls into user-provided code will be invoked in the <link
5376 * linkend="g-main-context-push-thread-default">thread-default main
5377 * loop</link> of the thread you are calling this method from.
5379 * If an existing subtree is already registered at @object_path or
5380 * then @error is set to #G_IO_ERROR_EXISTS.
5382 * Note that it is valid to register regular objects (using
5383 * g_dbus_connection_register_object()) in a subtree registered with
5384 * g_dbus_connection_register_subtree() - if so, the subtree handler
5385 * is tried as the last resort. One way to think about a subtree
5386 * handler is to consider it a <quote>fallback handler</quote>
5387 * for object paths not registered via g_dbus_connection_register_object()
5388 * or other bindings.
5390 * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
5392 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
5393 * that can be used with g_dbus_connection_unregister_subtree() .
5398 g_dbus_connection_register_subtree (GDBusConnection *connection,
5399 const gchar *object_path,
5400 const GDBusSubtreeVTable *vtable,
5401 GDBusSubtreeFlags flags,
5403 GDestroyNotify user_data_free_func,
5407 ExportedSubtree *es;
5409 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
5410 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
5411 g_return_val_if_fail (vtable != NULL, 0);
5412 g_return_val_if_fail (error == NULL || *error == NULL, 0);
5416 CONNECTION_LOCK (connection);
5418 es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
5424 _("A subtree is already exported for %s"),
5429 es = g_new0 (ExportedSubtree, 1);
5430 es->object_path = g_strdup (object_path);
5431 es->connection = connection;
5433 es->vtable = vtable;
5435 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
5436 es->user_data = user_data;
5437 es->user_data_free_func = user_data_free_func;
5438 es->context = g_main_context_get_thread_default ();
5439 if (es->context != NULL)
5440 g_main_context_ref (es->context);
5442 g_hash_table_insert (connection->priv->map_object_path_to_es, es->object_path, es);
5443 g_hash_table_insert (connection->priv->map_id_to_es,
5444 GUINT_TO_POINTER (es->id),
5450 CONNECTION_UNLOCK (connection);
5455 /* ---------------------------------------------------------------------------------------------------- */
5458 * g_dbus_connection_unregister_subtree:
5459 * @connection: A #GDBusConnection.
5460 * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
5462 * Unregisters a subtree.
5464 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
5469 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
5470 guint registration_id)
5472 ExportedSubtree *es;
5475 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5479 CONNECTION_LOCK (connection);
5481 es = g_hash_table_lookup (connection->priv->map_id_to_es,
5482 GUINT_TO_POINTER (registration_id));
5486 g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_es, GUINT_TO_POINTER (es->id)));
5487 g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_es, es->object_path));
5492 CONNECTION_UNLOCK (connection);
5497 /* ---------------------------------------------------------------------------------------------------- */
5499 /* must be called with lock held */
5501 handle_generic_ping_unlocked (GDBusConnection *connection,
5502 const gchar *object_path,
5503 GDBusMessage *message)
5505 GDBusMessage *reply;
5506 reply = g_dbus_message_new_method_reply (message);
5507 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5508 g_object_unref (reply);
5511 /* must be called with lock held */
5513 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
5514 const gchar *object_path,
5515 GDBusMessage *message)
5517 GDBusMessage *reply;
5520 if (connection->priv->machine_id == NULL)
5525 connection->priv->machine_id = _g_dbus_get_machine_id (&error);
5526 if (connection->priv->machine_id == NULL)
5528 reply = g_dbus_message_new_method_error_literal (message,
5529 "org.freedesktop.DBus.Error.Failed",
5531 g_error_free (error);
5537 reply = g_dbus_message_new_method_reply (message);
5538 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->priv->machine_id));
5540 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5541 g_object_unref (reply);
5544 /* must be called with lock held */
5546 handle_generic_introspect_unlocked (GDBusConnection *connection,
5547 const gchar *object_path,
5548 GDBusMessage *message)
5553 GDBusMessage *reply;
5555 /* first the header */
5556 s = g_string_new (NULL);
5557 introspect_append_header (s);
5559 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
5560 for (n = 0; registered != NULL && registered[n] != NULL; n++)
5561 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
5562 g_strfreev (registered);
5563 g_string_append (s, "</node>\n");
5565 reply = g_dbus_message_new_method_reply (message);
5566 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5567 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5568 g_object_unref (reply);
5569 g_string_free (s, TRUE);
5572 /* must be called with lock held */
5574 handle_generic_unlocked (GDBusConnection *connection,
5575 GDBusMessage *message)
5578 const gchar *interface_name;
5579 const gchar *member;
5580 const gchar *signature;
5583 CONNECTION_ENSURE_LOCK (connection);
5587 interface_name = g_dbus_message_get_interface (message);
5588 member = g_dbus_message_get_member (message);
5589 signature = g_dbus_message_get_signature (message);
5590 path = g_dbus_message_get_path (message);
5592 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
5593 g_strcmp0 (member, "Introspect") == 0 &&
5594 g_strcmp0 (signature, "") == 0)
5596 handle_generic_introspect_unlocked (connection, path, message);
5599 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
5600 g_strcmp0 (member, "Ping") == 0 &&
5601 g_strcmp0 (signature, "") == 0)
5603 handle_generic_ping_unlocked (connection, path, message);
5606 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
5607 g_strcmp0 (member, "GetMachineId") == 0 &&
5608 g_strcmp0 (signature, "") == 0)
5610 handle_generic_get_machine_id_unlocked (connection, path, message);
5617 /* ---------------------------------------------------------------------------------------------------- */
5619 /* called in message handler thread with lock held */
5621 distribute_method_call (GDBusConnection *connection,
5622 GDBusMessage *message)
5624 GDBusMessage *reply;
5626 ExportedSubtree *es;
5627 const gchar *object_path;
5628 const gchar *interface_name;
5629 const gchar *member;
5630 const gchar *signature;
5632 gchar *subtree_path;
5635 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
5637 interface_name = g_dbus_message_get_interface (message);
5638 member = g_dbus_message_get_member (message);
5639 signature = g_dbus_message_get_signature (message);
5640 path = g_dbus_message_get_path (message);
5641 subtree_path = g_strdup (path);
5642 needle = strrchr (subtree_path, '/');
5643 if (needle != NULL && needle != subtree_path)
5649 g_free (subtree_path);
5650 subtree_path = NULL;
5654 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
5656 _g_dbus_debug_print_lock ();
5657 g_print ("========================================================================\n"
5658 "GDBus-debug:Incoming:\n"
5659 " >>>> METHOD INVOCATION %s.%s()\n"
5661 " invoked by name %s\n",
5662 interface_name, member,
5664 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)");
5665 _g_dbus_debug_print_unlock ();
5669 g_debug ("interface = `%s'", interface_name);
5670 g_debug ("member = `%s'", member);
5671 g_debug ("signature = `%s'", signature);
5672 g_debug ("path = `%s'", path);
5673 g_debug ("subtree_path = `%s'", subtree_path != NULL ? subtree_path : "N/A");
5676 object_path = g_dbus_message_get_path (message);
5677 g_assert (object_path != NULL);
5679 eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
5682 if (obj_message_func (connection, eo, message))
5686 es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
5689 if (subtree_message_func (connection, es, message))
5693 if (subtree_path != NULL)
5695 es = g_hash_table_lookup (connection->priv->map_object_path_to_es, subtree_path);
5698 if (subtree_message_func (connection, es, message))
5703 if (handle_generic_unlocked (connection, message))
5706 /* if we end up here, the message has not been not handled - so return an error saying this */
5707 reply = g_dbus_message_new_method_error (message,
5708 "org.freedesktop.DBus.Error.UnknownMethod",
5709 _("No such interface `%s' on object at path %s"),
5712 g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
5713 g_object_unref (reply);
5716 g_free (subtree_path);
5719 /* ---------------------------------------------------------------------------------------------------- */
5721 static GDBusConnection **
5722 message_bus_get_singleton (GBusType bus_type,
5725 GDBusConnection **ret;
5726 const gchar *starter_bus;
5732 case G_BUS_TYPE_SESSION:
5733 ret = &the_session_bus;
5736 case G_BUS_TYPE_SYSTEM:
5737 ret = &the_system_bus;
5740 case G_BUS_TYPE_STARTER:
5741 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
5742 if (g_strcmp0 (starter_bus, "session") == 0)
5744 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
5747 else if (g_strcmp0 (starter_bus, "system") == 0)
5749 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
5754 if (starter_bus != NULL)
5758 G_IO_ERROR_INVALID_ARGUMENT,
5759 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
5760 " - unknown value `%s'"),
5765 g_set_error_literal (error,
5767 G_IO_ERROR_INVALID_ARGUMENT,
5768 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
5769 "variable is not set"));
5775 g_assert_not_reached ();
5783 static GDBusConnection *
5784 get_uninitialized_connection (GBusType bus_type,
5785 GCancellable *cancellable,
5788 GDBusConnection **singleton;
5789 GDBusConnection *ret;
5793 G_LOCK (message_bus_lock);
5794 singleton = message_bus_get_singleton (bus_type, error);
5795 if (singleton == NULL)
5798 if (*singleton == NULL)
5801 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
5802 if (address == NULL)
5804 ret = *singleton = g_object_new (G_TYPE_DBUS_CONNECTION,
5806 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
5807 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
5808 "exit-on-close", TRUE,
5814 ret = g_object_ref (*singleton);
5817 g_assert (ret != NULL);
5820 G_UNLOCK (message_bus_lock);
5826 * @bus_type: A #GBusType.
5827 * @cancellable: A #GCancellable or %NULL.
5828 * @error: Return location for error or %NULL.
5830 * Synchronously connects to the message bus specified by @bus_type.
5831 * Note that the returned object may shared with other callers,
5832 * e.g. if two separate parts of a process calls this function with
5833 * the same @bus_type, they will share the same object.
5835 * This is a synchronous failable function. See g_bus_get() and
5836 * g_bus_get_finish() for the asynchronous version.
5838 * The returned object is a singleton, that is, shared with other
5839 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
5840 * event that you need a private message bus connection, use
5841 * g_dbus_address_get_for_bus_sync() and
5842 * g_dbus_connection_new_for_address().
5844 * Note that the returned #GDBusConnection object will (usually) have
5845 * the #GDBusConnection:exit-on-close property set to %TRUE.
5847 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
5852 g_bus_get_sync (GBusType bus_type,
5853 GCancellable *cancellable,
5856 GDBusConnection *connection;
5858 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5860 connection = get_uninitialized_connection (bus_type, cancellable, error);
5861 if (connection == NULL)
5864 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
5866 g_object_unref (connection);
5875 bus_get_async_initable_cb (GObject *source_object,
5879 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
5883 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
5887 g_assert (error != NULL);
5888 g_simple_async_result_set_from_error (simple, error);
5889 g_error_free (error);
5890 g_object_unref (source_object);
5894 g_simple_async_result_set_op_res_gpointer (simple,
5898 g_simple_async_result_complete_in_idle (simple);
5899 g_object_unref (simple);
5904 * @bus_type: A #GBusType.
5905 * @cancellable: A #GCancellable or %NULL.
5906 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
5907 * @user_data: The data to pass to @callback.
5909 * Asynchronously connects to the message bus specified by @bus_type.
5911 * When the operation is finished, @callback will be invoked. You can
5912 * then call g_bus_get_finish() to get the result of the operation.
5914 * This is a asynchronous failable function. See g_bus_get_sync() for
5915 * the synchronous version.
5920 g_bus_get (GBusType bus_type,
5921 GCancellable *cancellable,
5922 GAsyncReadyCallback callback,
5925 GDBusConnection *connection;
5926 GSimpleAsyncResult *simple;
5929 simple = g_simple_async_result_new (NULL,
5935 connection = get_uninitialized_connection (bus_type, cancellable, &error);
5936 if (connection == NULL)
5938 g_assert (error != NULL);
5939 g_simple_async_result_set_from_error (simple, error);
5940 g_error_free (error);
5941 g_simple_async_result_complete_in_idle (simple);
5942 g_object_unref (simple);
5946 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
5949 bus_get_async_initable_cb,
5956 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
5957 * @error: Return location for error or %NULL.
5959 * Finishes an operation started with g_bus_get().
5961 * The returned object is a singleton, that is, shared with other
5962 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
5963 * event that you need a private message bus connection, use
5964 * g_dbus_address_get_for_bus() and
5965 * g_dbus_connection_new_for_address().
5967 * Note that the returned #GDBusConnection object will (usually) have
5968 * the #GDBusConnection:exit-on-close property set to %TRUE.
5970 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
5975 g_bus_get_finish (GAsyncResult *res,
5978 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5980 GDBusConnection *ret;
5982 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5984 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
5988 if (g_simple_async_result_propagate_error (simple, error))
5991 object = g_simple_async_result_get_op_res_gpointer (simple);
5992 g_assert (object != NULL);
5993 ret = g_object_ref (G_DBUS_CONNECTION (object));
5999 /* ---------------------------------------------------------------------------------------------------- */
6001 #define __G_DBUS_CONNECTION_C__
6002 #include "gioaliasdef.c"