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 * - would be nice to expose GDBusAuthMechanism and an extension point
28 * - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
29 * the mechanism VFuncs need to be able to set an error.
31 * - Need to document other mechanisms/sources for determining the D-Bus
32 * address of a well-known bus.
34 * - e.g. on Win32 we need code like from here
36 * http://cgit.freedesktop.org/~david/gdbus-standalone/tree/gdbus/gdbusaddress.c#n900
38 * that was never copied over here because it originally was copy-paste
39 * from the GPLv2 / AFL 2.1 libdbus sources.
41 * - on OS X we need to look in launchd for the address
43 * https://bugs.freedesktop.org/show_bug.cgi?id=14259
45 * - on X11 we need to look in a X11 property on the X server
46 * - (we can also just use dbus-launch(1) from the D-Bus
49 * - (ideally) this requires D-Bus spec work because none of
50 * this has never really been specced out properly (except
53 * - Related to the above, we also need to be able to launch a message bus
54 * instance.... Since we don't want to write our own bus daemon we should
55 * launch dbus-daemon(1) (thus: Win32 and OS X need to bundle it)
57 * - probably want a G_DBUS_NONCE_TCP_TMPDIR environment variable
58 * to specify where the nonce is stored. This will allow people to use
59 * G_DBUS_NONCE_TCP_TMPDIR=/mnt/secure.company.server/dbus-nonce-dir
60 * to easily achieve secure RPC via nonce-tcp.
62 * - need to expose an extension point for resolving D-Bus address and
63 * turning them into GIOStream objects. This will allow us to implement
64 * e.g. X11 D-Bus transports without dlopen()'ing or linking against
66 * - see g_dbus_address_connect() in gdbusaddress.c
68 * - would be cute to use kernel-specific APIs to resolve fds for
69 * debug output when using G_DBUS_DEBUG=message, e.g. in addition to
71 * fd 21: dev=8:1,mode=0100644,ino=1171231,uid=0,gid=0,rdev=0:0,size=234,atime=1273070640,mtime=1267126160,ctime=1267126160
73 * maybe we can show more information about what fd 21 really is.
74 * Ryan suggests looking in /proc/self/fd for clues / symlinks!
75 * Initial experiments on Linux 2.6 suggests that the symlink looks
80 * e.g. not of much use.
82 * - GDBus High-Level docs
83 * - Proxy: properties, signals...
84 * - Connection: IOStream based, ::close, connection setup steps
85 * mainloop integration, threading
86 * - Differences from libdbus (extend "Migrating from")
87 * - the message handling thread
88 * - Using GVariant instead of GValue
89 * - Explain why the high-level API is a good thing and what
90 * kind of pitfalls it avoids
91 * - Export objects before claiming names
92 * - Talk about auto-starting services (cf. GBusNameWatcherFlags)
94 * - use abstract sockets in test code
95 * - right now it doesn't work, dbus-daemon(1) fails with
97 * /gdbus/connection/filter: Failed to start message bus: Failed to bind
98 * socket "/tmp/g-dbus-tests-pid-28531": Address already in use
99 * ** WARNING **: Error reading address from dbus daemon, 0 bytes read
108 #include <sys/types.h>
113 #include "gdbusauth.h"
114 #include "gdbusutils.h"
115 #include "gdbusaddress.h"
116 #include "gdbusmessage.h"
117 #include "gdbusconnection.h"
118 #include "gdbuserror.h"
119 #include "gioenumtypes.h"
120 #include "gdbusintrospection.h"
121 #include "gdbusmethodinvocation.h"
122 #include "gdbusprivate.h"
123 #include "gdbusauthobserver.h"
124 #include "ginitable.h"
125 #include "gasyncinitable.h"
126 #include "giostream.h"
127 #include "gasyncresult.h"
128 #include "gsimpleasyncresult.h"
131 #include "gunixconnection.h"
132 #include "gunixfdmessage.h"
135 #include "glibintl.h"
138 * SECTION:gdbusconnection
139 * @short_description: D-Bus Connections
140 * @include: gio/gio.h
142 * The #GDBusConnection type is used for D-Bus connections to remote
143 * peers such as a message buses. It is a low-level API that offers a
144 * lot of flexibility. For instance, it lets you establish a connection
145 * over any transport that can by represented as an #GIOStream.
147 * This class is rarely used directly in D-Bus clients. If you are writing
148 * an D-Bus client, it is often easier to use the g_bus_own_name(),
149 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
151 * As an exception to the usual GLib rule that a particular object must not be
152 * used by two threads at the same time, #GDBusConnection's methods may be
153 * called from any thread<footnote>
155 * This is so that g_bus_get() and g_bus_get_sync() can safely return the
156 * same #GDBusConnection when called from any thread.
160 * Most of the ways to obtain a #GDBusConnection automatically initialize it
161 * (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
162 * g_bus_get(), and the synchronous versions of those methods, give you an
163 * initialized connection. Language bindings for GIO should use
164 * g_initable_new() or g_async_initable_new_async(), which also initialize the
167 * If you construct an uninitialized #GDBusConnection, such as via
168 * g_object_new(), you must initialize it via g_initable_init() or
169 * g_async_initable_init_async() before using its methods or properties.
170 * Calling methods or accessing properties on a #GDBusConnection that has not
171 * completed initialization successfully is considered to be invalid, and leads
172 * to undefined behaviour. In particular, if initialization fails with a
173 * #GError, the only valid thing you can do with that #GDBusConnection is to
174 * free it with g_object_unref().
176 * <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>
178 * <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>
180 * <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>
182 * <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>
185 /* ---------------------------------------------------------------------------------------------------- */
187 typedef struct _GDBusConnectionClass GDBusConnectionClass;
190 * GDBusConnectionClass:
191 * @closed: Signal class handler for the #GDBusConnection::closed signal.
193 * Class structure for #GDBusConnection.
197 struct _GDBusConnectionClass
200 GObjectClass parent_class;
204 void (*closed) (GDBusConnection *connection,
205 gboolean remote_peer_vanished,
209 G_LOCK_DEFINE_STATIC (message_bus_lock);
211 static GWeakRef the_session_bus;
212 static GWeakRef the_system_bus;
214 /* Extra pseudo-member of GDBusSendMessageFlags.
215 * Set by initable_init() to indicate that despite not being initialized yet,
216 * enough of the only-valid-after-init members are set that we can send a
217 * message, and we're being called from its thread, so no memory barrier is
218 * required before accessing them.
220 #define SEND_MESSAGE_FLAGS_INITIALIZING (1<<31)
222 /* Same as SEND_MESSAGE_FLAGS_INITIALIZING, but in GDBusCallFlags */
223 #define CALL_FLAGS_INITIALIZING (1<<31)
225 /* ---------------------------------------------------------------------------------------------------- */
229 GDestroyNotify callback;
231 GMainContext *context;
232 } CallDestroyNotifyData;
235 call_destroy_notify_data_in_idle (gpointer user_data)
237 CallDestroyNotifyData *data = user_data;
238 data->callback (data->user_data);
243 call_destroy_notify_data_free (CallDestroyNotifyData *data)
245 if (data->context != NULL)
246 g_main_context_unref (data->context);
251 * call_destroy_notify: <internal>
252 * @context: (allow-none): A #GMainContext or %NULL.
253 * @callback: (allow-none): A #GDestroyNotify or %NULL.
254 * @user_data: Data to pass to @callback.
256 * Schedules @callback to run in @context.
259 call_destroy_notify (GMainContext *context,
260 GDestroyNotify callback,
263 GSource *idle_source;
264 CallDestroyNotifyData *data;
266 if (callback == NULL)
269 data = g_new0 (CallDestroyNotifyData, 1);
270 data->callback = callback;
271 data->user_data = user_data;
272 data->context = context;
273 if (data->context != NULL)
274 g_main_context_ref (data->context);
276 idle_source = g_idle_source_new ();
277 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
278 g_source_set_callback (idle_source,
279 call_destroy_notify_data_in_idle,
281 (GDestroyNotify) call_destroy_notify_data_free);
282 g_source_attach (idle_source, data->context);
283 g_source_unref (idle_source);
289 /* ---------------------------------------------------------------------------------------------------- */
292 _g_strv_has_string (const gchar* const *haystack,
297 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
299 if (g_strcmp0 (haystack[n], needle) == 0)
305 /* ---------------------------------------------------------------------------------------------------- */
308 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
310 // TODO: for some reason this doesn't work on Windows
311 #define CONNECTION_ENSURE_LOCK(obj) do { \
312 if (G_UNLIKELY (g_mutex_trylock(&(obj)->lock))) \
314 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
315 "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
320 #define CONNECTION_LOCK(obj) do { \
321 g_mutex_lock (&(obj)->lock); \
324 #define CONNECTION_UNLOCK(obj) do { \
325 g_mutex_unlock (&(obj)->lock); \
328 /* Flags in connection->atomic_flags */
330 FLAG_INITIALIZED = 1 << 0,
331 FLAG_EXIT_ON_CLOSE = 1 << 1,
338 * The #GDBusConnection structure contains only private data and
339 * should only be accessed using the provided API.
343 struct _GDBusConnection
346 GObject parent_instance;
348 /* ------------------------------------------------------------------------ */
349 /* -- General object state ------------------------------------------------ */
350 /* ------------------------------------------------------------------------ */
352 /* General-purpose lock for most fields */
355 /* A lock used in the init() method of the GInitable interface - see comments
356 * in initable_init() for why a separate lock is needed.
358 * If you need both @lock and @init_lock, you must take @init_lock first.
362 /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
363 * someone calls org.freedesktop.DBus.GetMachineId(). Protected by @lock.
367 /* The underlying stream used for communication
368 * Read-only after initable_init(), so it may be read if you either
369 * hold @init_lock or check for initialization first.
373 /* The object used for authentication (if any).
374 * Read-only after initable_init(), so it may be read if you either
375 * hold @init_lock or check for initialization first.
379 /* Last serial used. Protected by @lock. */
382 /* The object used to send/receive messages.
383 * Read-only after initable_init(), so it may be read if you either
384 * hold @init_lock or check for initialization first.
388 /* If connected to a message bus, this contains the unique name assigned to
389 * us by the bus (e.g. ":1.42").
390 * Read-only after initable_init(), so it may be read if you either
391 * hold @init_lock or check for initialization first.
393 gchar *bus_unique_name;
395 /* The GUID returned by the other side if we authenticed as a client or
396 * the GUID to use if authenticating as a server.
397 * Read-only after initable_init(), so it may be read if you either
398 * hold @init_lock or check for initialization first.
402 /* FLAG_INITIALIZED is set exactly when initable_init() has finished running.
403 * Inspect @initialization_error to see whether it succeeded or failed.
405 * FLAG_EXIT_ON_CLOSE is the exit-on-close property.
407 * FLAG_CLOSED is the closed property. It may be read at any time, but
408 * may only be written while holding @lock.
410 volatile gint atomic_flags;
412 /* If the connection could not be established during initable_init(),
413 * this GError will be set.
414 * Read-only after initable_init(), so it may be read if you either
415 * hold @init_lock or check for initialization first.
417 GError *initialization_error;
419 /* The result of g_main_context_ref_thread_default() when the object
420 * was created (the GObject _init() function) - this is used for delivery
421 * of the :closed GObject signal.
423 * Only set in the GObject init function, so no locks are needed.
425 GMainContext *main_context_at_construction;
427 /* Read-only construct properties, no locks needed */
429 GDBusConnectionFlags flags;
431 /* Map used for managing method replies, protected by @lock */
432 GHashTable *map_method_serial_to_send_message_data; /* guint32 -> SendMessageData* */
434 /* Maps used for managing signal subscription, protected by @lock */
435 GHashTable *map_rule_to_signal_data; /* match rule (gchar*) -> SignalData */
436 GHashTable *map_id_to_signal_data; /* id (guint) -> SignalData */
437 GHashTable *map_sender_unique_name_to_signal_data_array; /* unique sender (gchar*) -> GPtrArray* of SignalData */
439 /* Maps used for managing exported objects and subtrees,
442 GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
443 GHashTable *map_id_to_ei; /* guint -> ExportedInterface* */
444 GHashTable *map_object_path_to_es; /* gchar* -> ExportedSubtree* */
445 GHashTable *map_id_to_es; /* guint -> ExportedSubtree* */
447 /* Map used for storing last used serials for each thread, protected by @lock */
448 GHashTable *map_thread_to_last_serial;
450 /* Structure used for message filters, protected by @lock */
453 /* Capabilities negotiated during authentication
454 * Read-only after initable_init(), so it may be read without holding a
455 * lock, if you check for initialization first.
457 GDBusCapabilityFlags capabilities;
459 /* Protected by @init_lock */
460 GDBusAuthObserver *authentication_observer;
462 /* Read-only after initable_init(), so it may be read if you either
463 * hold @init_lock or check for initialization first.
465 GCredentials *credentials;
467 /* set to TRUE when finalizing */
471 typedef struct ExportedObject ExportedObject;
472 static void exported_object_free (ExportedObject *eo);
474 typedef struct ExportedSubtree ExportedSubtree;
475 static void exported_subtree_free (ExportedSubtree *es);
493 PROP_CAPABILITY_FLAGS,
494 PROP_AUTHENTICATION_OBSERVER,
497 static void distribute_signals (GDBusConnection *connection,
498 GDBusMessage *message);
500 static void distribute_method_call (GDBusConnection *connection,
501 GDBusMessage *message);
503 static gboolean handle_generic_unlocked (GDBusConnection *connection,
504 GDBusMessage *message);
507 static void purge_all_signal_subscriptions (GDBusConnection *connection);
508 static void purge_all_filters (GDBusConnection *connection);
510 #define _G_ENSURE_LOCK(name) do { \
511 if (G_UNLIKELY (G_TRYLOCK(name))) \
513 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
514 "_G_ENSURE_LOCK: Lock `" #name "' is not locked"); \
518 static guint signals[LAST_SIGNAL] = { 0 };
520 static void initable_iface_init (GInitableIface *initable_iface);
521 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
523 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
524 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
525 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
529 * Check that all members of @connection that can only be accessed after
530 * the connection is initialized can safely be accessed. If not,
531 * log a critical warning. This function is a memory barrier.
533 * Returns: %TRUE if initialized
536 check_initialized (GDBusConnection *connection)
538 /* The access to @atomic_flags isn't conditional, so that this function
539 * provides a memory barrier for thread-safety even if checks are disabled.
540 * (If you don't want this stricter guarantee, you can call
541 * g_return_if_fail (check_initialized (c)).)
543 * This isn't strictly necessary now that we've decided use of an
544 * uninitialized GDBusConnection is undefined behaviour, but it seems
545 * better to be as deterministic as is feasible.
547 * (Anything that could suffer a crash from seeing undefined values
548 * must have a race condition - thread A initializes the connection while
549 * thread B calls a method without initialization, hoping that thread A will
550 * win the race - so its behaviour is undefined anyway.)
552 gint flags = g_atomic_int_get (&connection->atomic_flags);
554 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
556 /* We can safely access this, due to the memory barrier above */
557 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
563 MAY_BE_UNINITIALIZED = (1<<1)
564 } CheckUnclosedFlags;
567 * Check the same thing as check_initialized(), and also that the
568 * connection is not closed. If the connection is uninitialized,
569 * raise a critical warning (it's programmer error); if it's closed,
570 * raise a recoverable GError (it's a runtime error).
572 * This function is a memory barrier.
574 * Returns: %TRUE if initialized and not closed
577 check_unclosed (GDBusConnection *connection,
578 CheckUnclosedFlags check,
581 /* check_initialized() is effectively inlined, so we don't waste time
582 * doing two memory barriers
584 gint flags = g_atomic_int_get (&connection->atomic_flags);
586 if (!(check & MAY_BE_UNINITIALIZED))
588 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
589 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
592 if (flags & FLAG_CLOSED)
594 g_set_error_literal (error,
597 _("The connection is closed"));
604 static GHashTable *alive_connections = NULL;
607 g_dbus_connection_dispose (GObject *object)
609 GDBusConnection *connection = G_DBUS_CONNECTION (object);
611 G_LOCK (message_bus_lock);
612 CONNECTION_LOCK (connection);
613 if (connection->worker != NULL)
615 _g_dbus_worker_stop (connection->worker);
616 connection->worker = NULL;
617 if (alive_connections != NULL)
618 g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
622 if (alive_connections != NULL)
623 g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
625 CONNECTION_UNLOCK (connection);
626 G_UNLOCK (message_bus_lock);
628 if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
629 G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
633 g_dbus_connection_finalize (GObject *object)
635 GDBusConnection *connection = G_DBUS_CONNECTION (object);
637 connection->finalizing = TRUE;
639 purge_all_signal_subscriptions (connection);
641 purge_all_filters (connection);
642 g_ptr_array_unref (connection->filters);
644 if (connection->authentication_observer != NULL)
645 g_object_unref (connection->authentication_observer);
647 if (connection->auth != NULL)
648 g_object_unref (connection->auth);
650 if (connection->credentials)
651 g_object_unref (connection->credentials);
653 if (connection->stream != NULL)
655 g_object_unref (connection->stream);
656 connection->stream = NULL;
659 g_free (connection->address);
661 g_free (connection->guid);
662 g_free (connection->bus_unique_name);
664 if (connection->initialization_error != NULL)
665 g_error_free (connection->initialization_error);
667 g_hash_table_unref (connection->map_method_serial_to_send_message_data);
669 g_hash_table_unref (connection->map_rule_to_signal_data);
670 g_hash_table_unref (connection->map_id_to_signal_data);
671 g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
673 g_hash_table_unref (connection->map_id_to_ei);
674 g_hash_table_unref (connection->map_object_path_to_eo);
675 g_hash_table_unref (connection->map_id_to_es);
676 g_hash_table_unref (connection->map_object_path_to_es);
678 g_hash_table_unref (connection->map_thread_to_last_serial);
680 g_main_context_unref (connection->main_context_at_construction);
682 g_free (connection->machine_id);
684 g_mutex_clear (&connection->init_lock);
685 g_mutex_clear (&connection->lock);
687 G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
690 /* called in any user thread, with the connection's lock not held */
692 g_dbus_connection_get_property (GObject *object,
697 GDBusConnection *connection = G_DBUS_CONNECTION (object);
702 g_value_set_object (value, g_dbus_connection_get_stream (connection));
706 g_value_set_string (value, g_dbus_connection_get_guid (connection));
709 case PROP_UNIQUE_NAME:
710 g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
714 g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
717 case PROP_EXIT_ON_CLOSE:
718 g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
721 case PROP_CAPABILITY_FLAGS:
722 g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
726 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
731 /* called in any user thread, with the connection's lock not held */
733 g_dbus_connection_set_property (GObject *object,
738 GDBusConnection *connection = G_DBUS_CONNECTION (object);
743 connection->stream = g_value_dup_object (value);
747 connection->guid = g_value_dup_string (value);
751 connection->address = g_value_dup_string (value);
755 connection->flags = g_value_get_flags (value);
758 case PROP_EXIT_ON_CLOSE:
759 g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
762 case PROP_AUTHENTICATION_OBSERVER:
763 connection->authentication_observer = g_value_dup_object (value);
767 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
772 /* Base-class implementation of GDBusConnection::closed.
774 * Called in a user thread, by the main context that was thread-default when
775 * the object was constructed.
778 g_dbus_connection_real_closed (GDBusConnection *connection,
779 gboolean remote_peer_vanished,
782 gint flags = g_atomic_int_get (&connection->atomic_flags);
784 /* Because atomic int access is a memory barrier, we can safely read
785 * initialization_error without a lock, as long as we do it afterwards.
787 if (remote_peer_vanished &&
788 (flags & FLAG_EXIT_ON_CLOSE) != 0 &&
789 (flags & FLAG_INITIALIZED) != 0 &&
790 connection->initialization_error == NULL)
794 g_print ("%s: Remote peer vanished with error: %s (%s, %d). Exiting.\n",
797 g_quark_to_string (error->domain), error->code);
801 g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
808 g_dbus_connection_class_init (GDBusConnectionClass *klass)
810 GObjectClass *gobject_class;
812 gobject_class = G_OBJECT_CLASS (klass);
814 gobject_class->finalize = g_dbus_connection_finalize;
815 gobject_class->dispose = g_dbus_connection_dispose;
816 gobject_class->set_property = g_dbus_connection_set_property;
817 gobject_class->get_property = g_dbus_connection_get_property;
819 klass->closed = g_dbus_connection_real_closed;
822 * GDBusConnection:stream:
824 * The underlying #GIOStream used for I/O.
826 * If this is passed on construction and is a #GSocketConnection,
827 * then the corresponding #GSocket will be put into non-blocking mode.
829 * While the #GDBusConnection is active, it will interact with this
830 * stream from a worker thread, so it is not safe to interact with
831 * the stream directly.
835 g_object_class_install_property (gobject_class,
837 g_param_spec_object ("stream",
839 P_("The underlying streams used for I/O"),
843 G_PARAM_CONSTRUCT_ONLY |
844 G_PARAM_STATIC_NAME |
845 G_PARAM_STATIC_BLURB |
846 G_PARAM_STATIC_NICK));
849 * GDBusConnection:address:
851 * A D-Bus address specifying potential endpoints that can be used
852 * when establishing the connection.
856 g_object_class_install_property (gobject_class,
858 g_param_spec_string ("address",
860 P_("D-Bus address specifying potential socket endpoints"),
863 G_PARAM_CONSTRUCT_ONLY |
864 G_PARAM_STATIC_NAME |
865 G_PARAM_STATIC_BLURB |
866 G_PARAM_STATIC_NICK));
869 * GDBusConnection:flags:
871 * Flags from the #GDBusConnectionFlags enumeration.
875 g_object_class_install_property (gobject_class,
877 g_param_spec_flags ("flags",
880 G_TYPE_DBUS_CONNECTION_FLAGS,
881 G_DBUS_CONNECTION_FLAGS_NONE,
883 G_PARAM_CONSTRUCT_ONLY |
884 G_PARAM_STATIC_NAME |
885 G_PARAM_STATIC_BLURB |
886 G_PARAM_STATIC_NICK));
889 * GDBusConnection:guid:
891 * The GUID of the peer performing the role of server when
894 * If you are constructing a #GDBusConnection and pass
895 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
896 * #GDBusConnection:flags property then you MUST also set this
897 * property to a valid guid.
899 * If you are constructing a #GDBusConnection and pass
900 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
901 * #GDBusConnection:flags property you will be able to read the GUID
902 * of the other peer here after the connection has been successfully
907 g_object_class_install_property (gobject_class,
909 g_param_spec_string ("guid",
911 P_("GUID of the server peer"),
915 G_PARAM_CONSTRUCT_ONLY |
916 G_PARAM_STATIC_NAME |
917 G_PARAM_STATIC_BLURB |
918 G_PARAM_STATIC_NICK));
921 * GDBusConnection:unique-name:
923 * The unique name as assigned by the message bus or %NULL if the
924 * connection is not open or not a message bus connection.
928 g_object_class_install_property (gobject_class,
930 g_param_spec_string ("unique-name",
932 P_("Unique name of bus connection"),
935 G_PARAM_STATIC_NAME |
936 G_PARAM_STATIC_BLURB |
937 G_PARAM_STATIC_NICK));
940 * GDBusConnection:closed:
942 * A boolean specifying whether the connection has been closed.
946 g_object_class_install_property (gobject_class,
948 g_param_spec_boolean ("closed",
950 P_("Whether the connection is closed"),
953 G_PARAM_STATIC_NAME |
954 G_PARAM_STATIC_BLURB |
955 G_PARAM_STATIC_NICK));
958 * GDBusConnection:exit-on-close:
960 * A boolean specifying whether the process will be terminated (by
961 * calling <literal>raise(SIGTERM)</literal>) if the connection
962 * is closed by the remote peer.
964 * Note that #GDBusConnection objects returned by g_bus_get_finish() and
965 * g_bus_get_sync() will (usually) have this property set to %TRUE.
969 g_object_class_install_property (gobject_class,
971 g_param_spec_boolean ("exit-on-close",
973 P_("Whether the process is terminated when the connection is closed"),
977 G_PARAM_STATIC_NAME |
978 G_PARAM_STATIC_BLURB |
979 G_PARAM_STATIC_NICK));
982 * GDBusConnection:capabilities:
984 * Flags from the #GDBusCapabilityFlags enumeration
985 * representing connection features negotiated with the other peer.
989 g_object_class_install_property (gobject_class,
990 PROP_CAPABILITY_FLAGS,
991 g_param_spec_flags ("capabilities",
994 G_TYPE_DBUS_CAPABILITY_FLAGS,
995 G_DBUS_CAPABILITY_FLAGS_NONE,
997 G_PARAM_STATIC_NAME |
998 G_PARAM_STATIC_BLURB |
999 G_PARAM_STATIC_NICK));
1002 * GDBusConnection:authentication-observer:
1004 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
1008 g_object_class_install_property (gobject_class,
1009 PROP_AUTHENTICATION_OBSERVER,
1010 g_param_spec_object ("authentication-observer",
1011 P_("Authentication Observer"),
1012 P_("Object used to assist in the authentication process"),
1013 G_TYPE_DBUS_AUTH_OBSERVER,
1015 G_PARAM_CONSTRUCT_ONLY |
1016 G_PARAM_STATIC_NAME |
1017 G_PARAM_STATIC_BLURB |
1018 G_PARAM_STATIC_NICK));
1021 * GDBusConnection::closed:
1022 * @connection: The #GDBusConnection emitting the signal.
1023 * @remote_peer_vanished: %TRUE if @connection is closed because the
1024 * remote peer closed its end of the connection.
1025 * @error: (allow-none): A #GError with more details about the event or %NULL.
1027 * Emitted when the connection is closed.
1029 * The cause of this event can be
1032 * If g_dbus_connection_close() is called. In this case
1033 * @remote_peer_vanished is set to %FALSE and @error is %NULL.
1034 * </para></listitem>
1036 * If the remote peer closes the connection. In this case
1037 * @remote_peer_vanished is set to %TRUE and @error is set.
1038 * </para></listitem>
1040 * If the remote peer sends invalid or malformed data. In this
1041 * case @remote_peer_vanished is set to %FALSE and @error
1043 * </para></listitem>
1046 * Upon receiving this signal, you should give up your reference to
1047 * @connection. You are guaranteed that this signal is emitted only
1052 signals[CLOSED_SIGNAL] = g_signal_new ("closed",
1053 G_TYPE_DBUS_CONNECTION,
1055 G_STRUCT_OFFSET (GDBusConnectionClass, closed),
1066 g_dbus_connection_init (GDBusConnection *connection)
1068 g_mutex_init (&connection->lock);
1069 g_mutex_init (&connection->init_lock);
1071 connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
1073 connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
1075 connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
1077 connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
1080 (GDestroyNotify) g_ptr_array_unref);
1082 connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
1085 (GDestroyNotify) exported_object_free);
1087 connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
1090 connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
1093 (GDestroyNotify) exported_subtree_free);
1095 connection->map_id_to_es = g_hash_table_new (g_direct_hash,
1098 connection->map_thread_to_last_serial = g_hash_table_new (g_direct_hash,
1101 connection->main_context_at_construction = g_main_context_ref_thread_default ();
1103 connection->filters = g_ptr_array_new ();
1107 * g_dbus_connection_get_stream:
1108 * @connection: a #GDBusConnection
1110 * Gets the underlying stream used for IO.
1112 * While the #GDBusConnection is active, it will interact with this
1113 * stream from a worker thread, so it is not safe to interact with
1114 * the stream directly.
1116 * Returns: (transfer none): the stream used for IO
1121 g_dbus_connection_get_stream (GDBusConnection *connection)
1123 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1125 /* do not use g_return_val_if_fail(), we want the memory barrier */
1126 if (!check_initialized (connection))
1129 return connection->stream;
1133 * g_dbus_connection_start_message_processing:
1134 * @connection: A #GDBusConnection.
1136 * If @connection was created with
1137 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
1138 * starts processing messages. Does nothing on if @connection wasn't
1139 * created with this flag or if the method has already been called.
1144 g_dbus_connection_start_message_processing (GDBusConnection *connection)
1146 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1148 /* do not use g_return_val_if_fail(), we want the memory barrier */
1149 if (!check_initialized (connection))
1152 g_assert (connection->worker != NULL);
1153 _g_dbus_worker_unfreeze (connection->worker);
1157 * g_dbus_connection_is_closed:
1158 * @connection: A #GDBusConnection.
1160 * Gets whether @connection is closed.
1162 * Returns: %TRUE if the connection is closed, %FALSE otherwise.
1167 g_dbus_connection_is_closed (GDBusConnection *connection)
1171 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1173 flags = g_atomic_int_get (&connection->atomic_flags);
1175 return (flags & FLAG_CLOSED) ? TRUE : FALSE;
1179 * g_dbus_connection_get_capabilities:
1180 * @connection: A #GDBusConnection.
1182 * Gets the capabilities negotiated with the remote peer
1184 * Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration.
1188 GDBusCapabilityFlags
1189 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1191 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1193 /* do not use g_return_val_if_fail(), we want the memory barrier */
1194 if (!check_initialized (connection))
1195 return G_DBUS_CAPABILITY_FLAGS_NONE;
1197 return connection->capabilities;
1200 /* ---------------------------------------------------------------------------------------------------- */
1202 /* Called in a temporary thread without holding locks. */
1204 flush_in_thread_func (GSimpleAsyncResult *res,
1206 GCancellable *cancellable)
1211 if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
1214 g_simple_async_result_take_error (res, error);
1218 * g_dbus_connection_flush:
1219 * @connection: A #GDBusConnection.
1220 * @cancellable: (allow-none): A #GCancellable or %NULL.
1221 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1222 * satisfied or %NULL if you don't care about the result.
1223 * @user_data: The data to pass to @callback.
1225 * Asynchronously flushes @connection, that is, writes all queued
1226 * outgoing message to the transport and then flushes the transport
1227 * (using g_output_stream_flush_async()). This is useful in programs
1228 * that wants to emit a D-Bus signal and then exit
1229 * immediately. Without flushing the connection, there is no guarantee
1230 * that the message has been sent to the networking buffers in the OS
1233 * This is an asynchronous method. When the operation is finished,
1234 * @callback will be invoked in the <link
1235 * linkend="g-main-context-push-thread-default">thread-default main
1236 * loop</link> of the thread you are calling this method from. You can
1237 * then call g_dbus_connection_flush_finish() to get the result of the
1238 * operation. See g_dbus_connection_flush_sync() for the synchronous
1244 g_dbus_connection_flush (GDBusConnection *connection,
1245 GCancellable *cancellable,
1246 GAsyncReadyCallback callback,
1249 GSimpleAsyncResult *simple;
1251 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1253 simple = g_simple_async_result_new (G_OBJECT (connection),
1256 g_dbus_connection_flush);
1257 g_simple_async_result_set_check_cancellable (simple, cancellable);
1258 g_simple_async_result_run_in_thread (simple,
1259 flush_in_thread_func,
1262 g_object_unref (simple);
1266 * g_dbus_connection_flush_finish:
1267 * @connection: A #GDBusConnection.
1268 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush().
1269 * @error: Return location for error or %NULL.
1271 * Finishes an operation started with g_dbus_connection_flush().
1273 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1278 g_dbus_connection_flush_finish (GDBusConnection *connection,
1282 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1287 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1288 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1289 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1291 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
1293 if (g_simple_async_result_propagate_error (simple, error))
1303 * g_dbus_connection_flush_sync:
1304 * @connection: A #GDBusConnection.
1305 * @cancellable: (allow-none): A #GCancellable or %NULL.
1306 * @error: Return location for error or %NULL.
1308 * Synchronously flushes @connection. The calling thread is blocked
1309 * until this is done. See g_dbus_connection_flush() for the
1310 * asynchronous version of this method and more details about what it
1313 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1318 g_dbus_connection_flush_sync (GDBusConnection *connection,
1319 GCancellable *cancellable,
1324 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1325 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1329 /* This is only a best-effort attempt to see whether the connection is
1330 * closed, so it doesn't need the lock. If the connection closes just
1331 * after this check, but before scheduling the flush operation, the
1332 * result will be more or less the same as if the connection closed while
1333 * the flush operation was pending - it'll fail with either CLOSED or
1336 if (!check_unclosed (connection, 0, error))
1339 g_assert (connection->worker != NULL);
1341 ret = _g_dbus_worker_flush_sync (connection->worker,
1349 /* ---------------------------------------------------------------------------------------------------- */
1353 GDBusConnection *connection;
1355 gboolean remote_peer_vanished;
1359 emit_closed_data_free (EmitClosedData *data)
1361 g_object_unref (data->connection);
1362 if (data->error != NULL)
1363 g_error_free (data->error);
1367 /* Called in a user thread that has acquired the main context that was
1368 * thread-default when the object was constructed
1371 emit_closed_in_idle (gpointer user_data)
1373 EmitClosedData *data = user_data;
1376 g_object_notify (G_OBJECT (data->connection), "closed");
1377 g_signal_emit (data->connection,
1378 signals[CLOSED_SIGNAL],
1380 data->remote_peer_vanished,
1386 /* Can be called from any thread, must hold lock.
1387 * FLAG_CLOSED must already have been set.
1390 schedule_closed_unlocked (GDBusConnection *connection,
1391 gboolean remote_peer_vanished,
1394 GSource *idle_source;
1395 EmitClosedData *data;
1397 CONNECTION_ENSURE_LOCK (connection);
1399 data = g_new0 (EmitClosedData, 1);
1400 data->connection = g_object_ref (connection);
1401 data->remote_peer_vanished = remote_peer_vanished;
1402 data->error = error != NULL ? g_error_copy (error) : NULL;
1404 idle_source = g_idle_source_new ();
1405 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1406 g_source_set_callback (idle_source,
1407 emit_closed_in_idle,
1409 (GDestroyNotify) emit_closed_data_free);
1410 g_source_attach (idle_source, connection->main_context_at_construction);
1411 g_source_unref (idle_source);
1414 /* ---------------------------------------------------------------------------------------------------- */
1417 * g_dbus_connection_close:
1418 * @connection: A #GDBusConnection.
1419 * @cancellable: (allow-none): A #GCancellable or %NULL.
1420 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1421 * satisfied or %NULL if you don't care about the result.
1422 * @user_data: The data to pass to @callback.
1424 * Closes @connection. Note that this never causes the process to
1425 * exit (this might only happen if the other end of a shared message
1426 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1428 * Once the connection is closed, operations such as sending a message
1429 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1430 * will not automatically flush the connection so queued messages may
1431 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1433 * If @connection is already closed, this method fails with
1434 * %G_IO_ERROR_CLOSED.
1436 * When @connection has been closed, the #GDBusConnection::closed
1437 * signal is emitted in the <link
1438 * linkend="g-main-context-push-thread-default">thread-default main
1439 * loop</link> of the thread that @connection was constructed in.
1441 * This is an asynchronous method. When the operation is finished,
1442 * @callback will be invoked in the <link
1443 * linkend="g-main-context-push-thread-default">thread-default main
1444 * loop</link> of the thread you are calling this method from. You can
1445 * then call g_dbus_connection_close_finish() to get the result of the
1446 * operation. See g_dbus_connection_close_sync() for the synchronous
1452 g_dbus_connection_close (GDBusConnection *connection,
1453 GCancellable *cancellable,
1454 GAsyncReadyCallback callback,
1457 GSimpleAsyncResult *simple;
1459 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1461 /* do not use g_return_val_if_fail(), we want the memory barrier */
1462 if (!check_initialized (connection))
1465 g_assert (connection->worker != NULL);
1467 simple = g_simple_async_result_new (G_OBJECT (connection),
1470 g_dbus_connection_close);
1471 g_simple_async_result_set_check_cancellable (simple, cancellable);
1472 _g_dbus_worker_close (connection->worker, cancellable, simple);
1473 g_object_unref (simple);
1477 * g_dbus_connection_close_finish:
1478 * @connection: A #GDBusConnection.
1479 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close().
1480 * @error: Return location for error or %NULL.
1482 * Finishes an operation started with g_dbus_connection_close().
1484 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1489 g_dbus_connection_close_finish (GDBusConnection *connection,
1493 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1498 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1499 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1500 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1502 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
1504 if (g_simple_async_result_propagate_error (simple, error))
1515 GAsyncResult *result;
1518 /* Can be called by any thread, without the connection lock */
1520 sync_close_cb (GObject *source_object,
1524 SyncCloseData *data = user_data;
1526 data->result = g_object_ref (res);
1527 g_main_loop_quit (data->loop);
1531 * g_dbus_connection_close_sync:
1532 * @connection: A #GDBusConnection.
1533 * @cancellable: (allow-none): A #GCancellable or %NULL.
1534 * @error: Return location for error or %NULL.
1536 * Synchronously closees @connection. The calling thread is blocked
1537 * until this is done. See g_dbus_connection_close() for the
1538 * asynchronous version of this method and more details about what it
1541 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1546 g_dbus_connection_close_sync (GDBusConnection *connection,
1547 GCancellable *cancellable,
1552 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1553 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1557 if (check_unclosed (connection, 0, error))
1559 GMainContext *context;
1562 context = g_main_context_new ();
1563 g_main_context_push_thread_default (context);
1564 data.loop = g_main_loop_new (context, TRUE);
1567 g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
1568 g_main_loop_run (data.loop);
1569 ret = g_dbus_connection_close_finish (connection, data.result, error);
1571 g_object_unref (data.result);
1572 g_main_loop_unref (data.loop);
1573 g_main_context_pop_thread_default (context);
1574 g_main_context_unref (context);
1580 /* ---------------------------------------------------------------------------------------------------- */
1583 * g_dbus_connection_get_last_serial:
1584 * @connection: A #GDBusConnection.
1586 * Retrieves the last serial number assigned to a #GDBusMessage on
1587 * the current thread. This includes messages sent via both low-level
1588 * API such as g_dbus_connection_send_message() as well as
1589 * high-level API such as g_dbus_connection_emit_signal(),
1590 * g_dbus_connection_call() or g_dbus_proxy_call().
1592 * Returns: the last used serial or zero when no message has been sent
1593 * within the current thread.
1598 g_dbus_connection_get_last_serial (GDBusConnection *connection)
1602 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
1604 CONNECTION_LOCK (connection);
1605 ret = GPOINTER_TO_UINT (g_hash_table_lookup (connection->map_thread_to_last_serial,
1607 CONNECTION_UNLOCK (connection);
1612 /* ---------------------------------------------------------------------------------------------------- */
1614 /* Can be called by any thread, with the connection lock held */
1616 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
1617 GDBusMessage *message,
1618 GDBusSendMessageFlags flags,
1619 volatile guint32 *out_serial,
1624 guint32 serial_to_use;
1627 CONNECTION_ENSURE_LOCK (connection);
1629 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1630 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1632 /* TODO: check all necessary headers are present */
1637 if (out_serial != NULL)
1640 /* If we're in initable_init(), don't check for being initialized, to avoid
1641 * chicken-and-egg problems. initable_init() is responsible for setting up
1642 * our prerequisites (mainly connection->worker), and only calling us
1643 * from its own thread (so no memory barrier is needed).
1645 if (!check_unclosed (connection,
1646 (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
1650 blob = g_dbus_message_to_blob (message,
1652 connection->capabilities,
1657 if (flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL)
1658 serial_to_use = g_dbus_message_get_serial (message);
1660 serial_to_use = ++connection->last_serial; /* TODO: handle overflow */
1665 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
1668 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
1671 g_assert_not_reached ();
1676 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
1677 blob_size, serial_to_use, connection);
1678 g_printerr ("----\n");
1679 hexdump (blob, blob_size);
1680 g_printerr ("----\n");
1683 /* TODO: use connection->auth to encode the blob */
1685 if (out_serial != NULL)
1686 *out_serial = serial_to_use;
1688 /* store used serial for the current thread */
1689 /* TODO: watch the thread disposal and remove associated record
1691 * - see https://bugzilla.gnome.org/show_bug.cgi?id=676825#c7
1693 g_hash_table_replace (connection->map_thread_to_last_serial,
1695 GUINT_TO_POINTER (serial_to_use));
1697 if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
1698 g_dbus_message_set_serial (message, serial_to_use);
1700 g_dbus_message_lock (message);
1701 _g_dbus_worker_send_message (connection->worker,
1705 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
1716 * g_dbus_connection_send_message:
1717 * @connection: A #GDBusConnection.
1718 * @message: A #GDBusMessage
1719 * @flags: Flags affecting how the message is sent.
1720 * @out_serial: (out) (allow-none): Return location for serial number assigned
1721 * to @message when sending it or %NULL.
1722 * @error: Return location for error or %NULL.
1724 * Asynchronously sends @message to the peer represented by @connection.
1726 * Unless @flags contain the
1727 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1728 * will be assigned by @connection and set on @message via
1729 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1730 * serial number used will be written to this location prior to
1731 * submitting the message to the underlying transport.
1733 * If @connection is closed then the operation will fail with
1734 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
1735 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1737 * See <xref linkend="gdbus-server"/> and <xref
1738 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1739 * low-level API to send and receive UNIX file descriptors.
1741 * Note that @message must be unlocked, unless @flags contain the
1742 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1744 * Returns: %TRUE if the message was well-formed and queued for
1745 * transmission, %FALSE if @error is set.
1750 g_dbus_connection_send_message (GDBusConnection *connection,
1751 GDBusMessage *message,
1752 GDBusSendMessageFlags flags,
1753 volatile guint32 *out_serial,
1758 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1759 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1760 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
1761 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1763 CONNECTION_LOCK (connection);
1764 ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
1765 CONNECTION_UNLOCK (connection);
1769 /* ---------------------------------------------------------------------------------------------------- */
1773 volatile gint ref_count;
1774 GDBusConnection *connection;
1776 GSimpleAsyncResult *simple;
1778 GMainContext *main_context;
1780 GCancellable *cancellable;
1782 gulong cancellable_handler_id;
1784 GSource *timeout_source;
1789 /* Can be called from any thread with or without lock held */
1790 static SendMessageData *
1791 send_message_data_ref (SendMessageData *data)
1793 g_atomic_int_inc (&data->ref_count);
1797 /* Can be called from any thread with or without lock held */
1799 send_message_data_unref (SendMessageData *data)
1801 if (g_atomic_int_dec_and_test (&data->ref_count))
1803 g_assert (data->timeout_source == NULL);
1804 g_assert (data->simple == NULL);
1805 g_assert (data->cancellable_handler_id == 0);
1806 g_object_unref (data->connection);
1807 if (data->cancellable != NULL)
1808 g_object_unref (data->cancellable);
1809 g_main_context_unref (data->main_context);
1814 /* ---------------------------------------------------------------------------------------------------- */
1816 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
1818 send_message_with_reply_deliver (SendMessageData *data, gboolean remove)
1820 CONNECTION_ENSURE_LOCK (data->connection);
1822 g_assert (!data->delivered);
1824 data->delivered = TRUE;
1826 g_simple_async_result_complete_in_idle (data->simple);
1827 g_object_unref (data->simple);
1828 data->simple = NULL;
1830 if (data->timeout_source != NULL)
1832 g_source_destroy (data->timeout_source);
1833 data->timeout_source = NULL;
1835 if (data->cancellable_handler_id > 0)
1837 g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
1838 data->cancellable_handler_id = 0;
1843 g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
1844 GUINT_TO_POINTER (data->serial)));
1847 send_message_data_unref (data);
1850 /* ---------------------------------------------------------------------------------------------------- */
1852 /* Can be called from any thread with lock held */
1854 send_message_data_deliver_reply_unlocked (SendMessageData *data,
1855 GDBusMessage *reply)
1857 if (data->delivered)
1860 g_simple_async_result_set_op_res_gpointer (data->simple,
1861 g_object_ref (reply),
1864 send_message_with_reply_deliver (data, TRUE);
1870 /* ---------------------------------------------------------------------------------------------------- */
1872 /* Called from a user thread, lock is not held */
1874 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
1876 SendMessageData *data = user_data;
1878 CONNECTION_LOCK (data->connection);
1879 if (data->delivered)
1882 g_simple_async_result_set_error (data->simple,
1884 G_IO_ERROR_CANCELLED,
1885 _("Operation was cancelled"));
1887 send_message_with_reply_deliver (data, TRUE);
1890 CONNECTION_UNLOCK (data->connection);
1894 /* Can be called from any thread with or without lock held */
1896 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
1899 SendMessageData *data = user_data;
1900 GSource *idle_source;
1902 /* postpone cancellation to idle handler since we may be called directly
1903 * via g_cancellable_connect() (e.g. holding lock)
1905 idle_source = g_idle_source_new ();
1906 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1907 g_source_set_callback (idle_source,
1908 send_message_with_reply_cancelled_idle_cb,
1909 send_message_data_ref (data),
1910 (GDestroyNotify) send_message_data_unref);
1911 g_source_attach (idle_source, data->main_context);
1912 g_source_unref (idle_source);
1915 /* ---------------------------------------------------------------------------------------------------- */
1917 /* Called from a user thread, lock is not held */
1919 send_message_with_reply_timeout_cb (gpointer user_data)
1921 SendMessageData *data = user_data;
1923 CONNECTION_LOCK (data->connection);
1924 if (data->delivered)
1927 g_simple_async_result_set_error (data->simple,
1929 G_IO_ERROR_TIMED_OUT,
1930 _("Timeout was reached"));
1932 send_message_with_reply_deliver (data, TRUE);
1935 CONNECTION_UNLOCK (data->connection);
1940 /* ---------------------------------------------------------------------------------------------------- */
1942 /* Called from a user thread, connection's lock is held */
1944 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
1945 GDBusMessage *message,
1946 GDBusSendMessageFlags flags,
1948 volatile guint32 *out_serial,
1949 GCancellable *cancellable,
1950 GAsyncReadyCallback callback,
1953 GSimpleAsyncResult *simple;
1954 SendMessageData *data;
1956 volatile guint32 serial;
1960 if (out_serial == NULL)
1961 out_serial = &serial;
1963 if (timeout_msec == -1)
1964 timeout_msec = 25 * 1000;
1966 simple = g_simple_async_result_new (G_OBJECT (connection),
1969 g_dbus_connection_send_message_with_reply);
1970 g_simple_async_result_set_check_cancellable (simple, cancellable);
1972 if (g_cancellable_is_cancelled (cancellable))
1974 g_simple_async_result_set_error (simple,
1976 G_IO_ERROR_CANCELLED,
1977 _("Operation was cancelled"));
1978 g_simple_async_result_complete_in_idle (simple);
1979 g_object_unref (simple);
1984 if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
1986 g_simple_async_result_take_error (simple, error);
1987 g_simple_async_result_complete_in_idle (simple);
1988 g_object_unref (simple);
1992 data = g_new0 (SendMessageData, 1);
1993 data->ref_count = 1;
1994 data->connection = g_object_ref (connection);
1995 data->simple = simple;
1996 data->serial = *out_serial;
1997 data->main_context = g_main_context_ref_thread_default ();
1999 if (cancellable != NULL)
2001 data->cancellable = g_object_ref (cancellable);
2002 data->cancellable_handler_id = g_cancellable_connect (cancellable,
2003 G_CALLBACK (send_message_with_reply_cancelled_cb),
2004 send_message_data_ref (data),
2005 (GDestroyNotify) send_message_data_unref);
2008 if (timeout_msec != G_MAXINT)
2010 data->timeout_source = g_timeout_source_new (timeout_msec);
2011 g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
2012 g_source_set_callback (data->timeout_source,
2013 send_message_with_reply_timeout_cb,
2014 send_message_data_ref (data),
2015 (GDestroyNotify) send_message_data_unref);
2016 g_source_attach (data->timeout_source, data->main_context);
2017 g_source_unref (data->timeout_source);
2020 g_hash_table_insert (connection->map_method_serial_to_send_message_data,
2021 GUINT_TO_POINTER (*out_serial),
2029 * g_dbus_connection_send_message_with_reply:
2030 * @connection: A #GDBusConnection.
2031 * @message: A #GDBusMessage.
2032 * @flags: Flags affecting how the message is sent.
2033 * @timeout_msec: The timeout in milliseconds, -1 to use the default
2034 * timeout or %G_MAXINT for no timeout.
2035 * @out_serial: (out) (allow-none): Return location for serial number assigned
2036 * to @message when sending it or %NULL.
2037 * @cancellable: (allow-none): A #GCancellable or %NULL.
2038 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
2039 * satisfied or %NULL if you don't care about the result.
2040 * @user_data: The data to pass to @callback.
2042 * Asynchronously sends @message to the peer represented by @connection.
2044 * Unless @flags contain the
2045 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2046 * will be assigned by @connection and set on @message via
2047 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2048 * serial number used will be written to this location prior to
2049 * submitting the message to the underlying transport.
2051 * If @connection is closed then the operation will fail with
2052 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2053 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2054 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2056 * This is an asynchronous method. When the operation is finished, @callback will be invoked
2057 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
2058 * of the thread you are calling this method from. You can then call
2059 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
2060 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
2062 * Note that @message must be unlocked, unless @flags contain the
2063 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2065 * See <xref linkend="gdbus-server"/> and <xref
2066 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2067 * low-level API to send and receive UNIX file descriptors.
2072 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
2073 GDBusMessage *message,
2074 GDBusSendMessageFlags flags,
2076 volatile guint32 *out_serial,
2077 GCancellable *cancellable,
2078 GAsyncReadyCallback callback,
2081 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2082 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2083 g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
2084 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
2086 CONNECTION_LOCK (connection);
2087 g_dbus_connection_send_message_with_reply_unlocked (connection,
2095 CONNECTION_UNLOCK (connection);
2099 * g_dbus_connection_send_message_with_reply_finish:
2100 * @connection: a #GDBusConnection
2101 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
2102 * @error: Return location for error or %NULL.
2104 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
2106 * Note that @error is only set if a local in-process error
2107 * occurred. That is to say that the returned #GDBusMessage object may
2108 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2109 * g_dbus_message_to_gerror() to transcode this to a #GError.
2111 * See <xref linkend="gdbus-server"/> and <xref
2112 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2113 * low-level API to send and receive UNIX file descriptors.
2115 * Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set.
2120 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
2124 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2125 GDBusMessage *reply;
2127 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2128 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2132 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
2134 if (g_simple_async_result_propagate_error (simple, error))
2137 reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
2143 /* ---------------------------------------------------------------------------------------------------- */
2148 GMainContext *context;
2150 } SendMessageSyncData;
2152 /* Called from a user thread, lock is not held */
2154 send_message_with_reply_sync_cb (GDBusConnection *connection,
2158 SendMessageSyncData *data = user_data;
2159 data->res = g_object_ref (res);
2160 g_main_loop_quit (data->loop);
2164 * g_dbus_connection_send_message_with_reply_sync:
2165 * @connection: A #GDBusConnection.
2166 * @message: A #GDBusMessage.
2167 * @flags: Flags affecting how the message is sent.
2168 * @timeout_msec: The timeout in milliseconds, -1 to use the default
2169 * timeout or %G_MAXINT for no timeout.
2170 * @out_serial: (out) (allow-none): Return location for serial number assigned
2171 * to @message when sending it or %NULL.
2172 * @cancellable: (allow-none): A #GCancellable or %NULL.
2173 * @error: Return location for error or %NULL.
2175 * Synchronously sends @message to the peer represented by @connection
2176 * and blocks the calling thread until a reply is received or the
2177 * timeout is reached. See g_dbus_connection_send_message_with_reply()
2178 * for the asynchronous version of this method.
2180 * Unless @flags contain the
2181 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2182 * will be assigned by @connection and set on @message via
2183 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2184 * serial number used will be written to this location prior to
2185 * submitting the message to the underlying transport.
2187 * If @connection is closed then the operation will fail with
2188 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2189 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2190 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2192 * Note that @error is only set if a local in-process error
2193 * occurred. That is to say that the returned #GDBusMessage object may
2194 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2195 * g_dbus_message_to_gerror() to transcode this to a #GError.
2197 * See <xref linkend="gdbus-server"/> and <xref
2198 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2199 * low-level API to send and receive UNIX file descriptors.
2201 * Note that @message must be unlocked, unless @flags contain the
2202 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2204 * Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.
2209 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
2210 GDBusMessage *message,
2211 GDBusSendMessageFlags flags,
2213 volatile guint32 *out_serial,
2214 GCancellable *cancellable,
2217 SendMessageSyncData *data;
2218 GDBusMessage *reply;
2220 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2221 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2222 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
2223 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2224 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2226 data = g_new0 (SendMessageSyncData, 1);
2227 data->context = g_main_context_new ();
2228 data->loop = g_main_loop_new (data->context, FALSE);
2230 g_main_context_push_thread_default (data->context);
2232 g_dbus_connection_send_message_with_reply (connection,
2238 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2240 g_main_loop_run (data->loop);
2241 reply = g_dbus_connection_send_message_with_reply_finish (connection,
2245 g_main_context_pop_thread_default (data->context);
2247 g_main_context_unref (data->context);
2248 g_main_loop_unref (data->loop);
2249 g_object_unref (data->res);
2255 /* ---------------------------------------------------------------------------------------------------- */
2259 GDBusMessageFilterFunction func;
2266 GDBusMessageFilterFunction filter_function;
2268 GDestroyNotify user_data_free_func;
2271 /* Called in GDBusWorker's thread - we must not block - with no lock held */
2273 on_worker_message_received (GDBusWorker *worker,
2274 GDBusMessage *message,
2277 GDBusConnection *connection;
2278 FilterCallback *filters;
2283 G_LOCK (message_bus_lock);
2284 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2287 G_UNLOCK (message_bus_lock);
2290 connection = G_DBUS_CONNECTION (user_data);
2291 g_object_ref (connection);
2292 G_UNLOCK (message_bus_lock);
2294 //g_debug ("in on_worker_message_received");
2296 g_object_ref (message);
2297 g_dbus_message_lock (message);
2299 //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2301 /* First collect the set of callback functions */
2302 CONNECTION_LOCK (connection);
2303 num_filters = connection->filters->len;
2304 filters = g_new0 (FilterCallback, num_filters);
2305 for (n = 0; n < num_filters; n++)
2307 FilterData *data = connection->filters->pdata[n];
2308 filters[n].func = data->filter_function;
2309 filters[n].user_data = data->user_data;
2311 CONNECTION_UNLOCK (connection);
2313 /* then call the filters in order (without holding the lock) */
2314 for (n = 0; n < num_filters; n++)
2316 message = filters[n].func (connection,
2319 filters[n].user_data);
2320 if (message == NULL)
2322 g_dbus_message_lock (message);
2325 /* Standard dispatch unless the filter ate the message - no need to
2326 * do anything if the message was altered
2328 if (message != NULL)
2330 GDBusMessageType message_type;
2332 message_type = g_dbus_message_get_message_type (message);
2333 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2335 guint32 reply_serial;
2336 SendMessageData *send_message_data;
2338 reply_serial = g_dbus_message_get_reply_serial (message);
2339 CONNECTION_LOCK (connection);
2340 send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
2341 GUINT_TO_POINTER (reply_serial));
2342 if (send_message_data != NULL)
2344 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2345 send_message_data_deliver_reply_unlocked (send_message_data, message);
2349 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2351 CONNECTION_UNLOCK (connection);
2353 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2355 CONNECTION_LOCK (connection);
2356 distribute_signals (connection, message);
2357 CONNECTION_UNLOCK (connection);
2359 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2361 CONNECTION_LOCK (connection);
2362 distribute_method_call (connection, message);
2363 CONNECTION_UNLOCK (connection);
2367 if (message != NULL)
2368 g_object_unref (message);
2369 g_object_unref (connection);
2373 /* Called in GDBusWorker's thread, lock is not held */
2374 static GDBusMessage *
2375 on_worker_message_about_to_be_sent (GDBusWorker *worker,
2376 GDBusMessage *message,
2379 GDBusConnection *connection;
2380 FilterCallback *filters;
2385 G_LOCK (message_bus_lock);
2386 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2389 G_UNLOCK (message_bus_lock);
2392 connection = G_DBUS_CONNECTION (user_data);
2393 g_object_ref (connection);
2394 G_UNLOCK (message_bus_lock);
2396 //g_debug ("in on_worker_message_about_to_be_sent");
2398 /* First collect the set of callback functions */
2399 CONNECTION_LOCK (connection);
2400 num_filters = connection->filters->len;
2401 filters = g_new0 (FilterCallback, num_filters);
2402 for (n = 0; n < num_filters; n++)
2404 FilterData *data = connection->filters->pdata[n];
2405 filters[n].func = data->filter_function;
2406 filters[n].user_data = data->user_data;
2408 CONNECTION_UNLOCK (connection);
2410 /* then call the filters in order (without holding the lock) */
2411 for (n = 0; n < num_filters; n++)
2413 g_dbus_message_lock (message);
2414 message = filters[n].func (connection,
2417 filters[n].user_data);
2418 if (message == NULL)
2422 g_object_unref (connection);
2428 /* called with connection lock held, in GDBusWorker thread */
2430 cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
2432 SendMessageData *data = value;
2434 if (data->delivered)
2437 g_simple_async_result_set_error (data->simple,
2440 _("The connection is closed"));
2442 /* Ask send_message_with_reply_deliver not to remove the element from the
2443 * hash table - we're in the middle of a foreach; that would be unsafe.
2444 * Instead, return TRUE from this function so that it gets removed safely.
2446 send_message_with_reply_deliver (data, FALSE);
2450 /* Called in GDBusWorker's thread - we must not block - without lock held */
2452 on_worker_closed (GDBusWorker *worker,
2453 gboolean remote_peer_vanished,
2457 GDBusConnection *connection;
2459 guint old_atomic_flags;
2461 G_LOCK (message_bus_lock);
2462 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2465 G_UNLOCK (message_bus_lock);
2468 connection = G_DBUS_CONNECTION (user_data);
2469 g_object_ref (connection);
2470 G_UNLOCK (message_bus_lock);
2472 //g_debug ("in on_worker_closed: %s", error->message);
2474 CONNECTION_LOCK (connection);
2475 /* Even though this is atomic, we do it inside the lock to avoid breaking
2476 * assumptions in remove_match_rule(). We'd need the lock in a moment
2477 * anyway, so, no loss.
2479 old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
2481 if (!(old_atomic_flags & FLAG_CLOSED))
2483 g_hash_table_foreach_remove (connection->map_method_serial_to_send_message_data, cancel_method_on_close, NULL);
2484 schedule_closed_unlocked (connection, remote_peer_vanished, error);
2486 CONNECTION_UNLOCK (connection);
2488 g_object_unref (connection);
2491 /* ---------------------------------------------------------------------------------------------------- */
2493 /* Determines the biggest set of capabilities we can support on this
2496 * Called with the init_lock held.
2498 static GDBusCapabilityFlags
2499 get_offered_capabilities_max (GDBusConnection *connection)
2501 GDBusCapabilityFlags ret;
2502 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
2504 if (G_IS_UNIX_CONNECTION (connection->stream))
2505 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
2510 /* Called in a user thread, lock is not held */
2512 initable_init (GInitable *initable,
2513 GCancellable *cancellable,
2516 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
2519 /* This method needs to be idempotent to work with the singleton
2520 * pattern. See the docs for g_initable_init(). We implement this by
2523 * Unfortunately we can't use the main lock since the on_worker_*()
2524 * callbacks above needs the lock during initialization (for message
2525 * bus connections we do a synchronous Hello() call on the bus).
2527 g_mutex_lock (&connection->init_lock);
2531 /* Make this a no-op if we're already initialized (successfully or
2534 if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
2536 ret = (connection->initialization_error == NULL);
2540 /* Because of init_lock, we can't get here twice in different threads */
2541 g_assert (connection->initialization_error == NULL);
2543 /* The user can pass multiple (but mutally exclusive) construct
2546 * - stream (of type GIOStream)
2547 * - address (of type gchar*)
2549 * At the end of the day we end up with a non-NULL GIOStream
2550 * object in connection->stream.
2552 if (connection->address != NULL)
2554 g_assert (connection->stream == NULL);
2556 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
2557 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
2559 g_set_error_literal (&connection->initialization_error,
2561 G_IO_ERROR_INVALID_ARGUMENT,
2562 _("Unsupported flags encountered when constructing a client-side connection"));
2566 connection->stream = g_dbus_address_get_stream_sync (connection->address,
2567 NULL, /* TODO: out_guid */
2569 &connection->initialization_error);
2570 if (connection->stream == NULL)
2573 else if (connection->stream != NULL)
2579 g_assert_not_reached ();
2582 /* Authenticate the connection */
2583 if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
2585 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
2586 g_assert (connection->guid != NULL);
2587 connection->auth = _g_dbus_auth_new (connection->stream);
2588 if (!_g_dbus_auth_run_server (connection->auth,
2589 connection->authentication_observer,
2591 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
2592 get_offered_capabilities_max (connection),
2593 &connection->capabilities,
2594 &connection->credentials,
2596 &connection->initialization_error))
2599 else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
2601 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
2602 g_assert (connection->guid == NULL);
2603 connection->auth = _g_dbus_auth_new (connection->stream);
2604 connection->guid = _g_dbus_auth_run_client (connection->auth,
2605 connection->authentication_observer,
2606 get_offered_capabilities_max (connection),
2607 &connection->capabilities,
2609 &connection->initialization_error);
2610 if (connection->guid == NULL)
2614 if (connection->authentication_observer != NULL)
2616 g_object_unref (connection->authentication_observer);
2617 connection->authentication_observer = NULL;
2620 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
2622 //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
2625 /* We want all IO operations to be non-blocking since they happen in
2626 * the worker thread which is shared by _all_ connections.
2628 if (G_IS_SOCKET_CONNECTION (connection->stream))
2630 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
2634 G_LOCK (message_bus_lock);
2635 if (alive_connections == NULL)
2636 alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
2637 g_hash_table_insert (alive_connections, connection, connection);
2638 G_UNLOCK (message_bus_lock);
2640 connection->worker = _g_dbus_worker_new (connection->stream,
2641 connection->capabilities,
2642 ((connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0),
2643 on_worker_message_received,
2644 on_worker_message_about_to_be_sent,
2648 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
2649 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2651 GVariant *hello_result;
2653 /* we could lift this restriction by adding code in gdbusprivate.c */
2654 if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
2656 g_set_error_literal (&connection->initialization_error,
2659 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
2663 hello_result = g_dbus_connection_call_sync (connection,
2664 "org.freedesktop.DBus", /* name */
2665 "/org/freedesktop/DBus", /* path */
2666 "org.freedesktop.DBus", /* interface */
2668 NULL, /* parameters */
2669 G_VARIANT_TYPE ("(s)"),
2670 CALL_FLAGS_INITIALIZING,
2672 NULL, /* TODO: cancellable */
2673 &connection->initialization_error);
2674 if (hello_result == NULL)
2677 g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
2678 g_variant_unref (hello_result);
2679 //g_debug ("unique name is `%s'", connection->bus_unique_name);
2686 g_assert (connection->initialization_error != NULL);
2687 g_propagate_error (error, g_error_copy (connection->initialization_error));
2690 g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
2691 g_mutex_unlock (&connection->init_lock);
2697 initable_iface_init (GInitableIface *initable_iface)
2699 initable_iface->init = initable_init;
2702 /* ---------------------------------------------------------------------------------------------------- */
2705 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
2710 /* ---------------------------------------------------------------------------------------------------- */
2713 * g_dbus_connection_new:
2714 * @stream: A #GIOStream.
2715 * @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL.
2716 * @flags: Flags describing how to make the connection.
2717 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2718 * @cancellable: (allow-none): A #GCancellable or %NULL.
2719 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2720 * @user_data: The data to pass to @callback.
2722 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
2723 * with the end represented by @stream.
2725 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2726 * will be put into non-blocking mode.
2728 * The D-Bus connection will interact with @stream from a worker thread.
2729 * As a result, the caller should not interact with @stream after this
2730 * method has been called, except by calling g_object_unref() on it.
2732 * If @observer is not %NULL it may be used to control the
2733 * authentication process.
2735 * When the operation is finished, @callback will be invoked. You can
2736 * then call g_dbus_connection_new_finish() to get the result of the
2739 * This is a asynchronous failable constructor. See
2740 * g_dbus_connection_new_sync() for the synchronous
2746 g_dbus_connection_new (GIOStream *stream,
2748 GDBusConnectionFlags flags,
2749 GDBusAuthObserver *observer,
2750 GCancellable *cancellable,
2751 GAsyncReadyCallback callback,
2754 g_return_if_fail (G_IS_IO_STREAM (stream));
2755 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2763 "authentication-observer", observer,
2768 * g_dbus_connection_new_finish:
2769 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2770 * @error: Return location for error or %NULL.
2772 * Finishes an operation started with g_dbus_connection_new().
2774 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2779 g_dbus_connection_new_finish (GAsyncResult *res,
2783 GObject *source_object;
2785 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2786 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2788 source_object = g_async_result_get_source_object (res);
2789 g_assert (source_object != NULL);
2790 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2793 g_object_unref (source_object);
2795 return G_DBUS_CONNECTION (object);
2801 * g_dbus_connection_new_sync:
2802 * @stream: A #GIOStream.
2803 * @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL.
2804 * @flags: Flags describing how to make the connection.
2805 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2806 * @cancellable: (allow-none): A #GCancellable or %NULL.
2807 * @error: Return location for error or %NULL.
2809 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2810 * with the end represented by @stream.
2812 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2813 * will be put into non-blocking mode.
2815 * The D-Bus connection will interact with @stream from a worker thread.
2816 * As a result, the caller should not interact with @stream after this
2817 * method has been called, except by calling g_object_unref() on it.
2819 * If @observer is not %NULL it may be used to control the
2820 * authentication process.
2822 * This is a synchronous failable constructor. See
2823 * g_dbus_connection_new() for the asynchronous version.
2825 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2830 g_dbus_connection_new_sync (GIOStream *stream,
2832 GDBusConnectionFlags flags,
2833 GDBusAuthObserver *observer,
2834 GCancellable *cancellable,
2837 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2838 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2839 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2845 "authentication-observer", observer,
2849 /* ---------------------------------------------------------------------------------------------------- */
2852 * g_dbus_connection_new_for_address:
2853 * @address: A D-Bus address.
2854 * @flags: Flags describing how to make the connection.
2855 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2856 * @cancellable: (allow-none): A #GCancellable or %NULL.
2857 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2858 * @user_data: The data to pass to @callback.
2860 * Asynchronously connects and sets up a D-Bus client connection for
2861 * exchanging D-Bus messages with an endpoint specified by @address
2862 * which must be in the D-Bus address format.
2864 * This constructor can only be used to initiate client-side
2865 * connections - use g_dbus_connection_new() if you need to act as the
2866 * server. In particular, @flags cannot contain the
2867 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2868 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2870 * When the operation is finished, @callback will be invoked. You can
2871 * then call g_dbus_connection_new_finish() to get the result of the
2874 * If @observer is not %NULL it may be used to control the
2875 * authentication process.
2877 * This is a asynchronous failable constructor. See
2878 * g_dbus_connection_new_for_address_sync() for the synchronous
2884 g_dbus_connection_new_for_address (const gchar *address,
2885 GDBusConnectionFlags flags,
2886 GDBusAuthObserver *observer,
2887 GCancellable *cancellable,
2888 GAsyncReadyCallback callback,
2891 g_return_if_fail (address != NULL);
2892 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2899 "authentication-observer", observer,
2904 * g_dbus_connection_new_for_address_finish:
2905 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2906 * @error: Return location for error or %NULL.
2908 * Finishes an operation started with g_dbus_connection_new_for_address().
2910 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2915 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
2919 GObject *source_object;
2921 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2922 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2924 source_object = g_async_result_get_source_object (res);
2925 g_assert (source_object != NULL);
2926 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2929 g_object_unref (source_object);
2931 return G_DBUS_CONNECTION (object);
2937 * g_dbus_connection_new_for_address_sync:
2938 * @address: A D-Bus address.
2939 * @flags: Flags describing how to make the connection.
2940 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2941 * @cancellable: (allow-none): A #GCancellable or %NULL.
2942 * @error: Return location for error or %NULL.
2944 * Synchronously connects and sets up a D-Bus client connection for
2945 * exchanging D-Bus messages with an endpoint specified by @address
2946 * which must be in the D-Bus address format.
2948 * This constructor can only be used to initiate client-side
2949 * connections - use g_dbus_connection_new_sync() if you need to act
2950 * as the server. In particular, @flags cannot contain the
2951 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2952 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2954 * This is a synchronous failable constructor. See
2955 * g_dbus_connection_new_for_address() for the asynchronous version.
2957 * If @observer is not %NULL it may be used to control the
2958 * authentication process.
2960 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2965 g_dbus_connection_new_for_address_sync (const gchar *address,
2966 GDBusConnectionFlags flags,
2967 GDBusAuthObserver *observer,
2968 GCancellable *cancellable,
2971 g_return_val_if_fail (address != NULL, NULL);
2972 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2973 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2978 "authentication-observer", observer,
2982 /* ---------------------------------------------------------------------------------------------------- */
2985 * g_dbus_connection_set_exit_on_close:
2986 * @connection: A #GDBusConnection.
2987 * @exit_on_close: Whether the process should be terminated
2988 * when @connection is closed by the remote peer.
2990 * Sets whether the process should be terminated when @connection is
2991 * closed by the remote peer. See #GDBusConnection:exit-on-close for
2994 * Note that this function should be used with care. Most modern UNIX
2995 * desktops tie the notion of a user session the session bus, and expect
2996 * all of a users applications to quit when their bus connection goes away.
2997 * If you are setting @exit_on_close to %FALSE for the shared session
2998 * bus connection, you should make sure that your application exits
2999 * when the user session ends.
3004 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
3005 gboolean exit_on_close)
3007 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3010 g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
3012 g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
3017 * g_dbus_connection_get_exit_on_close:
3018 * @connection: A #GDBusConnection.
3020 * Gets whether the process is terminated when @connection is
3021 * closed by the remote peer. See
3022 * #GDBusConnection:exit-on-close for more details.
3024 * Returns: Whether the process is terminated when @connection is
3025 * closed by the remote peer.
3030 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
3032 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3034 if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
3041 * g_dbus_connection_get_guid:
3042 * @connection: A #GDBusConnection.
3044 * The GUID of the peer performing the role of server when
3045 * authenticating. See #GDBusConnection:guid for more details.
3047 * Returns: The GUID. Do not free this string, it is owned by
3053 g_dbus_connection_get_guid (GDBusConnection *connection)
3055 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3056 return connection->guid;
3060 * g_dbus_connection_get_unique_name:
3061 * @connection: A #GDBusConnection.
3063 * Gets the unique name of @connection as assigned by the message
3064 * bus. This can also be used to figure out if @connection is a
3065 * message bus connection.
3067 * Returns: The unique name or %NULL if @connection is not a message
3068 * bus connection. Do not free this string, it is owned by
3074 g_dbus_connection_get_unique_name (GDBusConnection *connection)
3076 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3078 /* do not use g_return_val_if_fail(), we want the memory barrier */
3079 if (!check_initialized (connection))
3082 return connection->bus_unique_name;
3086 * g_dbus_connection_get_peer_credentials:
3087 * @connection: A #GDBusConnection.
3089 * Gets the credentials of the authenticated peer. This will always
3090 * return %NULL unless @connection acted as a server
3091 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
3092 * when set up and the client passed credentials as part of the
3093 * authentication process.
3095 * In a message bus setup, the message bus is always the server and
3096 * each application is a client. So this method will always return
3097 * %NULL for message bus clients.
3099 * Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free
3100 * this object, it is owned by @connection.
3105 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
3107 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3109 /* do not use g_return_val_if_fail(), we want the memory barrier */
3110 if (!check_initialized (connection))
3113 return connection->credentials;
3116 /* ---------------------------------------------------------------------------------------------------- */
3118 static guint _global_filter_id = 1;
3121 * g_dbus_connection_add_filter:
3122 * @connection: A #GDBusConnection.
3123 * @filter_function: A filter function.
3124 * @user_data: User data to pass to @filter_function.
3125 * @user_data_free_func: Function to free @user_data with when filter
3126 * is removed or %NULL.
3128 * Adds a message filter. Filters are handlers that are run on all
3129 * incoming and outgoing messages, prior to standard dispatch. Filters
3130 * are run in the order that they were added. The same handler can be
3131 * added as a filter more than once, in which case it will be run more
3132 * than once. Filters added during a filter callback won't be run on
3133 * the message being processed. Filter functions are allowed to modify
3134 * and even drop messages.
3136 * Note that filters are run in a dedicated message handling thread so
3137 * they can't block and, generally, can't do anything but signal a
3138 * worker thread. Also note that filters are rarely needed - use API
3139 * such as g_dbus_connection_send_message_with_reply(),
3140 * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
3142 * If a filter consumes an incoming message the message is not
3143 * dispatched anywhere else - not even the standard dispatch machinery
3144 * (that API such as g_dbus_connection_signal_subscribe() and
3145 * g_dbus_connection_send_message_with_reply() relies on) will see the
3146 * message. Similary, if a filter consumes an outgoing message, the
3147 * message will not be sent to the other peer.
3149 * Returns: A filter identifier that can be used with
3150 * g_dbus_connection_remove_filter().
3155 g_dbus_connection_add_filter (GDBusConnection *connection,
3156 GDBusMessageFilterFunction filter_function,
3158 GDestroyNotify user_data_free_func)
3162 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3163 g_return_val_if_fail (filter_function != NULL, 0);
3164 g_return_val_if_fail (check_initialized (connection), 0);
3166 CONNECTION_LOCK (connection);
3167 data = g_new0 (FilterData, 1);
3168 data->id = _global_filter_id++; /* TODO: overflow etc. */
3169 data->filter_function = filter_function;
3170 data->user_data = user_data;
3171 data->user_data_free_func = user_data_free_func;
3172 g_ptr_array_add (connection->filters, data);
3173 CONNECTION_UNLOCK (connection);
3178 /* only called from finalize(), removes all filters */
3180 purge_all_filters (GDBusConnection *connection)
3183 for (n = 0; n < connection->filters->len; n++)
3185 FilterData *data = connection->filters->pdata[n];
3186 if (data->user_data_free_func != NULL)
3187 data->user_data_free_func (data->user_data);
3193 * g_dbus_connection_remove_filter:
3194 * @connection: a #GDBusConnection
3195 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
3202 g_dbus_connection_remove_filter (GDBusConnection *connection,
3206 FilterData *to_destroy;
3208 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3209 g_return_if_fail (check_initialized (connection));
3211 CONNECTION_LOCK (connection);
3213 for (n = 0; n < connection->filters->len; n++)
3215 FilterData *data = connection->filters->pdata[n];
3216 if (data->id == filter_id)
3218 g_ptr_array_remove_index (connection->filters, n);
3223 CONNECTION_UNLOCK (connection);
3225 /* do free without holding lock */
3226 if (to_destroy != NULL)
3228 if (to_destroy->user_data_free_func != NULL)
3229 to_destroy->user_data_free_func (to_destroy->user_data);
3230 g_free (to_destroy);
3234 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
3238 /* ---------------------------------------------------------------------------------------------------- */
3244 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
3245 gchar *interface_name;
3249 GDBusSignalFlags flags;
3250 GArray *subscribers;
3255 GDBusSignalCallback callback;
3257 GDestroyNotify user_data_free_func;
3259 GMainContext *context;
3263 signal_data_free (SignalData *signal_data)
3265 g_free (signal_data->rule);
3266 g_free (signal_data->sender);
3267 g_free (signal_data->sender_unique_name);
3268 g_free (signal_data->interface_name);
3269 g_free (signal_data->member);
3270 g_free (signal_data->object_path);
3271 g_free (signal_data->arg0);
3272 g_array_free (signal_data->subscribers, TRUE);
3273 g_free (signal_data);
3277 args_to_rule (const gchar *sender,
3278 const gchar *interface_name,
3279 const gchar *member,
3280 const gchar *object_path,
3282 GDBusSignalFlags flags)
3286 rule = g_string_new ("type='signal'");
3287 if (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE)
3288 g_string_prepend_c (rule, '-');
3290 g_string_append_printf (rule, ",sender='%s'", sender);
3291 if (interface_name != NULL)
3292 g_string_append_printf (rule, ",interface='%s'", interface_name);
3294 g_string_append_printf (rule, ",member='%s'", member);
3295 if (object_path != NULL)
3296 g_string_append_printf (rule, ",path='%s'", object_path);
3300 if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
3301 g_string_append_printf (rule, ",arg0path='%s'", arg0);
3302 else if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
3303 g_string_append_printf (rule, ",arg0namespace='%s'", arg0);
3305 g_string_append_printf (rule, ",arg0='%s'", arg0);
3308 return g_string_free (rule, FALSE);
3311 static guint _global_subscriber_id = 1;
3312 static guint _global_registration_id = 1;
3313 static guint _global_subtree_registration_id = 1;
3315 /* ---------------------------------------------------------------------------------------------------- */
3317 /* Called in a user thread, lock is held */
3319 add_match_rule (GDBusConnection *connection,
3320 const gchar *match_rule)
3323 GDBusMessage *message;
3325 if (match_rule[0] == '-')
3328 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3329 "/org/freedesktop/DBus", /* path */
3330 "org.freedesktop.DBus", /* interface */
3332 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3334 if (!g_dbus_connection_send_message_unlocked (connection,
3336 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3340 g_critical ("Error while sending AddMatch() message: %s", error->message);
3341 g_error_free (error);
3343 g_object_unref (message);
3346 /* ---------------------------------------------------------------------------------------------------- */
3348 /* Called in a user thread, lock is held */
3350 remove_match_rule (GDBusConnection *connection,
3351 const gchar *match_rule)
3354 GDBusMessage *message;
3356 if (match_rule[0] == '-')
3359 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3360 "/org/freedesktop/DBus", /* path */
3361 "org.freedesktop.DBus", /* interface */
3363 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3366 if (!g_dbus_connection_send_message_unlocked (connection,
3368 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3372 /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
3373 * critical; but we're holding the lock, and our caller checked whether
3374 * we were already closed, so we can't get that error.
3376 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3377 g_error_free (error);
3379 g_object_unref (message);
3382 /* ---------------------------------------------------------------------------------------------------- */
3385 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3387 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3388 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3389 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3390 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3391 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3394 /* ---------------------------------------------------------------------------------------------------- */
3397 * g_dbus_connection_signal_subscribe:
3398 * @connection: A #GDBusConnection.
3399 * @sender: (allow-none): Sender name to match on (unique or well-known name)
3400 * or %NULL to listen from all senders.
3401 * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
3402 * match on all interfaces.
3403 * @member: (allow-none): D-Bus signal name to match on or %NULL to match on all signals.
3404 * @object_path: (allow-none): Object path to match on or %NULL to match on all object paths.
3405 * @arg0: (allow-none): Contents of first string argument to match on or %NULL
3406 * to match on all kinds of arguments.
3407 * @flags: Flags describing how to subscribe to the signal (currently unused).
3408 * @callback: Callback to invoke when there is a signal matching the requested data.
3409 * @user_data: User data to pass to @callback.
3410 * @user_data_free_func: (allow-none): Function to free @user_data with when
3411 * subscription is removed or %NULL.
3413 * Subscribes to signals on @connection and invokes @callback with a
3414 * whenever the signal is received. Note that @callback
3415 * will be invoked in the <link
3416 * linkend="g-main-context-push-thread-default">thread-default main
3417 * loop</link> of the thread you are calling this method from.
3419 * If @connection is not a message bus connection, @sender must be
3422 * If @sender is a well-known name note that @callback is invoked with
3423 * the unique name for the owner of @sender, not the well-known name
3424 * as one would expect. This is because the message bus rewrites the
3425 * name. As such, to avoid certain race conditions, users should be
3426 * tracking the name owner of the well-known name and use that when
3427 * processing the received signal.
3429 * If one of %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE or
3430 * %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH are given, @arg0 is
3431 * interpreted as part of a namespace or path. The first argument
3432 * of a signal is matched against that part as specified by D-Bus.
3434 * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
3439 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
3440 const gchar *sender,
3441 const gchar *interface_name,
3442 const gchar *member,
3443 const gchar *object_path,
3445 GDBusSignalFlags flags,
3446 GDBusSignalCallback callback,
3448 GDestroyNotify user_data_free_func)
3451 SignalData *signal_data;
3452 SignalSubscriber subscriber;
3453 GPtrArray *signal_data_array;
3454 const gchar *sender_unique_name;
3456 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
3457 * an OOM condition. We might want to change that but that would involve making
3458 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
3459 * handle that. And there's really no sensible way of handling this short of retrying
3460 * to add the match rule... and then there's the little thing that, hey, maybe there's
3461 * a reason the bus in an OOM condition.
3463 * Doable, but not really sure it's worth it...
3466 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3467 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
3468 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
3469 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
3470 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
3471 g_return_val_if_fail (callback != NULL, 0);
3472 g_return_val_if_fail (check_initialized (connection), 0);
3473 g_return_val_if_fail (!((flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH) && (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)), 0);
3474 g_return_val_if_fail (!(arg0 == NULL && (flags & (G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH | G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE))), 0);
3476 CONNECTION_LOCK (connection);
3478 /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
3479 * with a '-' character to prefix the rule (which will otherwise be
3482 * This allows us to hash the rule and do our lifecycle tracking in
3483 * the usual way, but the '-' prevents the match rule from ever
3484 * actually being send to the bus (either for add or remove).
3486 rule = args_to_rule (sender, interface_name, member, object_path, arg0, flags);
3488 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
3489 sender_unique_name = sender;
3491 sender_unique_name = "";
3493 subscriber.callback = callback;
3494 subscriber.user_data = user_data;
3495 subscriber.user_data_free_func = user_data_free_func;
3496 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
3497 subscriber.context = g_main_context_ref_thread_default ();
3499 /* see if we've already have this rule */
3500 signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
3501 if (signal_data != NULL)
3503 g_array_append_val (signal_data->subscribers, subscriber);
3508 signal_data = g_new0 (SignalData, 1);
3509 signal_data->rule = rule;
3510 signal_data->sender = g_strdup (sender);
3511 signal_data->sender_unique_name = g_strdup (sender_unique_name);
3512 signal_data->interface_name = g_strdup (interface_name);
3513 signal_data->member = g_strdup (member);
3514 signal_data->object_path = g_strdup (object_path);
3515 signal_data->arg0 = g_strdup (arg0);
3516 signal_data->flags = flags;
3517 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3518 g_array_append_val (signal_data->subscribers, subscriber);
3520 g_hash_table_insert (connection->map_rule_to_signal_data,
3524 /* Add the match rule to the bus...
3526 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
3527 * always send such messages to us.
3529 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3531 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
3532 add_match_rule (connection, signal_data->rule);
3535 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3536 signal_data->sender_unique_name);
3537 if (signal_data_array == NULL)
3539 signal_data_array = g_ptr_array_new ();
3540 g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
3541 g_strdup (signal_data->sender_unique_name),
3544 g_ptr_array_add (signal_data_array, signal_data);
3547 g_hash_table_insert (connection->map_id_to_signal_data,
3548 GUINT_TO_POINTER (subscriber.id),
3551 CONNECTION_UNLOCK (connection);
3553 return subscriber.id;
3556 /* ---------------------------------------------------------------------------------------------------- */
3558 /* called in any thread */
3559 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
3561 unsubscribe_id_internal (GDBusConnection *connection,
3562 guint subscription_id,
3563 GArray *out_removed_subscribers)
3565 SignalData *signal_data;
3566 GPtrArray *signal_data_array;
3569 signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
3570 GUINT_TO_POINTER (subscription_id));
3571 if (signal_data == NULL)
3573 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
3577 for (n = 0; n < signal_data->subscribers->len; n++)
3579 SignalSubscriber *subscriber;
3581 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
3582 if (subscriber->id != subscription_id)
3585 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
3586 GUINT_TO_POINTER (subscription_id)));
3587 g_array_append_val (out_removed_subscribers, *subscriber);
3588 g_array_remove_index (signal_data->subscribers, n);
3590 if (signal_data->subscribers->len == 0)
3592 g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
3594 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3595 signal_data->sender_unique_name);
3596 g_warn_if_fail (signal_data_array != NULL);
3597 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
3599 if (signal_data_array->len == 0)
3601 g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
3602 signal_data->sender_unique_name));
3605 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
3606 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
3607 !is_signal_data_for_name_lost_or_acquired (signal_data) &&
3608 !g_dbus_connection_is_closed (connection) &&
3609 !connection->finalizing)
3611 /* The check for g_dbus_connection_is_closed() means that
3612 * sending the RemoveMatch message can't fail with
3613 * G_IO_ERROR_CLOSED, because we're holding the lock,
3614 * so on_worker_closed() can't happen between the check we just
3615 * did, and releasing the lock later.
3617 remove_match_rule (connection, signal_data->rule);
3620 signal_data_free (signal_data);
3626 g_assert_not_reached ();
3633 * g_dbus_connection_signal_unsubscribe:
3634 * @connection: A #GDBusConnection.
3635 * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
3637 * Unsubscribes from signals.
3642 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
3643 guint subscription_id)
3645 GArray *subscribers;
3648 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3649 g_return_if_fail (check_initialized (connection));
3651 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3653 CONNECTION_LOCK (connection);
3654 unsubscribe_id_internal (connection,
3657 CONNECTION_UNLOCK (connection);
3660 g_assert (subscribers->len == 0 || subscribers->len == 1);
3662 /* call GDestroyNotify without lock held */
3663 for (n = 0; n < subscribers->len; n++)
3665 SignalSubscriber *subscriber;
3666 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3667 call_destroy_notify (subscriber->context,
3668 subscriber->user_data_free_func,
3669 subscriber->user_data);
3670 g_main_context_unref (subscriber->context);
3673 g_array_free (subscribers, TRUE);
3676 /* ---------------------------------------------------------------------------------------------------- */
3680 guint subscription_id;
3681 GDBusSignalCallback callback;
3683 GDBusMessage *message;
3684 GDBusConnection *connection;
3685 const gchar *sender;
3687 const gchar *interface;
3688 const gchar *member;
3691 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
3695 emit_signal_instance_in_idle_cb (gpointer data)
3697 SignalInstance *signal_instance = data;
3698 GVariant *parameters;
3699 gboolean has_subscription;
3701 parameters = g_dbus_message_get_body (signal_instance->message);
3702 if (parameters == NULL)
3704 parameters = g_variant_new ("()");
3705 g_variant_ref_sink (parameters);
3709 g_variant_ref_sink (parameters);
3713 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
3714 signal_instance->subscription_id,
3715 signal_instance->sender,
3716 signal_instance->path,
3717 signal_instance->interface,
3718 signal_instance->member,
3719 g_variant_print (parameters, TRUE));
3722 /* Careful here, don't do the callback if we no longer has the subscription */
3723 CONNECTION_LOCK (signal_instance->connection);
3724 has_subscription = FALSE;
3725 if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
3726 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
3727 has_subscription = TRUE;
3728 CONNECTION_UNLOCK (signal_instance->connection);
3730 if (has_subscription)
3731 signal_instance->callback (signal_instance->connection,
3732 signal_instance->sender,
3733 signal_instance->path,
3734 signal_instance->interface,
3735 signal_instance->member,
3737 signal_instance->user_data);
3739 g_variant_unref (parameters);
3745 signal_instance_free (SignalInstance *signal_instance)
3747 g_object_unref (signal_instance->message);
3748 g_object_unref (signal_instance->connection);
3749 g_free (signal_instance);
3753 namespace_rule_matches (const gchar *namespace,
3759 len_namespace = strlen (namespace);
3760 len_name = strlen (name);
3762 if (len_name < len_namespace)
3765 if (memcmp (namespace, name, len_namespace) != 0)
3768 return len_namespace == len_name || name[len_namespace] == '.';
3772 path_rule_matches (const gchar *path_a,
3773 const gchar *path_b)
3777 len_a = strlen (path_a);
3778 len_b = strlen (path_b);
3780 if (len_a < len_b && path_a[len_a - 1] != '/')
3783 if (len_b < len_a && path_b[len_b - 1] != '/')
3786 return memcmp (path_a, path_b, MIN (len_a, len_b)) == 0;
3789 /* called in GDBusWorker thread WITH lock held */
3791 schedule_callbacks (GDBusConnection *connection,
3792 GPtrArray *signal_data_array,
3793 GDBusMessage *message,
3794 const gchar *sender)
3797 const gchar *interface;
3798 const gchar *member;
3807 interface = g_dbus_message_get_interface (message);
3808 member = g_dbus_message_get_member (message);
3809 path = g_dbus_message_get_path (message);
3810 arg0 = g_dbus_message_get_arg0 (message);
3813 g_print ("In schedule_callbacks:\n"
3815 " interface = `%s'\n"
3826 /* TODO: if this is slow, then we can change signal_data_array into
3827 * map_object_path_to_signal_data_array or something.
3829 for (n = 0; n < signal_data_array->len; n++)
3831 SignalData *signal_data = signal_data_array->pdata[n];
3833 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
3836 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
3839 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
3842 if (signal_data->arg0 != NULL)
3847 if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
3849 if (!namespace_rule_matches (signal_data->arg0, arg0))
3852 else if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
3854 if (!path_rule_matches (signal_data->arg0, arg0))
3857 else if (!g_str_equal (signal_data->arg0, arg0))
3861 for (m = 0; m < signal_data->subscribers->len; m++)
3863 SignalSubscriber *subscriber;
3864 GSource *idle_source;
3865 SignalInstance *signal_instance;
3867 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
3869 signal_instance = g_new0 (SignalInstance, 1);
3870 signal_instance->subscription_id = subscriber->id;
3871 signal_instance->callback = subscriber->callback;
3872 signal_instance->user_data = subscriber->user_data;
3873 signal_instance->message = g_object_ref (message);
3874 signal_instance->connection = g_object_ref (connection);
3875 signal_instance->sender = sender;
3876 signal_instance->path = path;
3877 signal_instance->interface = interface;
3878 signal_instance->member = member;
3880 idle_source = g_idle_source_new ();
3881 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3882 g_source_set_callback (idle_source,
3883 emit_signal_instance_in_idle_cb,
3885 (GDestroyNotify) signal_instance_free);
3886 g_source_attach (idle_source, subscriber->context);
3887 g_source_unref (idle_source);
3892 /* called in GDBusWorker thread with lock held */
3894 distribute_signals (GDBusConnection *connection,
3895 GDBusMessage *message)
3897 GPtrArray *signal_data_array;
3898 const gchar *sender;
3900 sender = g_dbus_message_get_sender (message);
3902 if (G_UNLIKELY (_g_dbus_debug_signal ()))
3904 _g_dbus_debug_print_lock ();
3905 g_print ("========================================================================\n"
3906 "GDBus-debug:Signal:\n"
3907 " <<<< RECEIVED SIGNAL %s.%s\n"
3909 " sent by name %s\n",
3910 g_dbus_message_get_interface (message),
3911 g_dbus_message_get_member (message),
3912 g_dbus_message_get_path (message),
3913 sender != NULL ? sender : "(none)");
3914 _g_dbus_debug_print_unlock ();
3917 /* collect subscribers that match on sender */
3920 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
3921 if (signal_data_array != NULL)
3922 schedule_callbacks (connection, signal_data_array, message, sender);
3925 /* collect subscribers not matching on sender */
3926 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
3927 if (signal_data_array != NULL)
3928 schedule_callbacks (connection, signal_data_array, message, sender);
3931 /* ---------------------------------------------------------------------------------------------------- */
3933 /* only called from finalize(), removes all subscriptions */
3935 purge_all_signal_subscriptions (GDBusConnection *connection)
3937 GHashTableIter iter;
3940 GArray *subscribers;
3943 ids = g_array_new (FALSE, FALSE, sizeof (guint));
3944 g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
3945 while (g_hash_table_iter_next (&iter, &key, NULL))
3947 guint subscription_id = GPOINTER_TO_UINT (key);
3948 g_array_append_val (ids, subscription_id);
3951 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3952 for (n = 0; n < ids->len; n++)
3954 guint subscription_id = g_array_index (ids, guint, n);
3955 unsubscribe_id_internal (connection,
3959 g_array_free (ids, TRUE);
3961 /* call GDestroyNotify without lock held */
3962 for (n = 0; n < subscribers->len; n++)
3964 SignalSubscriber *subscriber;
3965 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3966 call_destroy_notify (subscriber->context,
3967 subscriber->user_data_free_func,
3968 subscriber->user_data);
3969 g_main_context_unref (subscriber->context);
3972 g_array_free (subscribers, TRUE);
3975 /* ---------------------------------------------------------------------------------------------------- */
3977 static GDBusInterfaceVTable *
3978 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
3980 /* Don't waste memory by copying padding - remember to update this
3981 * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
3983 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3987 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
3992 /* ---------------------------------------------------------------------------------------------------- */
3994 static GDBusSubtreeVTable *
3995 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
3997 /* Don't waste memory by copying padding - remember to update this
3998 * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
4000 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
4004 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
4009 /* ---------------------------------------------------------------------------------------------------- */
4011 struct ExportedObject
4014 GDBusConnection *connection;
4016 /* maps gchar* -> ExportedInterface* */
4017 GHashTable *map_if_name_to_ei;
4020 /* only called with lock held */
4022 exported_object_free (ExportedObject *eo)
4024 g_free (eo->object_path);
4025 g_hash_table_unref (eo->map_if_name_to_ei);
4034 gchar *interface_name;
4035 GDBusInterfaceVTable *vtable;
4036 GDBusInterfaceInfo *interface_info;
4038 GMainContext *context;
4040 GDestroyNotify user_data_free_func;
4041 } ExportedInterface;
4043 /* called with lock held */
4045 exported_interface_free (ExportedInterface *ei)
4047 g_dbus_interface_info_cache_release (ei->interface_info);
4048 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
4050 call_destroy_notify (ei->context,
4051 ei->user_data_free_func,
4054 g_main_context_unref (ei->context);
4056 g_free (ei->interface_name);
4057 _g_dbus_interface_vtable_free (ei->vtable);
4061 /* ---------------------------------------------------------------------------------------------------- */
4063 /* Convenience function to check if @registration_id (if not zero) or
4064 * @subtree_registration_id (if not zero) has been unregistered. If
4065 * so, returns %TRUE.
4067 * May be called by any thread. Caller must *not* hold lock.
4070 has_object_been_unregistered (GDBusConnection *connection,
4071 guint registration_id,
4072 guint subtree_registration_id)
4076 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4080 CONNECTION_LOCK (connection);
4081 if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
4082 GUINT_TO_POINTER (registration_id)) == NULL)
4086 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
4087 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
4091 CONNECTION_UNLOCK (connection);
4096 /* ---------------------------------------------------------------------------------------------------- */
4100 GDBusConnection *connection;
4101 GDBusMessage *message;
4103 const gchar *property_name;
4104 const GDBusInterfaceVTable *vtable;
4105 GDBusInterfaceInfo *interface_info;
4106 const GDBusPropertyInfo *property_info;
4107 guint registration_id;
4108 guint subtree_registration_id;
4112 property_data_free (PropertyData *data)
4114 g_object_unref (data->connection);
4115 g_object_unref (data->message);
4119 /* called in thread where object was registered - no locks held */
4121 invoke_get_property_in_idle_cb (gpointer _data)
4123 PropertyData *data = _data;
4126 GDBusMessage *reply;
4128 if (has_object_been_unregistered (data->connection,
4129 data->registration_id,
4130 data->subtree_registration_id))
4132 reply = g_dbus_message_new_method_error (data->message,
4133 "org.freedesktop.DBus.Error.UnknownMethod",
4134 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
4135 g_dbus_message_get_path (data->message));
4136 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4137 g_object_unref (reply);
4142 value = data->vtable->get_property (data->connection,
4143 g_dbus_message_get_sender (data->message),
4144 g_dbus_message_get_path (data->message),
4145 data->interface_info->name,
4146 data->property_name,
4153 g_assert_no_error (error);
4155 g_variant_take_ref (value);
4156 reply = g_dbus_message_new_method_reply (data->message);
4157 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
4158 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4159 g_variant_unref (value);
4160 g_object_unref (reply);
4164 gchar *dbus_error_name;
4165 g_assert (error != NULL);
4166 dbus_error_name = g_dbus_error_encode_gerror (error);
4167 reply = g_dbus_message_new_method_error_literal (data->message,
4170 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4171 g_free (dbus_error_name);
4172 g_error_free (error);
4173 g_object_unref (reply);
4180 /* called in thread where object was registered - no locks held */
4182 invoke_set_property_in_idle_cb (gpointer _data)
4184 PropertyData *data = _data;
4186 GDBusMessage *reply;
4192 g_variant_get (g_dbus_message_get_body (data->message),
4198 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
4199 * of the given value is wrong
4201 if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
4203 reply = g_dbus_message_new_method_error (data->message,
4204 "org.freedesktop.DBus.Error.InvalidArgs",
4205 _("Error setting property `%s': Expected type `%s' but got `%s'"),
4206 data->property_info->name,
4207 data->property_info->signature,
4208 g_variant_get_type_string (value));
4212 if (!data->vtable->set_property (data->connection,
4213 g_dbus_message_get_sender (data->message),
4214 g_dbus_message_get_path (data->message),
4215 data->interface_info->name,
4216 data->property_name,
4221 gchar *dbus_error_name;
4222 g_assert (error != NULL);
4223 dbus_error_name = g_dbus_error_encode_gerror (error);
4224 reply = g_dbus_message_new_method_error_literal (data->message,
4227 g_free (dbus_error_name);
4228 g_error_free (error);
4232 reply = g_dbus_message_new_method_reply (data->message);
4236 g_assert (reply != NULL);
4237 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4238 g_object_unref (reply);
4239 g_variant_unref (value);
4244 /* called in any thread with connection's lock held */
4246 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
4247 GDBusMessage *message,
4248 guint registration_id,
4249 guint subtree_registration_id,
4251 GDBusInterfaceInfo *interface_info,
4252 const GDBusInterfaceVTable *vtable,
4253 GMainContext *main_context,
4257 const char *interface_name;
4258 const char *property_name;
4259 const GDBusPropertyInfo *property_info;
4260 GSource *idle_source;
4261 PropertyData *property_data;
4262 GDBusMessage *reply;
4267 g_variant_get (g_dbus_message_get_body (message),
4272 g_variant_get (g_dbus_message_get_body (message),
4281 if (vtable == NULL || vtable->get_property == NULL)
4286 if (vtable == NULL || vtable->set_property == NULL)
4290 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
4292 property_info = NULL;
4294 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4295 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
4296 if (property_info == NULL)
4298 reply = g_dbus_message_new_method_error (message,
4299 "org.freedesktop.DBus.Error.InvalidArgs",
4300 _("No such property `%s'"),
4302 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4303 g_object_unref (reply);
4308 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4310 reply = g_dbus_message_new_method_error (message,
4311 "org.freedesktop.DBus.Error.InvalidArgs",
4312 _("Property `%s' is not readable"),
4314 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4315 g_object_unref (reply);
4319 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
4321 reply = g_dbus_message_new_method_error (message,
4322 "org.freedesktop.DBus.Error.InvalidArgs",
4323 _("Property `%s' is not writable"),
4325 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4326 g_object_unref (reply);
4331 /* ok, got the property info - call user code in an idle handler */
4332 property_data = g_new0 (PropertyData, 1);
4333 property_data->connection = g_object_ref (connection);
4334 property_data->message = g_object_ref (message);
4335 property_data->user_data = user_data;
4336 property_data->property_name = property_name;
4337 property_data->vtable = vtable;
4338 property_data->interface_info = interface_info;
4339 property_data->property_info = property_info;
4340 property_data->registration_id = registration_id;
4341 property_data->subtree_registration_id = subtree_registration_id;
4343 idle_source = g_idle_source_new ();
4344 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4345 g_source_set_callback (idle_source,
4346 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
4348 (GDestroyNotify) property_data_free);
4349 g_source_attach (idle_source, main_context);
4350 g_source_unref (idle_source);
4358 /* called in GDBusWorker thread with connection's lock held */
4360 handle_getset_property (GDBusConnection *connection,
4362 GDBusMessage *message,
4365 ExportedInterface *ei;
4367 const char *interface_name;
4368 const char *property_name;
4373 g_variant_get (g_dbus_message_get_body (message),
4378 g_variant_get (g_dbus_message_get_body (message),
4384 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4385 * no such interface registered
4387 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4390 GDBusMessage *reply;
4391 reply = g_dbus_message_new_method_error (message,
4392 "org.freedesktop.DBus.Error.InvalidArgs",
4393 _("No such interface `%s'"),
4395 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4396 g_object_unref (reply);
4401 handled = validate_and_maybe_schedule_property_getset (eo->connection,
4414 /* ---------------------------------------------------------------------------------------------------- */
4418 GDBusConnection *connection;
4419 GDBusMessage *message;
4421 const GDBusInterfaceVTable *vtable;
4422 GDBusInterfaceInfo *interface_info;
4423 guint registration_id;
4424 guint subtree_registration_id;
4425 } PropertyGetAllData;
4428 property_get_all_data_free (PropertyData *data)
4430 g_object_unref (data->connection);
4431 g_object_unref (data->message);
4435 /* called in thread where object was registered - no locks held */
4437 invoke_get_all_properties_in_idle_cb (gpointer _data)
4439 PropertyGetAllData *data = _data;
4440 GVariantBuilder builder;
4441 GDBusMessage *reply;
4444 if (has_object_been_unregistered (data->connection,
4445 data->registration_id,
4446 data->subtree_registration_id))
4448 reply = g_dbus_message_new_method_error (data->message,
4449 "org.freedesktop.DBus.Error.UnknownMethod",
4450 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
4451 g_dbus_message_get_path (data->message));
4452 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4453 g_object_unref (reply);
4457 /* TODO: Right now we never fail this call - we just omit values if
4458 * a get_property() call is failing.
4460 * We could fail the whole call if just a single get_property() call
4461 * returns an error. We need clarification in the D-Bus spec about this.
4463 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
4464 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
4465 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
4467 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
4470 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4473 value = data->vtable->get_property (data->connection,
4474 g_dbus_message_get_sender (data->message),
4475 g_dbus_message_get_path (data->message),
4476 data->interface_info->name,
4477 property_info->name,
4484 g_variant_take_ref (value);
4485 g_variant_builder_add (&builder,
4487 property_info->name,
4489 g_variant_unref (value);
4491 g_variant_builder_close (&builder);
4493 reply = g_dbus_message_new_method_reply (data->message);
4494 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
4495 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4496 g_object_unref (reply);
4502 /* called in any thread with connection's lock held */
4504 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
4505 GDBusMessage *message,
4506 guint registration_id,
4507 guint subtree_registration_id,
4508 GDBusInterfaceInfo *interface_info,
4509 const GDBusInterfaceVTable *vtable,
4510 GMainContext *main_context,
4514 const char *interface_name;
4515 GSource *idle_source;
4516 PropertyGetAllData *property_get_all_data;
4520 g_variant_get (g_dbus_message_get_body (message),
4524 if (vtable == NULL || vtable->get_property == NULL)
4527 /* ok, got the property info - call user in an idle handler */
4528 property_get_all_data = g_new0 (PropertyGetAllData, 1);
4529 property_get_all_data->connection = g_object_ref (connection);
4530 property_get_all_data->message = g_object_ref (message);
4531 property_get_all_data->user_data = user_data;
4532 property_get_all_data->vtable = vtable;
4533 property_get_all_data->interface_info = interface_info;
4534 property_get_all_data->registration_id = registration_id;
4535 property_get_all_data->subtree_registration_id = subtree_registration_id;
4537 idle_source = g_idle_source_new ();
4538 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4539 g_source_set_callback (idle_source,
4540 invoke_get_all_properties_in_idle_cb,
4541 property_get_all_data,
4542 (GDestroyNotify) property_get_all_data_free);
4543 g_source_attach (idle_source, main_context);
4544 g_source_unref (idle_source);
4552 /* called in GDBusWorker thread with connection's lock held */
4554 handle_get_all_properties (GDBusConnection *connection,
4556 GDBusMessage *message)
4558 ExportedInterface *ei;
4560 const char *interface_name;
4564 g_variant_get (g_dbus_message_get_body (message),
4568 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4569 * no such interface registered
4571 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4574 GDBusMessage *reply;
4575 reply = g_dbus_message_new_method_error (message,
4576 "org.freedesktop.DBus.Error.InvalidArgs",
4577 _("No such interface"),
4579 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4580 g_object_unref (reply);
4585 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
4597 /* ---------------------------------------------------------------------------------------------------- */
4599 static const gchar introspect_header[] =
4600 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
4601 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
4602 "<!-- GDBus " PACKAGE_VERSION " -->\n"
4605 static const gchar introspect_tail[] =
4608 static const gchar introspect_properties_interface[] =
4609 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
4610 " <method name=\"Get\">\n"
4611 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4612 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4613 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
4615 " <method name=\"GetAll\">\n"
4616 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4617 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
4619 " <method name=\"Set\">\n"
4620 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4621 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4622 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
4624 " <signal name=\"PropertiesChanged\">\n"
4625 " <arg type=\"s\" name=\"interface_name\"/>\n"
4626 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
4627 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
4631 static const gchar introspect_introspectable_interface[] =
4632 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
4633 " <method name=\"Introspect\">\n"
4634 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
4637 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
4638 " <method name=\"Ping\"/>\n"
4639 " <method name=\"GetMachineId\">\n"
4640 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
4645 introspect_append_header (GString *s)
4647 g_string_append (s, introspect_header);
4651 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
4653 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
4659 begin = object_path + path_len;
4660 end = strchr (begin, '/');
4662 s = g_strndup (begin, end - begin);
4664 s = g_strdup (begin);
4666 if (g_hash_table_lookup (set, s) == NULL)
4667 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
4673 /* TODO: we want a nicer public interface for this */
4674 /* called in any thread with connection's lock held */
4676 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
4681 GHashTableIter hash_iter;
4682 const gchar *object_path;
4688 CONNECTION_ENSURE_LOCK (connection);
4690 path_len = strlen (path);
4694 set = g_hash_table_new (g_str_hash, g_str_equal);
4696 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
4697 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4698 maybe_add_path (path, path_len, object_path, set);
4700 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
4701 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4702 maybe_add_path (path, path_len, object_path, set);
4704 p = g_ptr_array_new ();
4705 keys = g_hash_table_get_keys (set);
4706 for (l = keys; l != NULL; l = l->next)
4707 g_ptr_array_add (p, l->data);
4708 g_hash_table_unref (set);
4711 g_ptr_array_add (p, NULL);
4712 ret = (gchar **) g_ptr_array_free (p, FALSE);
4716 /* called in any thread with connection's lock not held */
4718 g_dbus_connection_list_registered (GDBusConnection *connection,
4722 CONNECTION_LOCK (connection);
4723 ret = g_dbus_connection_list_registered_unlocked (connection, path);
4724 CONNECTION_UNLOCK (connection);
4728 /* called in GDBusWorker thread with connection's lock held */
4730 handle_introspect (GDBusConnection *connection,
4732 GDBusMessage *message)
4736 GDBusMessage *reply;
4737 GHashTableIter hash_iter;
4738 ExportedInterface *ei;
4741 /* first the header with the standard interfaces */
4742 s = g_string_sized_new (sizeof (introspect_header) +
4743 sizeof (introspect_properties_interface) +
4744 sizeof (introspect_introspectable_interface) +
4745 sizeof (introspect_tail));
4746 introspect_append_header (s);
4747 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4748 "org.freedesktop.DBus.Properties"))
4749 g_string_append (s, introspect_properties_interface);
4751 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4752 "org.freedesktop.DBus.Introspectable"))
4753 g_string_append (s, introspect_introspectable_interface);
4755 /* then include the registered interfaces */
4756 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
4757 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
4758 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
4760 /* finally include nodes registered below us */
4761 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
4762 for (n = 0; registered != NULL && registered[n] != NULL; n++)
4763 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
4764 g_strfreev (registered);
4765 g_string_append (s, introspect_tail);
4767 reply = g_dbus_message_new_method_reply (message);
4768 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4769 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4770 g_object_unref (reply);
4771 g_string_free (s, TRUE);
4776 /* called in thread where object was registered - no locks held */
4778 call_in_idle_cb (gpointer user_data)
4780 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
4781 GDBusInterfaceVTable *vtable;
4782 guint registration_id;
4783 guint subtree_registration_id;
4785 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
4786 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
4788 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
4790 subtree_registration_id))
4792 GDBusMessage *reply;
4793 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
4794 "org.freedesktop.DBus.Error.UnknownMethod",
4795 _("No such interface `%s' on object at path %s"),
4796 g_dbus_method_invocation_get_interface_name (invocation),
4797 g_dbus_method_invocation_get_object_path (invocation));
4798 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4799 g_object_unref (reply);
4803 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
4804 g_assert (vtable != NULL && vtable->method_call != NULL);
4806 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
4807 g_dbus_method_invocation_get_sender (invocation),
4808 g_dbus_method_invocation_get_object_path (invocation),
4809 g_dbus_method_invocation_get_interface_name (invocation),
4810 g_dbus_method_invocation_get_method_name (invocation),
4811 g_dbus_method_invocation_get_parameters (invocation),
4812 g_object_ref (invocation),
4813 g_dbus_method_invocation_get_user_data (invocation));
4819 /* called in GDBusWorker thread with connection's lock held */
4821 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
4822 GDBusMessage *message,
4823 guint registration_id,
4824 guint subtree_registration_id,
4825 GDBusInterfaceInfo *interface_info,
4826 const GDBusInterfaceVTable *vtable,
4827 GMainContext *main_context,
4830 GDBusMethodInvocation *invocation;
4831 const GDBusMethodInfo *method_info;
4832 GDBusMessage *reply;
4833 GVariant *parameters;
4834 GSource *idle_source;
4836 GVariantType *in_type;
4840 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4841 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
4843 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
4844 * error to the caller
4846 if (method_info == NULL)
4848 reply = g_dbus_message_new_method_error (message,
4849 "org.freedesktop.DBus.Error.UnknownMethod",
4850 _("No such method `%s'"),
4851 g_dbus_message_get_member (message));
4852 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4853 g_object_unref (reply);
4858 parameters = g_dbus_message_get_body (message);
4859 if (parameters == NULL)
4861 parameters = g_variant_new ("()");
4862 g_variant_ref_sink (parameters);
4866 g_variant_ref (parameters);
4869 /* Check that the incoming args are of the right type - if they are not, return
4870 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
4872 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
4873 if (!g_variant_is_of_type (parameters, in_type))
4877 type_string = g_variant_type_dup_string (in_type);
4879 reply = g_dbus_message_new_method_error (message,
4880 "org.freedesktop.DBus.Error.InvalidArgs",
4881 _("Type of message, `%s', does not match expected type `%s'"),
4882 g_variant_get_type_string (parameters),
4884 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4885 g_variant_type_free (in_type);
4886 g_variant_unref (parameters);
4887 g_object_unref (reply);
4888 g_free (type_string);
4892 g_variant_type_free (in_type);
4894 /* schedule the call in idle */
4895 invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
4896 g_dbus_message_get_path (message),
4897 g_dbus_message_get_interface (message),
4898 g_dbus_message_get_member (message),
4904 g_variant_unref (parameters);
4906 /* TODO: would be nicer with a real MethodData like we already
4907 * have PropertyData and PropertyGetAllData... */
4908 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
4909 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
4910 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
4912 idle_source = g_idle_source_new ();
4913 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4914 g_source_set_callback (idle_source,
4918 g_source_attach (idle_source, main_context);
4919 g_source_unref (idle_source);
4927 /* ---------------------------------------------------------------------------------------------------- */
4929 /* called in GDBusWorker thread with connection's lock held */
4931 obj_message_func (GDBusConnection *connection,
4933 GDBusMessage *message)
4935 const gchar *interface_name;
4936 const gchar *member;
4937 const gchar *signature;
4942 interface_name = g_dbus_message_get_interface (message);
4943 member = g_dbus_message_get_member (message);
4944 signature = g_dbus_message_get_signature (message);
4946 /* see if we have an interface for handling this call */
4947 if (interface_name != NULL)
4949 ExportedInterface *ei;
4950 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4953 /* we do - invoke the handler in idle in the right thread */
4955 /* handle no vtable or handler being present */
4956 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
4959 handled = validate_and_maybe_schedule_method_call (connection,
4971 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
4972 g_strcmp0 (member, "Introspect") == 0 &&
4973 g_strcmp0 (signature, "") == 0)
4975 handled = handle_introspect (connection, eo, message);
4978 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4979 g_strcmp0 (member, "Get") == 0 &&
4980 g_strcmp0 (signature, "ss") == 0)
4982 handled = handle_getset_property (connection, eo, message, TRUE);
4985 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4986 g_strcmp0 (member, "Set") == 0 &&
4987 g_strcmp0 (signature, "ssv") == 0)
4989 handled = handle_getset_property (connection, eo, message, FALSE);
4992 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4993 g_strcmp0 (member, "GetAll") == 0 &&
4994 g_strcmp0 (signature, "s") == 0)
4996 handled = handle_get_all_properties (connection, eo, message);
5005 * g_dbus_connection_register_object:
5006 * @connection: A #GDBusConnection.
5007 * @object_path: The object path to register at.
5008 * @interface_info: Introspection data for the interface.
5009 * @vtable: (allow-none): A #GDBusInterfaceVTable to call into or %NULL.
5010 * @user_data: (allow-none): Data to pass to functions in @vtable.
5011 * @user_data_free_func: Function to call when the object path is unregistered.
5012 * @error: Return location for error or %NULL.
5014 * Registers callbacks for exported objects at @object_path with the
5015 * D-Bus interface that is described in @interface_info.
5017 * Calls to functions in @vtable (and @user_data_free_func) will
5018 * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
5019 * loop</link> of the thread you are calling this method from.
5021 * Note that all #GVariant values passed to functions in @vtable will match
5022 * the signature given in @interface_info - if a remote caller passes
5023 * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
5024 * is returned to the remote caller.
5026 * Additionally, if the remote caller attempts to invoke methods or
5027 * access properties not mentioned in @interface_info the
5028 * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
5029 * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
5030 * are returned to the caller.
5032 * It is considered a programming error if the
5033 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
5034 * #GVariant of incorrect type.
5036 * If an existing callback is already registered at @object_path and
5037 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
5039 * GDBus automatically implements the standard D-Bus interfaces
5040 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
5041 * and org.freedesktop.Peer, so you don't have to implement those for
5042 * the objects you export. You <emphasis>can</emphasis> implement
5043 * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
5044 * and setting of properties asynchronously.
5046 * Note that the reference count on @interface_info will be
5047 * incremented by 1 (unless allocated statically, e.g. if the
5048 * reference count is -1, see g_dbus_interface_info_ref()) for as long
5049 * as the object is exported. Also note that @vtable will be copied.
5051 * See <xref linkend="gdbus-server"/> for an example of how to use this method.
5053 * Returns: 0 if @error is set, otherwise a registration id (never 0)
5054 * that can be used with g_dbus_connection_unregister_object() .
5059 g_dbus_connection_register_object (GDBusConnection *connection,
5060 const gchar *object_path,
5061 GDBusInterfaceInfo *interface_info,
5062 const GDBusInterfaceVTable *vtable,
5064 GDestroyNotify user_data_free_func,
5068 ExportedInterface *ei;
5071 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
5072 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
5073 g_return_val_if_fail (interface_info != NULL, 0);
5074 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
5075 g_return_val_if_fail (error == NULL || *error == NULL, 0);
5076 g_return_val_if_fail (check_initialized (connection), 0);
5080 CONNECTION_LOCK (connection);
5082 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
5085 eo = g_new0 (ExportedObject, 1);
5086 eo->object_path = g_strdup (object_path);
5087 eo->connection = connection;
5088 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
5091 (GDestroyNotify) exported_interface_free);
5092 g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
5095 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
5101 _("An object is already exported for the interface %s at %s"),
5102 interface_info->name,
5107 ei = g_new0 (ExportedInterface, 1);
5108 ei->id = _global_registration_id++; /* TODO: overflow etc. */
5110 ei->user_data = user_data;
5111 ei->user_data_free_func = user_data_free_func;
5112 ei->vtable = _g_dbus_interface_vtable_copy (vtable);
5113 ei->interface_info = g_dbus_interface_info_ref (interface_info);
5114 g_dbus_interface_info_cache_build (ei->interface_info);
5115 ei->interface_name = g_strdup (interface_info->name);
5116 ei->context = g_main_context_ref_thread_default ();
5118 g_hash_table_insert (eo->map_if_name_to_ei,
5119 (gpointer) ei->interface_name,
5121 g_hash_table_insert (connection->map_id_to_ei,
5122 GUINT_TO_POINTER (ei->id),
5128 CONNECTION_UNLOCK (connection);
5134 * g_dbus_connection_unregister_object:
5135 * @connection: A #GDBusConnection.
5136 * @registration_id: A registration id obtained from g_dbus_connection_register_object().
5138 * Unregisters an object.
5140 * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
5145 g_dbus_connection_unregister_object (GDBusConnection *connection,
5146 guint registration_id)
5148 ExportedInterface *ei;
5152 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5153 g_return_val_if_fail (check_initialized (connection), FALSE);
5157 CONNECTION_LOCK (connection);
5159 ei = g_hash_table_lookup (connection->map_id_to_ei,
5160 GUINT_TO_POINTER (registration_id));
5166 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
5167 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
5168 /* unregister object path if we have no more exported interfaces */
5169 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
5170 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
5176 CONNECTION_UNLOCK (connection);
5181 /* ---------------------------------------------------------------------------------------------------- */
5184 * g_dbus_connection_emit_signal:
5185 * @connection: A #GDBusConnection.
5186 * @destination_bus_name: (allow-none): The unique bus name for the destination
5187 * for the signal or %NULL to emit to all listeners.
5188 * @object_path: Path of remote object.
5189 * @interface_name: D-Bus interface to emit a signal on.
5190 * @signal_name: The name of the signal to emit.
5191 * @parameters: (allow-none): A #GVariant tuple with parameters for the signal
5192 * or %NULL if not passing parameters.
5193 * @error: Return location for error or %NULL.
5197 * If the parameters GVariant is floating, it is consumed.
5199 * This can only fail if @parameters is not compatible with the D-Bus protocol.
5201 * Returns: %TRUE unless @error is set.
5206 g_dbus_connection_emit_signal (GDBusConnection *connection,
5207 const gchar *destination_bus_name,
5208 const gchar *object_path,
5209 const gchar *interface_name,
5210 const gchar *signal_name,
5211 GVariant *parameters,
5214 GDBusMessage *message;
5220 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5221 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
5222 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
5223 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
5224 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
5225 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
5226 g_return_val_if_fail (check_initialized (connection), FALSE);
5228 if (G_UNLIKELY (_g_dbus_debug_emission ()))
5230 _g_dbus_debug_print_lock ();
5231 g_print ("========================================================================\n"
5232 "GDBus-debug:Emission:\n"
5233 " >>>> SIGNAL EMISSION %s.%s()\n"
5235 " destination %s\n",
5236 interface_name, signal_name,
5238 destination_bus_name != NULL ? destination_bus_name : "(none)");
5239 _g_dbus_debug_print_unlock ();
5242 message = g_dbus_message_new_signal (object_path,
5246 if (destination_bus_name != NULL)
5247 g_dbus_message_set_header (message,
5248 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
5249 g_variant_new_string (destination_bus_name));
5251 if (parameters != NULL)
5252 g_dbus_message_set_body (message, parameters);
5254 ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
5255 g_object_unref (message);
5261 add_call_flags (GDBusMessage *message,
5262 GDBusCallFlags flags)
5264 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
5265 g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
5269 decode_method_reply (GDBusMessage *reply,
5270 const gchar *method_name,
5271 const GVariantType *reply_type,
5272 GUnixFDList **out_fd_list,
5278 switch (g_dbus_message_get_message_type (reply))
5280 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
5281 result = g_dbus_message_get_body (reply);
5284 result = g_variant_new ("()");
5285 g_variant_ref_sink (result);
5289 g_variant_ref (result);
5292 if (!g_variant_is_of_type (result, reply_type))
5294 gchar *type_string = g_variant_type_dup_string (reply_type);
5298 G_IO_ERROR_INVALID_ARGUMENT,
5299 _("Method `%s' returned type `%s', but expected `%s'"),
5300 method_name, g_variant_get_type_string (result), type_string);
5302 g_variant_unref (result);
5303 g_free (type_string);
5310 if (out_fd_list != NULL)
5312 *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
5313 if (*out_fd_list != NULL)
5314 g_object_ref (*out_fd_list);
5320 case G_DBUS_MESSAGE_TYPE_ERROR:
5321 g_dbus_message_to_gerror (reply, error);
5325 g_assert_not_reached ();
5335 GSimpleAsyncResult *simple;
5336 GVariantType *reply_type;
5337 gchar *method_name; /* for error message */
5341 GUnixFDList *fd_list;
5345 call_state_free (CallState *state)
5347 g_variant_type_free (state->reply_type);
5348 g_free (state->method_name);
5350 if (state->value != NULL)
5351 g_variant_unref (state->value);
5352 if (state->fd_list != NULL)
5353 g_object_unref (state->fd_list);
5354 g_slice_free (CallState, state);
5357 /* called in any thread, with the connection's lock not held */
5359 g_dbus_connection_call_done (GObject *source,
5360 GAsyncResult *result,
5363 GSimpleAsyncResult *simple;
5364 GDBusConnection *connection = G_DBUS_CONNECTION (source);
5365 CallState *state = user_data;
5367 GDBusMessage *reply;
5370 reply = g_dbus_connection_send_message_with_reply_finish (connection,
5374 if (G_UNLIKELY (_g_dbus_debug_call ()))
5376 _g_dbus_debug_print_lock ();
5377 g_print ("========================================================================\n"
5378 "GDBus-debug:Call:\n"
5379 " <<<< ASYNC COMPLETE %s() (serial %d)\n"
5385 g_print ("SUCCESS\n");
5389 g_print ("FAILED: %s\n",
5392 _g_dbus_debug_print_unlock ();
5396 state->value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
5398 simple = state->simple; /* why? because state is freed before we unref simple.. */
5401 g_simple_async_result_take_error (state->simple, error);
5402 g_simple_async_result_complete (state->simple);
5403 call_state_free (state);
5407 g_simple_async_result_set_op_res_gpointer (state->simple, state, (GDestroyNotify) call_state_free);
5408 g_simple_async_result_complete (state->simple);
5410 g_clear_object (&reply);
5411 g_object_unref (simple);
5414 /* called in any thread, with the connection's lock not held */
5416 g_dbus_connection_call_internal (GDBusConnection *connection,
5417 const gchar *bus_name,
5418 const gchar *object_path,
5419 const gchar *interface_name,
5420 const gchar *method_name,
5421 GVariant *parameters,
5422 const GVariantType *reply_type,
5423 GDBusCallFlags flags,
5425 GUnixFDList *fd_list,
5426 GCancellable *cancellable,
5427 GAsyncReadyCallback callback,
5430 GDBusMessage *message;
5433 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
5434 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
5435 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
5436 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
5437 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
5438 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
5439 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
5440 g_return_if_fail (check_initialized (connection));
5442 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
5444 g_return_if_fail (fd_list == NULL);
5447 message = g_dbus_message_new_method_call (bus_name,
5451 add_call_flags (message, flags);
5452 if (parameters != NULL)
5453 g_dbus_message_set_body (message, parameters);
5456 if (fd_list != NULL)
5457 g_dbus_message_set_unix_fd_list (message, fd_list);
5460 /* If the user has no callback then we can just send the message with
5461 * the G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set and skip all
5462 * the logic for processing the reply. If the service sends the reply
5463 * anyway then it will just be ignored.
5465 if (callback != NULL)
5469 state = g_slice_new0 (CallState);
5470 state->simple = g_simple_async_result_new (G_OBJECT (connection),
5471 callback, user_data,
5472 g_dbus_connection_call_internal);
5473 g_simple_async_result_set_check_cancellable (state->simple, cancellable);
5474 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
5476 if (reply_type == NULL)
5477 reply_type = G_VARIANT_TYPE_ANY;
5479 state->reply_type = g_variant_type_copy (reply_type);
5481 g_dbus_connection_send_message_with_reply (connection,
5483 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5487 g_dbus_connection_call_done,
5489 serial = state->serial;
5493 GDBusMessageFlags flags;
5495 flags = g_dbus_message_get_flags (message);
5496 flags |= G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
5497 g_dbus_message_set_flags (message, flags);
5499 g_dbus_connection_send_message (connection,
5501 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5505 if (G_UNLIKELY (_g_dbus_debug_call ()))
5507 _g_dbus_debug_print_lock ();
5508 g_print ("========================================================================\n"
5509 "GDBus-debug:Call:\n"
5510 " >>>> ASYNC %s.%s()\n"
5512 " owned by name %s (serial %d)\n",
5516 bus_name != NULL ? bus_name : "(none)",
5518 _g_dbus_debug_print_unlock ();
5521 if (message != NULL)
5522 g_object_unref (message);
5525 /* called in any thread, with the connection's lock not held */
5527 g_dbus_connection_call_finish_internal (GDBusConnection *connection,
5528 GUnixFDList **out_fd_list,
5532 GSimpleAsyncResult *simple;
5535 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5536 g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
5537 g_dbus_connection_call_internal), NULL);
5538 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5540 simple = G_SIMPLE_ASYNC_RESULT (res);
5542 if (g_simple_async_result_propagate_error (simple, error))
5545 state = g_simple_async_result_get_op_res_gpointer (simple);
5546 if (out_fd_list != NULL)
5547 *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
5548 return g_variant_ref (state->value);
5551 /* called in any user thread, with the connection's lock not held */
5553 g_dbus_connection_call_sync_internal (GDBusConnection *connection,
5554 const gchar *bus_name,
5555 const gchar *object_path,
5556 const gchar *interface_name,
5557 const gchar *method_name,
5558 GVariant *parameters,
5559 const GVariantType *reply_type,
5560 GDBusCallFlags flags,
5562 GUnixFDList *fd_list,
5563 GUnixFDList **out_fd_list,
5564 GCancellable *cancellable,
5567 GDBusMessage *message;
5568 GDBusMessage *reply;
5570 GError *local_error;
5571 GDBusSendMessageFlags send_flags;
5577 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5578 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
5579 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
5580 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
5581 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
5582 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
5583 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
5585 g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
5587 g_return_val_if_fail (fd_list == NULL, NULL);
5589 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5591 if (!(flags & CALL_FLAGS_INITIALIZING))
5592 g_return_val_if_fail (check_initialized (connection), FALSE);
5594 if (reply_type == NULL)
5595 reply_type = G_VARIANT_TYPE_ANY;
5597 message = g_dbus_message_new_method_call (bus_name,
5601 add_call_flags (message, flags);
5602 if (parameters != NULL)
5603 g_dbus_message_set_body (message, parameters);
5606 if (fd_list != NULL)
5607 g_dbus_message_set_unix_fd_list (message, fd_list);
5610 if (G_UNLIKELY (_g_dbus_debug_call ()))
5612 _g_dbus_debug_print_lock ();
5613 g_print ("========================================================================\n"
5614 "GDBus-debug:Call:\n"
5615 " >>>> SYNC %s.%s()\n"
5617 " owned by name %s\n",
5621 bus_name != NULL ? bus_name : "(none)");
5622 _g_dbus_debug_print_unlock ();
5627 send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
5629 /* translate from one flavour of flags to another... */
5630 if (flags & CALL_FLAGS_INITIALIZING)
5631 send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
5633 reply = g_dbus_connection_send_message_with_reply_sync (connection,
5637 NULL, /* volatile guint32 *out_serial */
5641 if (G_UNLIKELY (_g_dbus_debug_call ()))
5643 _g_dbus_debug_print_lock ();
5644 g_print ("========================================================================\n"
5645 "GDBus-debug:Call:\n"
5646 " <<<< SYNC COMPLETE %s.%s()\n"
5652 g_print ("SUCCESS\n");
5656 g_print ("FAILED: %s\n",
5657 local_error->message);
5659 _g_dbus_debug_print_unlock ();
5665 *error = local_error;
5667 g_error_free (local_error);
5671 result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
5674 if (message != NULL)
5675 g_object_unref (message);
5677 g_object_unref (reply);
5682 /* ---------------------------------------------------------------------------------------------------- */
5685 * g_dbus_connection_call:
5686 * @connection: A #GDBusConnection.
5687 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5688 * @connection is not a message bus connection.
5689 * @object_path: Path of remote object.
5690 * @interface_name: D-Bus interface to invoke method on.
5691 * @method_name: The name of the method to invoke.
5692 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5693 * or %NULL if not passing parameters.
5694 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5695 * @flags: Flags from the #GDBusCallFlags enumeration.
5696 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5697 * timeout or %G_MAXINT for no timeout.
5698 * @cancellable: (allow-none): A #GCancellable or %NULL.
5699 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
5700 * satisfied or %NULL if you don't care about the result of the
5701 * method invocation.
5702 * @user_data: The data to pass to @callback.
5704 * Asynchronously invokes the @method_name method on the
5705 * @interface_name D-Bus interface on the remote object at
5706 * @object_path owned by @bus_name.
5708 * If @connection is closed then the operation will fail with
5709 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
5710 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
5711 * not compatible with the D-Bus protocol, the operation fails with
5712 * %G_IO_ERROR_INVALID_ARGUMENT.
5714 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
5715 * error will be raised if it does not match. Said another way, if you give a @reply_type
5716 * then any non-%NULL return value will be of this type.
5718 * If the @parameters #GVariant is floating, it is consumed. This allows
5719 * convenient 'inline' use of g_variant_new(), e.g.:
5721 * g_dbus_connection_call (connection,
5722 * "org.freedesktop.StringThings",
5723 * "/org/freedesktop/StringThings",
5724 * "org.freedesktop.StringThings",
5726 * g_variant_new ("(ss)",
5730 * G_DBUS_CALL_FLAGS_NONE,
5733 * (GAsyncReadyCallback) two_strings_done,
5737 * This is an asynchronous method. When the operation is finished, @callback will be invoked
5738 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
5739 * of the thread you are calling this method from. You can then call
5740 * g_dbus_connection_call_finish() to get the result of the operation.
5741 * See g_dbus_connection_call_sync() for the synchronous version of this
5744 * If @callback is %NULL then the D-Bus method call message will be sent with
5745 * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
5750 g_dbus_connection_call (GDBusConnection *connection,
5751 const gchar *bus_name,
5752 const gchar *object_path,
5753 const gchar *interface_name,
5754 const gchar *method_name,
5755 GVariant *parameters,
5756 const GVariantType *reply_type,
5757 GDBusCallFlags flags,
5759 GCancellable *cancellable,
5760 GAsyncReadyCallback callback,
5763 g_dbus_connection_call_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, NULL, cancellable, callback, user_data);
5767 * g_dbus_connection_call_finish:
5768 * @connection: A #GDBusConnection.
5769 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
5770 * @error: Return location for error or %NULL.
5772 * Finishes an operation started with g_dbus_connection_call().
5774 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5775 * return values. Free with g_variant_unref().
5780 g_dbus_connection_call_finish (GDBusConnection *connection,
5784 return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
5788 * g_dbus_connection_call_sync:
5789 * @connection: A #GDBusConnection.
5790 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5791 * @connection is not a message bus connection.
5792 * @object_path: Path of remote object.
5793 * @interface_name: D-Bus interface to invoke method on.
5794 * @method_name: The name of the method to invoke.
5795 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5796 * or %NULL if not passing parameters.
5797 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5798 * @flags: Flags from the #GDBusCallFlags enumeration.
5799 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5800 * timeout or %G_MAXINT for no timeout.
5801 * @cancellable: (allow-none): A #GCancellable or %NULL.
5802 * @error: Return location for error or %NULL.
5804 * Synchronously invokes the @method_name method on the
5805 * @interface_name D-Bus interface on the remote object at
5806 * @object_path owned by @bus_name.
5808 * If @connection is closed then the operation will fail with
5809 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
5810 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
5811 * contains a value not compatible with the D-Bus protocol, the operation
5812 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
5814 * If @reply_type is non-%NULL then the reply will be checked for having
5815 * this type and an error will be raised if it does not match. Said
5816 * another way, if you give a @reply_type then any non-%NULL return
5817 * value will be of this type.
5819 * If the @parameters #GVariant is floating, it is consumed.
5820 * This allows convenient 'inline' use of g_variant_new(), e.g.:
5822 * g_dbus_connection_call_sync (connection,
5823 * "org.freedesktop.StringThings",
5824 * "/org/freedesktop/StringThings",
5825 * "org.freedesktop.StringThings",
5827 * g_variant_new ("(ss)",
5831 * G_DBUS_CALL_FLAGS_NONE,
5837 * The calling thread is blocked until a reply is received. See
5838 * g_dbus_connection_call() for the asynchronous version of
5841 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5842 * return values. Free with g_variant_unref().
5847 g_dbus_connection_call_sync (GDBusConnection *connection,
5848 const gchar *bus_name,
5849 const gchar *object_path,
5850 const gchar *interface_name,
5851 const gchar *method_name,
5852 GVariant *parameters,
5853 const GVariantType *reply_type,
5854 GDBusCallFlags flags,
5856 GCancellable *cancellable,
5859 return g_dbus_connection_call_sync_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, NULL, NULL, cancellable, error);
5862 /* ---------------------------------------------------------------------------------------------------- */
5867 * g_dbus_connection_call_with_unix_fd_list:
5868 * @connection: A #GDBusConnection.
5869 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5870 * @connection is not a message bus connection.
5871 * @object_path: Path of remote object.
5872 * @interface_name: D-Bus interface to invoke method on.
5873 * @method_name: The name of the method to invoke.
5874 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5875 * or %NULL if not passing parameters.
5876 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5877 * @flags: Flags from the #GDBusCallFlags enumeration.
5878 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5879 * timeout or %G_MAXINT for no timeout.
5880 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
5881 * @cancellable: (allow-none): A #GCancellable or %NULL.
5882 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
5883 * satisfied or %NULL if you don't * care about the result of the
5884 * method invocation.
5885 * @user_data: The data to pass to @callback.
5887 * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
5889 * This method is only available on UNIX.
5894 g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
5895 const gchar *bus_name,
5896 const gchar *object_path,
5897 const gchar *interface_name,
5898 const gchar *method_name,
5899 GVariant *parameters,
5900 const GVariantType *reply_type,
5901 GDBusCallFlags flags,
5903 GUnixFDList *fd_list,
5904 GCancellable *cancellable,
5905 GAsyncReadyCallback callback,
5908 g_dbus_connection_call_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, fd_list, cancellable, callback, user_data);
5912 * g_dbus_connection_call_with_unix_fd_list_finish:
5913 * @connection: A #GDBusConnection.
5914 * @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL.
5915 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list().
5916 * @error: Return location for error or %NULL.
5918 * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
5920 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5921 * return values. Free with g_variant_unref().
5926 g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
5927 GUnixFDList **out_fd_list,
5931 return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
5935 * g_dbus_connection_call_with_unix_fd_list_sync:
5936 * @connection: A #GDBusConnection.
5937 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5938 * @connection is not a message bus connection.
5939 * @object_path: Path of remote object.
5940 * @interface_name: D-Bus interface to invoke method on.
5941 * @method_name: The name of the method to invoke.
5942 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5943 * or %NULL if not passing parameters.
5944 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5945 * @flags: Flags from the #GDBusCallFlags enumeration.
5946 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5947 * timeout or %G_MAXINT for no timeout.
5948 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
5949 * @out_fd_list: (out) (allow-none): Return location for a #GUnixFDList or %NULL.
5950 * @cancellable: (allow-none): A #GCancellable or %NULL.
5951 * @error: Return location for error or %NULL.
5953 * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
5955 * This method is only available on UNIX.
5957 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5958 * return values. Free with g_variant_unref().
5963 g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
5964 const gchar *bus_name,
5965 const gchar *object_path,
5966 const gchar *interface_name,
5967 const gchar *method_name,
5968 GVariant *parameters,
5969 const GVariantType *reply_type,
5970 GDBusCallFlags flags,
5972 GUnixFDList *fd_list,
5973 GUnixFDList **out_fd_list,
5974 GCancellable *cancellable,
5977 return g_dbus_connection_call_sync_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, fd_list, out_fd_list, cancellable, error);
5980 #endif /* G_OS_UNIX */
5982 /* ---------------------------------------------------------------------------------------------------- */
5984 struct ExportedSubtree
5988 GDBusConnection *connection;
5989 GDBusSubtreeVTable *vtable;
5990 GDBusSubtreeFlags flags;
5992 GMainContext *context;
5994 GDestroyNotify user_data_free_func;
5998 exported_subtree_free (ExportedSubtree *es)
6000 call_destroy_notify (es->context,
6001 es->user_data_free_func,
6004 g_main_context_unref (es->context);
6006 _g_dbus_subtree_vtable_free (es->vtable);
6007 g_free (es->object_path);
6011 /* called without lock held in the thread where the caller registered
6015 handle_subtree_introspect (GDBusConnection *connection,
6016 ExportedSubtree *es,
6017 GDBusMessage *message)
6021 GDBusMessage *reply;
6024 const gchar *sender;
6025 const gchar *requested_object_path;
6026 const gchar *requested_node;
6027 GDBusInterfaceInfo **interfaces;
6029 gchar **subnode_paths;
6030 gboolean has_properties_interface;
6031 gboolean has_introspectable_interface;
6035 requested_object_path = g_dbus_message_get_path (message);
6036 sender = g_dbus_message_get_sender (message);
6037 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6039 s = g_string_new (NULL);
6040 introspect_append_header (s);
6042 /* Strictly we don't need the children in dynamic mode, but we avoid the
6043 * conditionals to preserve code clarity
6045 children = es->vtable->enumerate (es->connection,
6052 requested_node = strrchr (requested_object_path, '/') + 1;
6054 /* Assert existence of object if we are not dynamic */
6055 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
6056 !_g_strv_has_string ((const gchar * const *) children, requested_node))
6061 requested_node = NULL;
6064 interfaces = es->vtable->introspect (es->connection,
6069 if (interfaces != NULL)
6071 has_properties_interface = FALSE;
6072 has_introspectable_interface = FALSE;
6074 for (n = 0; interfaces[n] != NULL; n++)
6076 if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
6077 has_properties_interface = TRUE;
6078 else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
6079 has_introspectable_interface = TRUE;
6081 if (!has_properties_interface)
6082 g_string_append (s, introspect_properties_interface);
6083 if (!has_introspectable_interface)
6084 g_string_append (s, introspect_introspectable_interface);
6086 for (n = 0; interfaces[n] != NULL; n++)
6088 g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
6089 g_dbus_interface_info_unref (interfaces[n]);
6091 g_free (interfaces);
6094 /* then include <node> entries from the Subtree for the root */
6097 for (n = 0; children != NULL && children[n] != NULL; n++)
6098 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
6101 /* finally include nodes registered below us */
6102 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
6103 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
6104 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
6105 g_strfreev (subnode_paths);
6107 g_string_append (s, "</node>\n");
6109 reply = g_dbus_message_new_method_reply (message);
6110 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6111 g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6112 g_object_unref (reply);
6117 g_string_free (s, TRUE);
6118 g_strfreev (children);
6122 /* called without lock held in the thread where the caller registered
6126 handle_subtree_method_invocation (GDBusConnection *connection,
6127 ExportedSubtree *es,
6128 GDBusMessage *message)
6131 const gchar *sender;
6132 const gchar *interface_name;
6133 const gchar *member;
6134 const gchar *signature;
6135 const gchar *requested_object_path;
6136 const gchar *requested_node;
6138 GDBusInterfaceInfo *interface_info;
6139 const GDBusInterfaceVTable *interface_vtable;
6140 gpointer interface_user_data;
6142 GDBusInterfaceInfo **interfaces;
6143 gboolean is_property_get;
6144 gboolean is_property_set;
6145 gboolean is_property_get_all;
6150 requested_object_path = g_dbus_message_get_path (message);
6151 sender = g_dbus_message_get_sender (message);
6152 interface_name = g_dbus_message_get_interface (message);
6153 member = g_dbus_message_get_member (message);
6154 signature = g_dbus_message_get_signature (message);
6155 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6157 is_property_get = FALSE;
6158 is_property_set = FALSE;
6159 is_property_get_all = FALSE;
6160 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
6162 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
6163 is_property_get = TRUE;
6164 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
6165 is_property_set = TRUE;
6166 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
6167 is_property_get_all = TRUE;
6172 requested_node = strrchr (requested_object_path, '/') + 1;
6174 if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
6176 /* We don't want to dispatch to unenumerated
6177 * nodes, so ensure that the child exists.
6182 children = es->vtable->enumerate (es->connection,
6187 exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
6188 g_strfreev (children);
6196 requested_node = NULL;
6199 /* get introspection data for the node */
6200 interfaces = es->vtable->introspect (es->connection,
6202 requested_object_path,
6206 if (interfaces == NULL)
6209 interface_info = NULL;
6210 for (n = 0; interfaces[n] != NULL; n++)
6212 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6213 interface_info = interfaces[n];
6216 /* dispatch the call if the user wants to handle it */
6217 if (interface_info != NULL)
6219 /* figure out where to dispatch the method call */
6220 interface_user_data = NULL;
6221 interface_vtable = es->vtable->dispatch (es->connection,
6226 &interface_user_data,
6228 if (interface_vtable == NULL)
6231 CONNECTION_LOCK (connection);
6232 handled = validate_and_maybe_schedule_method_call (es->connection,
6239 interface_user_data);
6240 CONNECTION_UNLOCK (connection);
6242 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
6243 else if (is_property_get || is_property_set || is_property_get_all)
6245 if (is_property_get)
6246 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
6247 else if (is_property_set)
6248 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
6249 else if (is_property_get_all)
6250 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
6252 g_assert_not_reached ();
6254 /* see if the object supports this interface at all */
6255 for (n = 0; interfaces[n] != NULL; n++)
6257 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6258 interface_info = interfaces[n];
6261 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
6262 * claims it won't support the interface
6264 if (interface_info == NULL)
6266 GDBusMessage *reply;
6267 reply = g_dbus_message_new_method_error (message,
6268 "org.freedesktop.DBus.Error.InvalidArgs",
6269 _("No such interface `%s'"),
6271 g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6272 g_object_unref (reply);
6277 /* figure out where to dispatch the property get/set/getall calls */
6278 interface_user_data = NULL;
6279 interface_vtable = es->vtable->dispatch (es->connection,
6284 &interface_user_data,
6286 if (interface_vtable == NULL)
6288 g_warning ("The subtree introspection function indicates that '%s' "
6289 "is a valid interface name, but calling the dispatch "
6290 "function on that interface gave us NULL", interface_name);
6294 if (is_property_get || is_property_set)
6296 CONNECTION_LOCK (connection);
6297 handled = validate_and_maybe_schedule_property_getset (es->connection,
6305 interface_user_data);
6306 CONNECTION_UNLOCK (connection);
6308 else if (is_property_get_all)
6310 CONNECTION_LOCK (connection);
6311 handled = validate_and_maybe_schedule_property_get_all (es->connection,
6318 interface_user_data);
6319 CONNECTION_UNLOCK (connection);
6324 if (interfaces != NULL)
6326 for (n = 0; interfaces[n] != NULL; n++)
6327 g_dbus_interface_info_unref (interfaces[n]);
6328 g_free (interfaces);
6336 GDBusMessage *message;
6337 ExportedSubtree *es;
6338 } SubtreeDeferredData;
6341 subtree_deferred_data_free (SubtreeDeferredData *data)
6343 g_object_unref (data->message);
6347 /* called without lock held in the thread where the caller registered the subtree */
6349 process_subtree_vtable_message_in_idle_cb (gpointer _data)
6351 SubtreeDeferredData *data = _data;
6356 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
6357 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
6358 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
6359 handled = handle_subtree_introspect (data->es->connection,
6363 handled = handle_subtree_method_invocation (data->es->connection,
6369 CONNECTION_LOCK (data->es->connection);
6370 handled = handle_generic_unlocked (data->es->connection, data->message);
6371 CONNECTION_UNLOCK (data->es->connection);
6374 /* if we couldn't handle the request, just bail with the UnknownMethod error */
6377 GDBusMessage *reply;
6378 reply = g_dbus_message_new_method_error (data->message,
6379 "org.freedesktop.DBus.Error.UnknownMethod",
6380 _("Method `%s' on interface `%s' with signature `%s' does not exist"),
6381 g_dbus_message_get_member (data->message),
6382 g_dbus_message_get_interface (data->message),
6383 g_dbus_message_get_signature (data->message));
6384 g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6385 g_object_unref (reply);
6391 /* called in GDBusWorker thread with connection's lock held */
6393 subtree_message_func (GDBusConnection *connection,
6394 ExportedSubtree *es,
6395 GDBusMessage *message)
6397 GSource *idle_source;
6398 SubtreeDeferredData *data;
6400 data = g_new0 (SubtreeDeferredData, 1);
6401 data->message = g_object_ref (message);
6404 /* defer this call to an idle handler in the right thread */
6405 idle_source = g_idle_source_new ();
6406 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
6407 g_source_set_callback (idle_source,
6408 process_subtree_vtable_message_in_idle_cb,
6410 (GDestroyNotify) subtree_deferred_data_free);
6411 g_source_attach (idle_source, es->context);
6412 g_source_unref (idle_source);
6414 /* since we own the entire subtree, handlers for objects not in the subtree have been
6415 * tried already by libdbus-1 - so we just need to ensure that we're always going
6416 * to reply to the message
6422 * g_dbus_connection_register_subtree:
6423 * @connection: A #GDBusConnection.
6424 * @object_path: The object path to register the subtree at.
6425 * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
6426 * @flags: Flags used to fine tune the behavior of the subtree.
6427 * @user_data: Data to pass to functions in @vtable.
6428 * @user_data_free_func: Function to call when the subtree is unregistered.
6429 * @error: Return location for error or %NULL.
6431 * Registers a whole subtree of <quote>dynamic</quote> objects.
6433 * The @enumerate and @introspection functions in @vtable are used to
6434 * convey, to remote callers, what nodes exist in the subtree rooted
6437 * When handling remote calls into any node in the subtree, first the
6438 * @enumerate function is used to check if the node exists. If the node exists
6439 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
6440 * the @introspection function is used to check if the node supports the
6441 * requested method. If so, the @dispatch function is used to determine
6442 * where to dispatch the call. The collected #GDBusInterfaceVTable and
6443 * #gpointer will be used to call into the interface vtable for processing
6446 * All calls into user-provided code will be invoked in the <link
6447 * linkend="g-main-context-push-thread-default">thread-default main
6448 * loop</link> of the thread you are calling this method from.
6450 * If an existing subtree is already registered at @object_path or
6451 * then @error is set to #G_IO_ERROR_EXISTS.
6453 * Note that it is valid to register regular objects (using
6454 * g_dbus_connection_register_object()) in a subtree registered with
6455 * g_dbus_connection_register_subtree() - if so, the subtree handler
6456 * is tried as the last resort. One way to think about a subtree
6457 * handler is to consider it a <quote>fallback handler</quote>
6458 * for object paths not registered via g_dbus_connection_register_object()
6459 * or other bindings.
6461 * Note that @vtable will be copied so you cannot change it after
6464 * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
6466 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
6467 * that can be used with g_dbus_connection_unregister_subtree() .
6472 g_dbus_connection_register_subtree (GDBusConnection *connection,
6473 const gchar *object_path,
6474 const GDBusSubtreeVTable *vtable,
6475 GDBusSubtreeFlags flags,
6477 GDestroyNotify user_data_free_func,
6481 ExportedSubtree *es;
6483 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
6484 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
6485 g_return_val_if_fail (vtable != NULL, 0);
6486 g_return_val_if_fail (error == NULL || *error == NULL, 0);
6487 g_return_val_if_fail (check_initialized (connection), 0);
6491 CONNECTION_LOCK (connection);
6493 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6499 _("A subtree is already exported for %s"),
6504 es = g_new0 (ExportedSubtree, 1);
6505 es->object_path = g_strdup (object_path);
6506 es->connection = connection;
6508 es->vtable = _g_dbus_subtree_vtable_copy (vtable);
6510 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
6511 es->user_data = user_data;
6512 es->user_data_free_func = user_data_free_func;
6513 es->context = g_main_context_ref_thread_default ();
6515 g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
6516 g_hash_table_insert (connection->map_id_to_es,
6517 GUINT_TO_POINTER (es->id),
6523 CONNECTION_UNLOCK (connection);
6528 /* ---------------------------------------------------------------------------------------------------- */
6531 * g_dbus_connection_unregister_subtree:
6532 * @connection: A #GDBusConnection.
6533 * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
6535 * Unregisters a subtree.
6537 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
6542 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
6543 guint registration_id)
6545 ExportedSubtree *es;
6548 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
6549 g_return_val_if_fail (check_initialized (connection), FALSE);
6553 CONNECTION_LOCK (connection);
6555 es = g_hash_table_lookup (connection->map_id_to_es,
6556 GUINT_TO_POINTER (registration_id));
6560 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
6561 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
6566 CONNECTION_UNLOCK (connection);
6571 /* ---------------------------------------------------------------------------------------------------- */
6573 /* may be called in any thread, with connection's lock held */
6575 handle_generic_ping_unlocked (GDBusConnection *connection,
6576 const gchar *object_path,
6577 GDBusMessage *message)
6579 GDBusMessage *reply;
6580 reply = g_dbus_message_new_method_reply (message);
6581 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6582 g_object_unref (reply);
6585 /* may be called in any thread, with connection's lock held */
6587 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
6588 const gchar *object_path,
6589 GDBusMessage *message)
6591 GDBusMessage *reply;
6594 if (connection->machine_id == NULL)
6599 connection->machine_id = _g_dbus_get_machine_id (&error);
6600 if (connection->machine_id == NULL)
6602 reply = g_dbus_message_new_method_error_literal (message,
6603 "org.freedesktop.DBus.Error.Failed",
6605 g_error_free (error);
6611 reply = g_dbus_message_new_method_reply (message);
6612 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
6614 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6615 g_object_unref (reply);
6618 /* may be called in any thread, with connection's lock held */
6620 handle_generic_introspect_unlocked (GDBusConnection *connection,
6621 const gchar *object_path,
6622 GDBusMessage *message)
6627 GDBusMessage *reply;
6629 /* first the header */
6630 s = g_string_new (NULL);
6631 introspect_append_header (s);
6633 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
6634 for (n = 0; registered != NULL && registered[n] != NULL; n++)
6635 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
6636 g_strfreev (registered);
6637 g_string_append (s, "</node>\n");
6639 reply = g_dbus_message_new_method_reply (message);
6640 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6641 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6642 g_object_unref (reply);
6643 g_string_free (s, TRUE);
6646 /* may be called in any thread, with connection's lock held */
6648 handle_generic_unlocked (GDBusConnection *connection,
6649 GDBusMessage *message)
6652 const gchar *interface_name;
6653 const gchar *member;
6654 const gchar *signature;
6657 CONNECTION_ENSURE_LOCK (connection);
6661 interface_name = g_dbus_message_get_interface (message);
6662 member = g_dbus_message_get_member (message);
6663 signature = g_dbus_message_get_signature (message);
6664 path = g_dbus_message_get_path (message);
6666 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
6667 g_strcmp0 (member, "Introspect") == 0 &&
6668 g_strcmp0 (signature, "") == 0)
6670 handle_generic_introspect_unlocked (connection, path, message);
6673 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6674 g_strcmp0 (member, "Ping") == 0 &&
6675 g_strcmp0 (signature, "") == 0)
6677 handle_generic_ping_unlocked (connection, path, message);
6680 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6681 g_strcmp0 (member, "GetMachineId") == 0 &&
6682 g_strcmp0 (signature, "") == 0)
6684 handle_generic_get_machine_id_unlocked (connection, path, message);
6691 /* ---------------------------------------------------------------------------------------------------- */
6693 /* called in GDBusWorker thread with connection's lock held */
6695 distribute_method_call (GDBusConnection *connection,
6696 GDBusMessage *message)
6698 GDBusMessage *reply;
6700 ExportedSubtree *es;
6701 const gchar *object_path;
6702 const gchar *interface_name;
6703 const gchar *member;
6705 gchar *subtree_path;
6708 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
6710 interface_name = g_dbus_message_get_interface (message);
6711 member = g_dbus_message_get_member (message);
6712 path = g_dbus_message_get_path (message);
6713 subtree_path = g_strdup (path);
6714 needle = strrchr (subtree_path, '/');
6715 if (needle != NULL && needle != subtree_path)
6721 g_free (subtree_path);
6722 subtree_path = NULL;
6726 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
6728 _g_dbus_debug_print_lock ();
6729 g_print ("========================================================================\n"
6730 "GDBus-debug:Incoming:\n"
6731 " <<<< METHOD INVOCATION %s.%s()\n"
6733 " invoked by name %s\n"
6735 interface_name, member,
6737 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
6738 g_dbus_message_get_serial (message));
6739 _g_dbus_debug_print_unlock ();
6742 object_path = g_dbus_message_get_path (message);
6743 g_assert (object_path != NULL);
6745 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
6748 if (obj_message_func (connection, eo, message))
6752 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6755 if (subtree_message_func (connection, es, message))
6759 if (subtree_path != NULL)
6761 es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
6764 if (subtree_message_func (connection, es, message))
6769 if (handle_generic_unlocked (connection, message))
6772 /* if we end up here, the message has not been not handled - so return an error saying this */
6773 reply = g_dbus_message_new_method_error (message,
6774 "org.freedesktop.DBus.Error.UnknownMethod",
6775 _("No such interface `%s' on object at path %s"),
6778 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6779 g_object_unref (reply);
6782 g_free (subtree_path);
6785 /* ---------------------------------------------------------------------------------------------------- */
6787 /* Called in any user thread, with the message_bus_lock held. */
6789 message_bus_get_singleton (GBusType bus_type,
6793 const gchar *starter_bus;
6799 case G_BUS_TYPE_SESSION:
6800 ret = &the_session_bus;
6803 case G_BUS_TYPE_SYSTEM:
6804 ret = &the_system_bus;
6807 case G_BUS_TYPE_STARTER:
6808 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
6809 if (g_strcmp0 (starter_bus, "session") == 0)
6811 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
6814 else if (g_strcmp0 (starter_bus, "system") == 0)
6816 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
6821 if (starter_bus != NULL)
6825 G_IO_ERROR_INVALID_ARGUMENT,
6826 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
6827 " - unknown value `%s'"),
6832 g_set_error_literal (error,
6834 G_IO_ERROR_INVALID_ARGUMENT,
6835 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
6836 "variable is not set"));
6842 g_assert_not_reached ();
6850 /* Called in any user thread, without holding locks. */
6851 static GDBusConnection *
6852 get_uninitialized_connection (GBusType bus_type,
6853 GCancellable *cancellable,
6856 GWeakRef *singleton;
6857 GDBusConnection *ret;
6861 G_LOCK (message_bus_lock);
6862 singleton = message_bus_get_singleton (bus_type, error);
6863 if (singleton == NULL)
6866 ret = g_weak_ref_get (singleton);
6871 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
6872 if (address == NULL)
6874 ret = g_object_new (G_TYPE_DBUS_CONNECTION,
6876 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
6877 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
6878 "exit-on-close", TRUE,
6881 g_weak_ref_set (singleton, ret);
6885 g_assert (ret != NULL);
6888 G_UNLOCK (message_bus_lock);
6892 /* May be called from any thread. Must not hold message_bus_lock. */
6894 _g_bus_get_singleton_if_exists (GBusType bus_type)
6896 GWeakRef *singleton;
6897 GDBusConnection *ret = NULL;
6899 G_LOCK (message_bus_lock);
6900 singleton = message_bus_get_singleton (bus_type, NULL);
6901 if (singleton == NULL)
6904 ret = g_weak_ref_get (singleton);
6907 G_UNLOCK (message_bus_lock);
6913 * @bus_type: A #GBusType.
6914 * @cancellable: (allow-none): A #GCancellable or %NULL.
6915 * @error: Return location for error or %NULL.
6917 * Synchronously connects to the message bus specified by @bus_type.
6918 * Note that the returned object may shared with other callers,
6919 * e.g. if two separate parts of a process calls this function with
6920 * the same @bus_type, they will share the same object.
6922 * This is a synchronous failable function. See g_bus_get() and
6923 * g_bus_get_finish() for the asynchronous version.
6925 * The returned object is a singleton, that is, shared with other
6926 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6927 * event that you need a private message bus connection, use
6928 * g_dbus_address_get_for_bus_sync() and
6929 * g_dbus_connection_new_for_address().
6931 * Note that the returned #GDBusConnection object will (usually) have
6932 * the #GDBusConnection:exit-on-close property set to %TRUE.
6934 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
6939 g_bus_get_sync (GBusType bus_type,
6940 GCancellable *cancellable,
6943 GDBusConnection *connection;
6945 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6947 connection = get_uninitialized_connection (bus_type, cancellable, error);
6948 if (connection == NULL)
6951 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
6953 g_object_unref (connection);
6962 bus_get_async_initable_cb (GObject *source_object,
6966 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
6970 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
6974 g_assert (error != NULL);
6975 g_simple_async_result_take_error (simple, error);
6976 g_object_unref (source_object);
6980 g_simple_async_result_set_op_res_gpointer (simple,
6984 g_simple_async_result_complete_in_idle (simple);
6985 g_object_unref (simple);
6990 * @bus_type: A #GBusType.
6991 * @cancellable: (allow-none): A #GCancellable or %NULL.
6992 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
6993 * @user_data: The data to pass to @callback.
6995 * Asynchronously connects to the message bus specified by @bus_type.
6997 * When the operation is finished, @callback will be invoked. You can
6998 * then call g_bus_get_finish() to get the result of the operation.
7000 * This is a asynchronous failable function. See g_bus_get_sync() for
7001 * the synchronous version.
7006 g_bus_get (GBusType bus_type,
7007 GCancellable *cancellable,
7008 GAsyncReadyCallback callback,
7011 GDBusConnection *connection;
7012 GSimpleAsyncResult *simple;
7015 simple = g_simple_async_result_new (NULL,
7019 g_simple_async_result_set_check_cancellable (simple, cancellable);
7022 connection = get_uninitialized_connection (bus_type, cancellable, &error);
7023 if (connection == NULL)
7025 g_assert (error != NULL);
7026 g_simple_async_result_take_error (simple, error);
7027 g_simple_async_result_complete_in_idle (simple);
7028 g_object_unref (simple);
7032 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
7035 bus_get_async_initable_cb,
7042 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
7043 * @error: Return location for error or %NULL.
7045 * Finishes an operation started with g_bus_get().
7047 * The returned object is a singleton, that is, shared with other
7048 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7049 * event that you need a private message bus connection, use
7050 * g_dbus_address_get_for_bus_sync() and
7051 * g_dbus_connection_new_for_address().
7053 * Note that the returned #GDBusConnection object will (usually) have
7054 * the #GDBusConnection:exit-on-close property set to %TRUE.
7056 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
7061 g_bus_get_finish (GAsyncResult *res,
7064 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
7066 GDBusConnection *ret;
7068 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7070 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
7074 if (g_simple_async_result_propagate_error (simple, error))
7077 object = g_simple_async_result_get_op_res_gpointer (simple);
7078 g_assert (object != NULL);
7079 ret = g_object_ref (G_DBUS_CONNECTION (object));
7085 /* ---------------------------------------------------------------------------------------------------- */