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: A #GMainContext or %NULL.
253 * @callback: 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 /* Structure used for message filters, protected by @lock */
450 /* Capabilities negotiated during authentication
451 * Read-only after initable_init(), so it may be read without holding a
452 * lock, if you check for initialization first.
454 GDBusCapabilityFlags capabilities;
456 /* Protected by @init_lock */
457 GDBusAuthObserver *authentication_observer;
459 /* Read-only after initable_init(), so it may be read if you either
460 * hold @init_lock or check for initialization first.
462 GCredentials *credentials;
464 /* set to TRUE when finalizing */
468 typedef struct ExportedObject ExportedObject;
469 static void exported_object_free (ExportedObject *eo);
471 typedef struct ExportedSubtree ExportedSubtree;
472 static void exported_subtree_free (ExportedSubtree *es);
490 PROP_CAPABILITY_FLAGS,
491 PROP_AUTHENTICATION_OBSERVER,
494 static void distribute_signals (GDBusConnection *connection,
495 GDBusMessage *message);
497 static void distribute_method_call (GDBusConnection *connection,
498 GDBusMessage *message);
500 static gboolean handle_generic_unlocked (GDBusConnection *connection,
501 GDBusMessage *message);
504 static void purge_all_signal_subscriptions (GDBusConnection *connection);
505 static void purge_all_filters (GDBusConnection *connection);
507 #define _G_ENSURE_LOCK(name) do { \
508 if (G_UNLIKELY (G_TRYLOCK(name))) \
510 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
511 "_G_ENSURE_LOCK: Lock `" #name "' is not locked"); \
515 static guint signals[LAST_SIGNAL] = { 0 };
517 static void initable_iface_init (GInitableIface *initable_iface);
518 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
520 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
521 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
522 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
526 * Check that all members of @connection that can only be accessed after
527 * the connection is initialized can safely be accessed. If not,
528 * log a critical warning. This function is a memory barrier.
530 * Returns: %TRUE if initialized
533 check_initialized (GDBusConnection *connection)
535 /* The access to @atomic_flags isn't conditional, so that this function
536 * provides a memory barrier for thread-safety even if checks are disabled.
537 * (If you don't want this stricter guarantee, you can call
538 * g_return_if_fail (check_initialized (c)).)
540 * This isn't strictly necessary now that we've decided use of an
541 * uninitialized GDBusConnection is undefined behaviour, but it seems
542 * better to be as deterministic as is feasible.
544 * (Anything that could suffer a crash from seeing undefined values
545 * must have a race condition - thread A initializes the connection while
546 * thread B calls a method without initialization, hoping that thread A will
547 * win the race - so its behaviour is undefined anyway.)
549 gint flags = g_atomic_int_get (&connection->atomic_flags);
551 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
553 /* We can safely access this, due to the memory barrier above */
554 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
560 MAY_BE_UNINITIALIZED = (1<<1)
561 } CheckUnclosedFlags;
564 * Check the same thing as check_initialized(), and also that the
565 * connection is not closed. If the connection is uninitialized,
566 * raise a critical warning (it's programmer error); if it's closed,
567 * raise a recoverable GError (it's a runtime error).
569 * This function is a memory barrier.
571 * Returns: %TRUE if initialized and not closed
574 check_unclosed (GDBusConnection *connection,
575 CheckUnclosedFlags check,
578 /* check_initialized() is effectively inlined, so we don't waste time
579 * doing two memory barriers
581 gint flags = g_atomic_int_get (&connection->atomic_flags);
583 if (!(check & MAY_BE_UNINITIALIZED))
585 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
586 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
589 if (flags & FLAG_CLOSED)
591 g_set_error_literal (error,
594 _("The connection is closed"));
601 static GHashTable *alive_connections = NULL;
604 g_dbus_connection_dispose (GObject *object)
606 GDBusConnection *connection = G_DBUS_CONNECTION (object);
608 G_LOCK (message_bus_lock);
609 CONNECTION_LOCK (connection);
610 if (connection->worker != NULL)
612 _g_dbus_worker_stop (connection->worker);
613 connection->worker = NULL;
614 if (alive_connections != NULL)
615 g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
619 if (alive_connections != NULL)
620 g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
622 CONNECTION_UNLOCK (connection);
623 G_UNLOCK (message_bus_lock);
625 if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
626 G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
630 g_dbus_connection_finalize (GObject *object)
632 GDBusConnection *connection = G_DBUS_CONNECTION (object);
634 connection->finalizing = TRUE;
636 purge_all_signal_subscriptions (connection);
638 purge_all_filters (connection);
639 g_ptr_array_unref (connection->filters);
641 if (connection->authentication_observer != NULL)
642 g_object_unref (connection->authentication_observer);
644 if (connection->auth != NULL)
645 g_object_unref (connection->auth);
647 if (connection->credentials)
648 g_object_unref (connection->credentials);
650 if (connection->stream != NULL)
652 g_object_unref (connection->stream);
653 connection->stream = NULL;
656 g_free (connection->address);
658 g_free (connection->guid);
659 g_free (connection->bus_unique_name);
661 if (connection->initialization_error != NULL)
662 g_error_free (connection->initialization_error);
664 g_hash_table_unref (connection->map_method_serial_to_send_message_data);
666 g_hash_table_unref (connection->map_rule_to_signal_data);
667 g_hash_table_unref (connection->map_id_to_signal_data);
668 g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
670 g_hash_table_unref (connection->map_id_to_ei);
671 g_hash_table_unref (connection->map_object_path_to_eo);
672 g_hash_table_unref (connection->map_id_to_es);
673 g_hash_table_unref (connection->map_object_path_to_es);
675 g_main_context_unref (connection->main_context_at_construction);
677 g_free (connection->machine_id);
679 g_mutex_clear (&connection->init_lock);
680 g_mutex_clear (&connection->lock);
682 G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
685 /* called in any user thread, with the connection's lock not held */
687 g_dbus_connection_get_property (GObject *object,
692 GDBusConnection *connection = G_DBUS_CONNECTION (object);
697 g_value_set_object (value, g_dbus_connection_get_stream (connection));
701 g_value_set_string (value, g_dbus_connection_get_guid (connection));
704 case PROP_UNIQUE_NAME:
705 g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
709 g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
712 case PROP_EXIT_ON_CLOSE:
713 g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
716 case PROP_CAPABILITY_FLAGS:
717 g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
721 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
726 /* called in any user thread, with the connection's lock not held */
728 g_dbus_connection_set_property (GObject *object,
733 GDBusConnection *connection = G_DBUS_CONNECTION (object);
738 connection->stream = g_value_dup_object (value);
742 connection->guid = g_value_dup_string (value);
746 connection->address = g_value_dup_string (value);
750 connection->flags = g_value_get_flags (value);
753 case PROP_EXIT_ON_CLOSE:
754 g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
757 case PROP_AUTHENTICATION_OBSERVER:
758 connection->authentication_observer = g_value_dup_object (value);
762 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
767 /* Base-class implementation of GDBusConnection::closed.
769 * Called in a user thread, by the main context that was thread-default when
770 * the object was constructed.
773 g_dbus_connection_real_closed (GDBusConnection *connection,
774 gboolean remote_peer_vanished,
777 gint flags = g_atomic_int_get (&connection->atomic_flags);
779 /* Because atomic int access is a memory barrier, we can safely read
780 * initialization_error without a lock, as long as we do it afterwards.
782 if (remote_peer_vanished &&
783 (flags & FLAG_EXIT_ON_CLOSE) != 0 &&
784 (flags & FLAG_INITIALIZED) != 0 &&
785 connection->initialization_error == NULL)
789 g_print ("%s: Remote peer vanished with error: %s (%s, %d). Exiting.\n",
792 g_quark_to_string (error->domain), error->code);
796 g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
803 g_dbus_connection_class_init (GDBusConnectionClass *klass)
805 GObjectClass *gobject_class;
807 gobject_class = G_OBJECT_CLASS (klass);
809 gobject_class->finalize = g_dbus_connection_finalize;
810 gobject_class->dispose = g_dbus_connection_dispose;
811 gobject_class->set_property = g_dbus_connection_set_property;
812 gobject_class->get_property = g_dbus_connection_get_property;
814 klass->closed = g_dbus_connection_real_closed;
817 * GDBusConnection:stream:
819 * The underlying #GIOStream used for I/O.
821 * If this is passed on construction and is a #GSocketConnection,
822 * then the corresponding #GSocket will be put into non-blocking mode.
824 * While the #GDBusConnection is active, it will interact with this
825 * stream from a worker thread, so it is not safe to interact with
826 * the stream directly.
830 g_object_class_install_property (gobject_class,
832 g_param_spec_object ("stream",
834 P_("The underlying streams used for I/O"),
838 G_PARAM_CONSTRUCT_ONLY |
839 G_PARAM_STATIC_NAME |
840 G_PARAM_STATIC_BLURB |
841 G_PARAM_STATIC_NICK));
844 * GDBusConnection:address:
846 * A D-Bus address specifying potential endpoints that can be used
847 * when establishing the connection.
851 g_object_class_install_property (gobject_class,
853 g_param_spec_string ("address",
855 P_("D-Bus address specifying potential socket endpoints"),
858 G_PARAM_CONSTRUCT_ONLY |
859 G_PARAM_STATIC_NAME |
860 G_PARAM_STATIC_BLURB |
861 G_PARAM_STATIC_NICK));
864 * GDBusConnection:flags:
866 * Flags from the #GDBusConnectionFlags enumeration.
870 g_object_class_install_property (gobject_class,
872 g_param_spec_flags ("flags",
875 G_TYPE_DBUS_CONNECTION_FLAGS,
876 G_DBUS_CONNECTION_FLAGS_NONE,
878 G_PARAM_CONSTRUCT_ONLY |
879 G_PARAM_STATIC_NAME |
880 G_PARAM_STATIC_BLURB |
881 G_PARAM_STATIC_NICK));
884 * GDBusConnection:guid:
886 * The GUID of the peer performing the role of server when
889 * If you are constructing a #GDBusConnection and pass
890 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
891 * #GDBusConnection:flags property then you MUST also set this
892 * property to a valid guid.
894 * If you are constructing a #GDBusConnection and pass
895 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
896 * #GDBusConnection:flags property you will be able to read the GUID
897 * of the other peer here after the connection has been successfully
902 g_object_class_install_property (gobject_class,
904 g_param_spec_string ("guid",
906 P_("GUID of the server peer"),
910 G_PARAM_CONSTRUCT_ONLY |
911 G_PARAM_STATIC_NAME |
912 G_PARAM_STATIC_BLURB |
913 G_PARAM_STATIC_NICK));
916 * GDBusConnection:unique-name:
918 * The unique name as assigned by the message bus or %NULL if the
919 * connection is not open or not a message bus connection.
923 g_object_class_install_property (gobject_class,
925 g_param_spec_string ("unique-name",
927 P_("Unique name of bus connection"),
930 G_PARAM_STATIC_NAME |
931 G_PARAM_STATIC_BLURB |
932 G_PARAM_STATIC_NICK));
935 * GDBusConnection:closed:
937 * A boolean specifying whether the connection has been closed.
941 g_object_class_install_property (gobject_class,
943 g_param_spec_boolean ("closed",
945 P_("Whether the connection is closed"),
948 G_PARAM_STATIC_NAME |
949 G_PARAM_STATIC_BLURB |
950 G_PARAM_STATIC_NICK));
953 * GDBusConnection:exit-on-close:
955 * A boolean specifying whether the process will be terminated (by
956 * calling <literal>raise(SIGTERM)</literal>) if the connection
957 * is closed by the remote peer.
959 * Note that #GDBusConnection objects returned by g_bus_get_finish() and
960 * g_bus_get_sync() will (usually) have this property set to %TRUE.
964 g_object_class_install_property (gobject_class,
966 g_param_spec_boolean ("exit-on-close",
968 P_("Whether the process is terminated when the connection is closed"),
972 G_PARAM_STATIC_NAME |
973 G_PARAM_STATIC_BLURB |
974 G_PARAM_STATIC_NICK));
977 * GDBusConnection:capabilities:
979 * Flags from the #GDBusCapabilityFlags enumeration
980 * representing connection features negotiated with the other peer.
984 g_object_class_install_property (gobject_class,
985 PROP_CAPABILITY_FLAGS,
986 g_param_spec_flags ("capabilities",
989 G_TYPE_DBUS_CAPABILITY_FLAGS,
990 G_DBUS_CAPABILITY_FLAGS_NONE,
992 G_PARAM_STATIC_NAME |
993 G_PARAM_STATIC_BLURB |
994 G_PARAM_STATIC_NICK));
997 * GDBusConnection:authentication-observer:
999 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
1003 g_object_class_install_property (gobject_class,
1004 PROP_AUTHENTICATION_OBSERVER,
1005 g_param_spec_object ("authentication-observer",
1006 P_("Authentication Observer"),
1007 P_("Object used to assist in the authentication process"),
1008 G_TYPE_DBUS_AUTH_OBSERVER,
1010 G_PARAM_CONSTRUCT_ONLY |
1011 G_PARAM_STATIC_NAME |
1012 G_PARAM_STATIC_BLURB |
1013 G_PARAM_STATIC_NICK));
1016 * GDBusConnection::closed:
1017 * @connection: The #GDBusConnection emitting the signal.
1018 * @remote_peer_vanished: %TRUE if @connection is closed because the
1019 * remote peer closed its end of the connection.
1020 * @error: A #GError with more details about the event or %NULL.
1022 * Emitted when the connection is closed.
1024 * The cause of this event can be
1027 * If g_dbus_connection_close() is called. In this case
1028 * @remote_peer_vanished is set to %FALSE and @error is %NULL.
1029 * </para></listitem>
1031 * If the remote peer closes the connection. In this case
1032 * @remote_peer_vanished is set to %TRUE and @error is set.
1033 * </para></listitem>
1035 * If the remote peer sends invalid or malformed data. In this
1036 * case @remote_peer_vanished is set to %FALSE and @error
1038 * </para></listitem>
1041 * Upon receiving this signal, you should give up your reference to
1042 * @connection. You are guaranteed that this signal is emitted only
1047 signals[CLOSED_SIGNAL] = g_signal_new ("closed",
1048 G_TYPE_DBUS_CONNECTION,
1050 G_STRUCT_OFFSET (GDBusConnectionClass, closed),
1061 g_dbus_connection_init (GDBusConnection *connection)
1063 g_mutex_init (&connection->lock);
1064 g_mutex_init (&connection->init_lock);
1066 connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
1068 connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
1070 connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
1072 connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
1075 (GDestroyNotify) g_ptr_array_unref);
1077 connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
1080 (GDestroyNotify) exported_object_free);
1082 connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
1085 connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
1088 (GDestroyNotify) exported_subtree_free);
1090 connection->map_id_to_es = g_hash_table_new (g_direct_hash,
1093 connection->main_context_at_construction = g_main_context_ref_thread_default ();
1095 connection->filters = g_ptr_array_new ();
1099 * g_dbus_connection_get_stream:
1100 * @connection: a #GDBusConnection
1102 * Gets the underlying stream used for IO.
1104 * While the #GDBusConnection is active, it will interact with this
1105 * stream from a worker thread, so it is not safe to interact with
1106 * the stream directly.
1108 * Returns: (transfer none): the stream used for IO
1113 g_dbus_connection_get_stream (GDBusConnection *connection)
1115 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1117 /* do not use g_return_val_if_fail(), we want the memory barrier */
1118 if (!check_initialized (connection))
1121 return connection->stream;
1125 * g_dbus_connection_start_message_processing:
1126 * @connection: A #GDBusConnection.
1128 * If @connection was created with
1129 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
1130 * starts processing messages. Does nothing on if @connection wasn't
1131 * created with this flag or if the method has already been called.
1136 g_dbus_connection_start_message_processing (GDBusConnection *connection)
1138 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1140 /* do not use g_return_val_if_fail(), we want the memory barrier */
1141 if (!check_initialized (connection))
1144 g_assert (connection->worker != NULL);
1145 _g_dbus_worker_unfreeze (connection->worker);
1149 * g_dbus_connection_is_closed:
1150 * @connection: A #GDBusConnection.
1152 * Gets whether @connection is closed.
1154 * Returns: %TRUE if the connection is closed, %FALSE otherwise.
1159 g_dbus_connection_is_closed (GDBusConnection *connection)
1163 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1165 flags = g_atomic_int_get (&connection->atomic_flags);
1167 return (flags & FLAG_CLOSED) ? TRUE : FALSE;
1171 * g_dbus_connection_get_capabilities:
1172 * @connection: A #GDBusConnection.
1174 * Gets the capabilities negotiated with the remote peer
1176 * Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration.
1180 GDBusCapabilityFlags
1181 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1183 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1185 /* do not use g_return_val_if_fail(), we want the memory barrier */
1186 if (!check_initialized (connection))
1187 return G_DBUS_CAPABILITY_FLAGS_NONE;
1189 return connection->capabilities;
1192 /* ---------------------------------------------------------------------------------------------------- */
1194 /* Called in a temporary thread without holding locks. */
1196 flush_in_thread_func (GSimpleAsyncResult *res,
1198 GCancellable *cancellable)
1203 if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
1206 g_simple_async_result_take_error (res, error);
1210 * g_dbus_connection_flush:
1211 * @connection: A #GDBusConnection.
1212 * @cancellable: A #GCancellable or %NULL.
1213 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1214 * satisfied or %NULL if you don't care about the result.
1215 * @user_data: The data to pass to @callback.
1217 * Asynchronously flushes @connection, that is, writes all queued
1218 * outgoing message to the transport and then flushes the transport
1219 * (using g_output_stream_flush_async()). This is useful in programs
1220 * that wants to emit a D-Bus signal and then exit
1221 * immediately. Without flushing the connection, there is no guarantee
1222 * that the message has been sent to the networking buffers in the OS
1225 * This is an asynchronous method. When the operation is finished,
1226 * @callback will be invoked in the <link
1227 * linkend="g-main-context-push-thread-default">thread-default main
1228 * loop</link> of the thread you are calling this method from. You can
1229 * then call g_dbus_connection_flush_finish() to get the result of the
1230 * operation. See g_dbus_connection_flush_sync() for the synchronous
1236 g_dbus_connection_flush (GDBusConnection *connection,
1237 GCancellable *cancellable,
1238 GAsyncReadyCallback callback,
1241 GSimpleAsyncResult *simple;
1243 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1245 simple = g_simple_async_result_new (G_OBJECT (connection),
1248 g_dbus_connection_flush);
1249 g_simple_async_result_set_check_cancellable (simple, cancellable);
1250 g_simple_async_result_run_in_thread (simple,
1251 flush_in_thread_func,
1254 g_object_unref (simple);
1258 * g_dbus_connection_flush_finish:
1259 * @connection: A #GDBusConnection.
1260 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush().
1261 * @error: Return location for error or %NULL.
1263 * Finishes an operation started with g_dbus_connection_flush().
1265 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1270 g_dbus_connection_flush_finish (GDBusConnection *connection,
1274 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1279 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1280 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1281 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1283 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
1285 if (g_simple_async_result_propagate_error (simple, error))
1295 * g_dbus_connection_flush_sync:
1296 * @connection: A #GDBusConnection.
1297 * @cancellable: A #GCancellable or %NULL.
1298 * @error: Return location for error or %NULL.
1300 * Synchronously flushes @connection. The calling thread is blocked
1301 * until this is done. See g_dbus_connection_flush() for the
1302 * asynchronous version of this method and more details about what it
1305 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1310 g_dbus_connection_flush_sync (GDBusConnection *connection,
1311 GCancellable *cancellable,
1316 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1317 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1321 /* This is only a best-effort attempt to see whether the connection is
1322 * closed, so it doesn't need the lock. If the connection closes just
1323 * after this check, but before scheduling the flush operation, the
1324 * result will be more or less the same as if the connection closed while
1325 * the flush operation was pending - it'll fail with either CLOSED or
1328 if (!check_unclosed (connection, 0, error))
1331 g_assert (connection->worker != NULL);
1333 ret = _g_dbus_worker_flush_sync (connection->worker,
1341 /* ---------------------------------------------------------------------------------------------------- */
1345 GDBusConnection *connection;
1347 gboolean remote_peer_vanished;
1351 emit_closed_data_free (EmitClosedData *data)
1353 g_object_unref (data->connection);
1354 if (data->error != NULL)
1355 g_error_free (data->error);
1359 /* Called in a user thread that has acquired the main context that was
1360 * thread-default when the object was constructed
1363 emit_closed_in_idle (gpointer user_data)
1365 EmitClosedData *data = user_data;
1368 g_object_notify (G_OBJECT (data->connection), "closed");
1369 g_signal_emit (data->connection,
1370 signals[CLOSED_SIGNAL],
1372 data->remote_peer_vanished,
1378 /* Can be called from any thread, must hold lock.
1379 * FLAG_CLOSED must already have been set.
1382 schedule_closed_unlocked (GDBusConnection *connection,
1383 gboolean remote_peer_vanished,
1386 GSource *idle_source;
1387 EmitClosedData *data;
1389 CONNECTION_ENSURE_LOCK (connection);
1391 data = g_new0 (EmitClosedData, 1);
1392 data->connection = g_object_ref (connection);
1393 data->remote_peer_vanished = remote_peer_vanished;
1394 data->error = error != NULL ? g_error_copy (error) : NULL;
1396 idle_source = g_idle_source_new ();
1397 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1398 g_source_set_callback (idle_source,
1399 emit_closed_in_idle,
1401 (GDestroyNotify) emit_closed_data_free);
1402 g_source_attach (idle_source, connection->main_context_at_construction);
1403 g_source_unref (idle_source);
1406 /* ---------------------------------------------------------------------------------------------------- */
1409 * g_dbus_connection_close:
1410 * @connection: A #GDBusConnection.
1411 * @cancellable: A #GCancellable or %NULL.
1412 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1413 * satisfied or %NULL if you don't care about the result.
1414 * @user_data: The data to pass to @callback.
1416 * Closes @connection. Note that this never causes the process to
1417 * exit (this might only happen if the other end of a shared message
1418 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1420 * Once the connection is closed, operations such as sending a message
1421 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1422 * will not automatically flush the connection so queued messages may
1423 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1425 * If @connection is already closed, this method fails with
1426 * %G_IO_ERROR_CLOSED.
1428 * When @connection has been closed, the #GDBusConnection::closed
1429 * signal is emitted in the <link
1430 * linkend="g-main-context-push-thread-default">thread-default main
1431 * loop</link> of the thread that @connection was constructed in.
1433 * This is an asynchronous method. When the operation is finished,
1434 * @callback will be invoked in the <link
1435 * linkend="g-main-context-push-thread-default">thread-default main
1436 * loop</link> of the thread you are calling this method from. You can
1437 * then call g_dbus_connection_close_finish() to get the result of the
1438 * operation. See g_dbus_connection_close_sync() for the synchronous
1444 g_dbus_connection_close (GDBusConnection *connection,
1445 GCancellable *cancellable,
1446 GAsyncReadyCallback callback,
1449 GSimpleAsyncResult *simple;
1451 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1453 /* do not use g_return_val_if_fail(), we want the memory barrier */
1454 if (!check_initialized (connection))
1457 g_assert (connection->worker != NULL);
1459 simple = g_simple_async_result_new (G_OBJECT (connection),
1462 g_dbus_connection_close);
1463 g_simple_async_result_set_check_cancellable (simple, cancellable);
1464 _g_dbus_worker_close (connection->worker, cancellable, simple);
1465 g_object_unref (simple);
1469 * g_dbus_connection_close_finish:
1470 * @connection: A #GDBusConnection.
1471 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close().
1472 * @error: Return location for error or %NULL.
1474 * Finishes an operation started with g_dbus_connection_close().
1476 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1481 g_dbus_connection_close_finish (GDBusConnection *connection,
1485 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1490 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1491 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1492 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1494 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
1496 if (g_simple_async_result_propagate_error (simple, error))
1507 GAsyncResult *result;
1510 /* Can be called by any thread, without the connection lock */
1512 sync_close_cb (GObject *source_object,
1516 SyncCloseData *data = user_data;
1518 data->result = g_object_ref (res);
1519 g_main_loop_quit (data->loop);
1523 * g_dbus_connection_close_sync:
1524 * @connection: A #GDBusConnection.
1525 * @cancellable: A #GCancellable or %NULL.
1526 * @error: Return location for error or %NULL.
1528 * Synchronously closees @connection. The calling thread is blocked
1529 * until this is done. See g_dbus_connection_close() for the
1530 * asynchronous version of this method and more details about what it
1533 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1538 g_dbus_connection_close_sync (GDBusConnection *connection,
1539 GCancellable *cancellable,
1544 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1545 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1549 if (check_unclosed (connection, 0, error))
1551 GMainContext *context;
1554 context = g_main_context_new ();
1555 g_main_context_push_thread_default (context);
1556 data.loop = g_main_loop_new (context, TRUE);
1559 g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
1560 g_main_loop_run (data.loop);
1561 ret = g_dbus_connection_close_finish (connection, data.result, error);
1563 g_object_unref (data.result);
1564 g_main_loop_unref (data.loop);
1565 g_main_context_pop_thread_default (context);
1566 g_main_context_unref (context);
1572 /* ---------------------------------------------------------------------------------------------------- */
1574 /* Can be called by any thread, with the connection lock held */
1576 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
1577 GDBusMessage *message,
1578 GDBusSendMessageFlags flags,
1579 volatile guint32 *out_serial,
1584 guint32 serial_to_use;
1587 CONNECTION_ENSURE_LOCK (connection);
1589 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1590 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1592 /* TODO: check all necessary headers are present */
1597 if (out_serial != NULL)
1600 /* If we're in initable_init(), don't check for being initialized, to avoid
1601 * chicken-and-egg problems. initable_init() is responsible for setting up
1602 * our prerequisites (mainly connection->worker), and only calling us
1603 * from its own thread (so no memory barrier is needed).
1605 if (!check_unclosed (connection,
1606 (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
1610 blob = g_dbus_message_to_blob (message,
1612 connection->capabilities,
1617 if (flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL)
1618 serial_to_use = g_dbus_message_get_serial (message);
1620 serial_to_use = ++connection->last_serial; /* TODO: handle overflow */
1625 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
1628 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
1631 g_assert_not_reached ();
1636 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
1637 blob_size, serial_to_use, connection);
1638 g_printerr ("----\n");
1639 hexdump (blob, blob_size);
1640 g_printerr ("----\n");
1643 /* TODO: use connection->auth to encode the blob */
1645 if (out_serial != NULL)
1646 *out_serial = serial_to_use;
1648 if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
1649 g_dbus_message_set_serial (message, serial_to_use);
1651 g_dbus_message_lock (message);
1652 _g_dbus_worker_send_message (connection->worker,
1656 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
1667 * g_dbus_connection_send_message:
1668 * @connection: A #GDBusConnection.
1669 * @message: A #GDBusMessage
1670 * @flags: Flags affecting how the message is sent.
1671 * @out_serial: (out) (allow-none): Return location for serial number assigned
1672 * to @message when sending it or %NULL.
1673 * @error: Return location for error or %NULL.
1675 * Asynchronously sends @message to the peer represented by @connection.
1677 * Unless @flags contain the
1678 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1679 * will be assigned by @connection and set on @message via
1680 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1681 * serial number used will be written to this location prior to
1682 * submitting the message to the underlying transport.
1684 * If @connection is closed then the operation will fail with
1685 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
1686 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1688 * See <xref linkend="gdbus-server"/> and <xref
1689 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1690 * low-level API to send and receive UNIX file descriptors.
1692 * Note that @message must be unlocked, unless @flags contain the
1693 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1695 * Returns: %TRUE if the message was well-formed and queued for
1696 * transmission, %FALSE if @error is set.
1701 g_dbus_connection_send_message (GDBusConnection *connection,
1702 GDBusMessage *message,
1703 GDBusSendMessageFlags flags,
1704 volatile guint32 *out_serial,
1709 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1710 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1711 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
1712 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1714 CONNECTION_LOCK (connection);
1715 ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
1716 CONNECTION_UNLOCK (connection);
1720 /* ---------------------------------------------------------------------------------------------------- */
1724 volatile gint ref_count;
1725 GDBusConnection *connection;
1727 GSimpleAsyncResult *simple;
1729 GMainContext *main_context;
1731 GCancellable *cancellable;
1733 gulong cancellable_handler_id;
1735 GSource *timeout_source;
1740 /* Can be called from any thread with or without lock held */
1741 static SendMessageData *
1742 send_message_data_ref (SendMessageData *data)
1744 g_atomic_int_inc (&data->ref_count);
1748 /* Can be called from any thread with or without lock held */
1750 send_message_data_unref (SendMessageData *data)
1752 if (g_atomic_int_dec_and_test (&data->ref_count))
1754 g_assert (data->timeout_source == NULL);
1755 g_assert (data->simple == NULL);
1756 g_assert (data->cancellable_handler_id == 0);
1757 g_object_unref (data->connection);
1758 if (data->cancellable != NULL)
1759 g_object_unref (data->cancellable);
1760 g_main_context_unref (data->main_context);
1765 /* ---------------------------------------------------------------------------------------------------- */
1767 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
1769 send_message_with_reply_deliver (SendMessageData *data, gboolean remove)
1771 CONNECTION_ENSURE_LOCK (data->connection);
1773 g_assert (!data->delivered);
1775 data->delivered = TRUE;
1777 g_simple_async_result_complete_in_idle (data->simple);
1778 g_object_unref (data->simple);
1779 data->simple = NULL;
1781 if (data->timeout_source != NULL)
1783 g_source_destroy (data->timeout_source);
1784 data->timeout_source = NULL;
1786 if (data->cancellable_handler_id > 0)
1788 g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
1789 data->cancellable_handler_id = 0;
1794 g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
1795 GUINT_TO_POINTER (data->serial)));
1798 send_message_data_unref (data);
1801 /* ---------------------------------------------------------------------------------------------------- */
1803 /* Can be called from any thread with lock held */
1805 send_message_data_deliver_reply_unlocked (SendMessageData *data,
1806 GDBusMessage *reply)
1808 if (data->delivered)
1811 g_simple_async_result_set_op_res_gpointer (data->simple,
1812 g_object_ref (reply),
1815 send_message_with_reply_deliver (data, TRUE);
1821 /* ---------------------------------------------------------------------------------------------------- */
1823 /* Called from a user thread, lock is not held */
1825 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
1827 SendMessageData *data = user_data;
1829 CONNECTION_LOCK (data->connection);
1830 if (data->delivered)
1833 g_simple_async_result_set_error (data->simple,
1835 G_IO_ERROR_CANCELLED,
1836 _("Operation was cancelled"));
1838 send_message_with_reply_deliver (data, TRUE);
1841 CONNECTION_UNLOCK (data->connection);
1845 /* Can be called from any thread with or without lock held */
1847 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
1850 SendMessageData *data = user_data;
1851 GSource *idle_source;
1853 /* postpone cancellation to idle handler since we may be called directly
1854 * via g_cancellable_connect() (e.g. holding lock)
1856 idle_source = g_idle_source_new ();
1857 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1858 g_source_set_callback (idle_source,
1859 send_message_with_reply_cancelled_idle_cb,
1860 send_message_data_ref (data),
1861 (GDestroyNotify) send_message_data_unref);
1862 g_source_attach (idle_source, data->main_context);
1863 g_source_unref (idle_source);
1866 /* ---------------------------------------------------------------------------------------------------- */
1868 /* Called from a user thread, lock is not held */
1870 send_message_with_reply_timeout_cb (gpointer user_data)
1872 SendMessageData *data = user_data;
1874 CONNECTION_LOCK (data->connection);
1875 if (data->delivered)
1878 g_simple_async_result_set_error (data->simple,
1880 G_IO_ERROR_TIMED_OUT,
1881 _("Timeout was reached"));
1883 send_message_with_reply_deliver (data, TRUE);
1886 CONNECTION_UNLOCK (data->connection);
1891 /* ---------------------------------------------------------------------------------------------------- */
1893 /* Called from a user thread, connection's lock is held */
1895 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
1896 GDBusMessage *message,
1897 GDBusSendMessageFlags flags,
1899 volatile guint32 *out_serial,
1900 GCancellable *cancellable,
1901 GAsyncReadyCallback callback,
1904 GSimpleAsyncResult *simple;
1905 SendMessageData *data;
1907 volatile guint32 serial;
1911 if (out_serial == NULL)
1912 out_serial = &serial;
1914 if (timeout_msec == -1)
1915 timeout_msec = 25 * 1000;
1917 simple = g_simple_async_result_new (G_OBJECT (connection),
1920 g_dbus_connection_send_message_with_reply);
1921 g_simple_async_result_set_check_cancellable (simple, cancellable);
1923 if (g_cancellable_is_cancelled (cancellable))
1925 g_simple_async_result_set_error (simple,
1927 G_IO_ERROR_CANCELLED,
1928 _("Operation was cancelled"));
1929 g_simple_async_result_complete_in_idle (simple);
1930 g_object_unref (simple);
1935 if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
1937 g_simple_async_result_take_error (simple, error);
1938 g_simple_async_result_complete_in_idle (simple);
1939 g_object_unref (simple);
1943 data = g_new0 (SendMessageData, 1);
1944 data->ref_count = 1;
1945 data->connection = g_object_ref (connection);
1946 data->simple = simple;
1947 data->serial = *out_serial;
1948 data->main_context = g_main_context_ref_thread_default ();
1950 if (cancellable != NULL)
1952 data->cancellable = g_object_ref (cancellable);
1953 data->cancellable_handler_id = g_cancellable_connect (cancellable,
1954 G_CALLBACK (send_message_with_reply_cancelled_cb),
1955 send_message_data_ref (data),
1956 (GDestroyNotify) send_message_data_unref);
1957 g_object_set_data_full (G_OBJECT (simple),
1959 g_object_ref (cancellable),
1960 (GDestroyNotify) g_object_unref);
1963 if (timeout_msec != G_MAXINT)
1965 data->timeout_source = g_timeout_source_new (timeout_msec);
1966 g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
1967 g_source_set_callback (data->timeout_source,
1968 send_message_with_reply_timeout_cb,
1969 send_message_data_ref (data),
1970 (GDestroyNotify) send_message_data_unref);
1971 g_source_attach (data->timeout_source, data->main_context);
1972 g_source_unref (data->timeout_source);
1975 g_hash_table_insert (connection->map_method_serial_to_send_message_data,
1976 GUINT_TO_POINTER (*out_serial),
1984 * g_dbus_connection_send_message_with_reply:
1985 * @connection: A #GDBusConnection.
1986 * @message: A #GDBusMessage.
1987 * @flags: Flags affecting how the message is sent.
1988 * @timeout_msec: The timeout in milliseconds, -1 to use the default
1989 * timeout or %G_MAXINT for no timeout.
1990 * @out_serial: (out) (allow-none): Return location for serial number assigned
1991 * to @message when sending it or %NULL.
1992 * @cancellable: A #GCancellable or %NULL.
1993 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1994 * satisfied or %NULL if you don't care about the result.
1995 * @user_data: The data to pass to @callback.
1997 * Asynchronously sends @message to the peer represented by @connection.
1999 * Unless @flags contain the
2000 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2001 * will be assigned by @connection and set on @message via
2002 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2003 * serial number used will be written to this location prior to
2004 * submitting the message to the underlying transport.
2006 * If @connection is closed then the operation will fail with
2007 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2008 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2009 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2011 * This is an asynchronous method. When the operation is finished, @callback will be invoked
2012 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
2013 * of the thread you are calling this method from. You can then call
2014 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
2015 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
2017 * Note that @message must be unlocked, unless @flags contain the
2018 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2020 * See <xref linkend="gdbus-server"/> and <xref
2021 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2022 * low-level API to send and receive UNIX file descriptors.
2027 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
2028 GDBusMessage *message,
2029 GDBusSendMessageFlags flags,
2031 volatile guint32 *out_serial,
2032 GCancellable *cancellable,
2033 GAsyncReadyCallback callback,
2036 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2037 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2038 g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
2039 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
2041 CONNECTION_LOCK (connection);
2042 g_dbus_connection_send_message_with_reply_unlocked (connection,
2050 CONNECTION_UNLOCK (connection);
2054 * g_dbus_connection_send_message_with_reply_finish:
2055 * @connection: a #GDBusConnection
2056 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
2057 * @error: Return location for error or %NULL.
2059 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
2061 * Note that @error is only set if a local in-process error
2062 * occurred. That is to say that the returned #GDBusMessage object may
2063 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2064 * g_dbus_message_to_gerror() to transcode this to a #GError.
2066 * See <xref linkend="gdbus-server"/> and <xref
2067 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2068 * low-level API to send and receive UNIX file descriptors.
2070 * Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set.
2075 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
2079 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2080 GDBusMessage *reply;
2081 GCancellable *cancellable;
2083 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2084 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2088 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
2090 if (g_simple_async_result_propagate_error (simple, error))
2093 reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
2094 cancellable = g_object_get_data (G_OBJECT (simple), "cancellable");
2095 if (cancellable != NULL && g_cancellable_is_cancelled (cancellable))
2097 g_object_unref (reply);
2099 g_set_error_literal (error,
2101 G_IO_ERROR_CANCELLED,
2102 _("Operation was cancelled"));
2108 /* ---------------------------------------------------------------------------------------------------- */
2113 GMainContext *context;
2115 } SendMessageSyncData;
2117 /* Called from a user thread, lock is not held */
2119 send_message_with_reply_sync_cb (GDBusConnection *connection,
2123 SendMessageSyncData *data = user_data;
2124 data->res = g_object_ref (res);
2125 g_main_loop_quit (data->loop);
2129 * g_dbus_connection_send_message_with_reply_sync:
2130 * @connection: A #GDBusConnection.
2131 * @message: A #GDBusMessage.
2132 * @flags: Flags affecting how the message is sent.
2133 * @timeout_msec: The timeout in milliseconds, -1 to use the default
2134 * timeout or %G_MAXINT for no timeout.
2135 * @out_serial: (out) (allow-none): Return location for serial number assigned
2136 * to @message when sending it or %NULL.
2137 * @cancellable: A #GCancellable or %NULL.
2138 * @error: Return location for error or %NULL.
2140 * Synchronously sends @message to the peer represented by @connection
2141 * and blocks the calling thread until a reply is received or the
2142 * timeout is reached. See g_dbus_connection_send_message_with_reply()
2143 * for the asynchronous version of this method.
2145 * Unless @flags contain the
2146 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2147 * will be assigned by @connection and set on @message via
2148 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2149 * serial number used will be written to this location prior to
2150 * submitting the message to the underlying transport.
2152 * If @connection is closed then the operation will fail with
2153 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2154 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2155 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2157 * Note that @error is only set if a local in-process error
2158 * occurred. That is to say that the returned #GDBusMessage object may
2159 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2160 * g_dbus_message_to_gerror() to transcode this to a #GError.
2162 * See <xref linkend="gdbus-server"/> and <xref
2163 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2164 * low-level API to send and receive UNIX file descriptors.
2166 * Note that @message must be unlocked, unless @flags contain the
2167 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2169 * Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.
2174 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
2175 GDBusMessage *message,
2176 GDBusSendMessageFlags flags,
2178 volatile guint32 *out_serial,
2179 GCancellable *cancellable,
2182 SendMessageSyncData *data;
2183 GDBusMessage *reply;
2185 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2186 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2187 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
2188 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2189 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2191 data = g_new0 (SendMessageSyncData, 1);
2192 data->context = g_main_context_new ();
2193 data->loop = g_main_loop_new (data->context, FALSE);
2195 g_main_context_push_thread_default (data->context);
2197 g_dbus_connection_send_message_with_reply (connection,
2203 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2205 g_main_loop_run (data->loop);
2206 reply = g_dbus_connection_send_message_with_reply_finish (connection,
2210 g_main_context_pop_thread_default (data->context);
2212 g_main_context_unref (data->context);
2213 g_main_loop_unref (data->loop);
2214 g_object_unref (data->res);
2220 /* ---------------------------------------------------------------------------------------------------- */
2224 GDBusMessageFilterFunction func;
2231 GDBusMessageFilterFunction filter_function;
2233 GDestroyNotify user_data_free_func;
2236 /* Called in GDBusWorker's thread - we must not block - with no lock held */
2238 on_worker_message_received (GDBusWorker *worker,
2239 GDBusMessage *message,
2242 GDBusConnection *connection;
2243 FilterCallback *filters;
2248 G_LOCK (message_bus_lock);
2249 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2252 G_UNLOCK (message_bus_lock);
2255 connection = G_DBUS_CONNECTION (user_data);
2256 g_object_ref (connection);
2257 G_UNLOCK (message_bus_lock);
2259 //g_debug ("in on_worker_message_received");
2261 g_object_ref (message);
2262 g_dbus_message_lock (message);
2264 //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2266 /* First collect the set of callback functions */
2267 CONNECTION_LOCK (connection);
2268 num_filters = connection->filters->len;
2269 filters = g_new0 (FilterCallback, num_filters);
2270 for (n = 0; n < num_filters; n++)
2272 FilterData *data = connection->filters->pdata[n];
2273 filters[n].func = data->filter_function;
2274 filters[n].user_data = data->user_data;
2276 CONNECTION_UNLOCK (connection);
2278 /* then call the filters in order (without holding the lock) */
2279 for (n = 0; n < num_filters; n++)
2281 message = filters[n].func (connection,
2284 filters[n].user_data);
2285 if (message == NULL)
2287 g_dbus_message_lock (message);
2290 /* Standard dispatch unless the filter ate the message - no need to
2291 * do anything if the message was altered
2293 if (message != NULL)
2295 GDBusMessageType message_type;
2297 message_type = g_dbus_message_get_message_type (message);
2298 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2300 guint32 reply_serial;
2301 SendMessageData *send_message_data;
2303 reply_serial = g_dbus_message_get_reply_serial (message);
2304 CONNECTION_LOCK (connection);
2305 send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
2306 GUINT_TO_POINTER (reply_serial));
2307 if (send_message_data != NULL)
2309 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2310 send_message_data_deliver_reply_unlocked (send_message_data, message);
2314 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2316 CONNECTION_UNLOCK (connection);
2318 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2320 CONNECTION_LOCK (connection);
2321 distribute_signals (connection, message);
2322 CONNECTION_UNLOCK (connection);
2324 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2326 CONNECTION_LOCK (connection);
2327 distribute_method_call (connection, message);
2328 CONNECTION_UNLOCK (connection);
2332 if (message != NULL)
2333 g_object_unref (message);
2334 g_object_unref (connection);
2338 /* Called in GDBusWorker's thread, lock is not held */
2339 static GDBusMessage *
2340 on_worker_message_about_to_be_sent (GDBusWorker *worker,
2341 GDBusMessage *message,
2344 GDBusConnection *connection;
2345 FilterCallback *filters;
2350 G_LOCK (message_bus_lock);
2351 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2354 G_UNLOCK (message_bus_lock);
2357 connection = G_DBUS_CONNECTION (user_data);
2358 g_object_ref (connection);
2359 G_UNLOCK (message_bus_lock);
2361 //g_debug ("in on_worker_message_about_to_be_sent");
2363 /* First collect the set of callback functions */
2364 CONNECTION_LOCK (connection);
2365 num_filters = connection->filters->len;
2366 filters = g_new0 (FilterCallback, num_filters);
2367 for (n = 0; n < num_filters; n++)
2369 FilterData *data = connection->filters->pdata[n];
2370 filters[n].func = data->filter_function;
2371 filters[n].user_data = data->user_data;
2373 CONNECTION_UNLOCK (connection);
2375 /* then call the filters in order (without holding the lock) */
2376 for (n = 0; n < num_filters; n++)
2378 g_dbus_message_lock (message);
2379 message = filters[n].func (connection,
2382 filters[n].user_data);
2383 if (message == NULL)
2387 g_object_unref (connection);
2393 /* called with connection lock held, in GDBusWorker thread */
2395 cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
2397 SendMessageData *data = value;
2399 if (data->delivered)
2402 g_simple_async_result_set_error (data->simple,
2405 _("The connection is closed"));
2407 /* Ask send_message_with_reply_deliver not to remove the element from the
2408 * hash table - we're in the middle of a foreach; that would be unsafe.
2409 * Instead, return TRUE from this function so that it gets removed safely.
2411 send_message_with_reply_deliver (data, FALSE);
2415 /* Called in GDBusWorker's thread - we must not block - without lock held */
2417 on_worker_closed (GDBusWorker *worker,
2418 gboolean remote_peer_vanished,
2422 GDBusConnection *connection;
2424 guint old_atomic_flags;
2426 G_LOCK (message_bus_lock);
2427 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2430 G_UNLOCK (message_bus_lock);
2433 connection = G_DBUS_CONNECTION (user_data);
2434 g_object_ref (connection);
2435 G_UNLOCK (message_bus_lock);
2437 //g_debug ("in on_worker_closed: %s", error->message);
2439 CONNECTION_LOCK (connection);
2440 /* Even though this is atomic, we do it inside the lock to avoid breaking
2441 * assumptions in remove_match_rule(). We'd need the lock in a moment
2442 * anyway, so, no loss.
2444 old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
2446 if (!(old_atomic_flags & FLAG_CLOSED))
2448 g_hash_table_foreach_remove (connection->map_method_serial_to_send_message_data, cancel_method_on_close, NULL);
2449 schedule_closed_unlocked (connection, remote_peer_vanished, error);
2451 CONNECTION_UNLOCK (connection);
2453 g_object_unref (connection);
2456 /* ---------------------------------------------------------------------------------------------------- */
2458 /* Determines the biggest set of capabilities we can support on this
2461 * Called with the init_lock held.
2463 static GDBusCapabilityFlags
2464 get_offered_capabilities_max (GDBusConnection *connection)
2466 GDBusCapabilityFlags ret;
2467 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
2469 if (G_IS_UNIX_CONNECTION (connection->stream))
2470 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
2475 /* Called in a user thread, lock is not held */
2477 initable_init (GInitable *initable,
2478 GCancellable *cancellable,
2481 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
2484 /* This method needs to be idempotent to work with the singleton
2485 * pattern. See the docs for g_initable_init(). We implement this by
2488 * Unfortunately we can't use the main lock since the on_worker_*()
2489 * callbacks above needs the lock during initialization (for message
2490 * bus connections we do a synchronous Hello() call on the bus).
2492 g_mutex_lock (&connection->init_lock);
2496 /* Make this a no-op if we're already initialized (successfully or
2499 if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
2501 ret = (connection->initialization_error == NULL);
2505 /* Because of init_lock, we can't get here twice in different threads */
2506 g_assert (connection->initialization_error == NULL);
2508 /* The user can pass multiple (but mutally exclusive) construct
2511 * - stream (of type GIOStream)
2512 * - address (of type gchar*)
2514 * At the end of the day we end up with a non-NULL GIOStream
2515 * object in connection->stream.
2517 if (connection->address != NULL)
2519 g_assert (connection->stream == NULL);
2521 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
2522 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
2524 g_set_error_literal (&connection->initialization_error,
2526 G_IO_ERROR_INVALID_ARGUMENT,
2527 _("Unsupported flags encountered when constructing a client-side connection"));
2531 connection->stream = g_dbus_address_get_stream_sync (connection->address,
2532 NULL, /* TODO: out_guid */
2534 &connection->initialization_error);
2535 if (connection->stream == NULL)
2538 else if (connection->stream != NULL)
2544 g_assert_not_reached ();
2547 /* Authenticate the connection */
2548 if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
2550 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
2551 g_assert (connection->guid != NULL);
2552 connection->auth = _g_dbus_auth_new (connection->stream);
2553 if (!_g_dbus_auth_run_server (connection->auth,
2554 connection->authentication_observer,
2556 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
2557 get_offered_capabilities_max (connection),
2558 &connection->capabilities,
2559 &connection->credentials,
2561 &connection->initialization_error))
2564 else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
2566 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
2567 g_assert (connection->guid == NULL);
2568 connection->auth = _g_dbus_auth_new (connection->stream);
2569 connection->guid = _g_dbus_auth_run_client (connection->auth,
2570 get_offered_capabilities_max (connection),
2571 &connection->capabilities,
2573 &connection->initialization_error);
2574 if (connection->guid == NULL)
2578 if (connection->authentication_observer != NULL)
2580 g_object_unref (connection->authentication_observer);
2581 connection->authentication_observer = NULL;
2584 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
2586 //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
2589 /* We want all IO operations to be non-blocking since they happen in
2590 * the worker thread which is shared by _all_ connections.
2592 if (G_IS_SOCKET_CONNECTION (connection->stream))
2594 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
2598 G_LOCK (message_bus_lock);
2599 if (alive_connections == NULL)
2600 alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
2601 g_hash_table_insert (alive_connections, connection, connection);
2602 G_UNLOCK (message_bus_lock);
2604 connection->worker = _g_dbus_worker_new (connection->stream,
2605 connection->capabilities,
2606 ((connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0),
2607 on_worker_message_received,
2608 on_worker_message_about_to_be_sent,
2612 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
2613 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2615 GVariant *hello_result;
2617 /* we could lift this restriction by adding code in gdbusprivate.c */
2618 if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
2620 g_set_error_literal (&connection->initialization_error,
2623 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
2627 hello_result = g_dbus_connection_call_sync (connection,
2628 "org.freedesktop.DBus", /* name */
2629 "/org/freedesktop/DBus", /* path */
2630 "org.freedesktop.DBus", /* interface */
2632 NULL, /* parameters */
2633 G_VARIANT_TYPE ("(s)"),
2634 CALL_FLAGS_INITIALIZING,
2636 NULL, /* TODO: cancellable */
2637 &connection->initialization_error);
2638 if (hello_result == NULL)
2641 g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
2642 g_variant_unref (hello_result);
2643 //g_debug ("unique name is `%s'", connection->bus_unique_name);
2650 g_assert (connection->initialization_error != NULL);
2651 g_propagate_error (error, g_error_copy (connection->initialization_error));
2654 g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
2655 g_mutex_unlock (&connection->init_lock);
2661 initable_iface_init (GInitableIface *initable_iface)
2663 initable_iface->init = initable_init;
2666 /* ---------------------------------------------------------------------------------------------------- */
2669 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
2674 /* ---------------------------------------------------------------------------------------------------- */
2677 * g_dbus_connection_new:
2678 * @stream: A #GIOStream.
2679 * @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL.
2680 * @flags: Flags describing how to make the connection.
2681 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2682 * @cancellable: A #GCancellable or %NULL.
2683 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2684 * @user_data: The data to pass to @callback.
2686 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
2687 * with the end represented by @stream.
2689 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2690 * will be put into non-blocking mode.
2692 * The D-Bus connection will interact with @stream from a worker thread.
2693 * As a result, the caller should not interact with @stream after this
2694 * method has been called, except by calling g_object_unref() on it.
2696 * If @observer is not %NULL it may be used to control the
2697 * authentication process.
2699 * When the operation is finished, @callback will be invoked. You can
2700 * then call g_dbus_connection_new_finish() to get the result of the
2703 * This is a asynchronous failable constructor. See
2704 * g_dbus_connection_new_sync() for the synchronous
2710 g_dbus_connection_new (GIOStream *stream,
2712 GDBusConnectionFlags flags,
2713 GDBusAuthObserver *observer,
2714 GCancellable *cancellable,
2715 GAsyncReadyCallback callback,
2718 g_return_if_fail (G_IS_IO_STREAM (stream));
2719 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2727 "authentication-observer", observer,
2732 * g_dbus_connection_new_finish:
2733 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2734 * @error: Return location for error or %NULL.
2736 * Finishes an operation started with g_dbus_connection_new().
2738 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2743 g_dbus_connection_new_finish (GAsyncResult *res,
2747 GObject *source_object;
2749 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2750 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2752 source_object = g_async_result_get_source_object (res);
2753 g_assert (source_object != NULL);
2754 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2757 g_object_unref (source_object);
2759 return G_DBUS_CONNECTION (object);
2765 * g_dbus_connection_new_sync:
2766 * @stream: A #GIOStream.
2767 * @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL.
2768 * @flags: Flags describing how to make the connection.
2769 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2770 * @cancellable: A #GCancellable or %NULL.
2771 * @error: Return location for error or %NULL.
2773 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2774 * with the end represented by @stream.
2776 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2777 * will be put into non-blocking mode.
2779 * The D-Bus connection will interact with @stream from a worker thread.
2780 * As a result, the caller should not interact with @stream after this
2781 * method has been called, except by calling g_object_unref() on it.
2783 * If @observer is not %NULL it may be used to control the
2784 * authentication process.
2786 * This is a synchronous failable constructor. See
2787 * g_dbus_connection_new() for the asynchronous version.
2789 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2794 g_dbus_connection_new_sync (GIOStream *stream,
2796 GDBusConnectionFlags flags,
2797 GDBusAuthObserver *observer,
2798 GCancellable *cancellable,
2801 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2802 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2803 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2809 "authentication-observer", observer,
2813 /* ---------------------------------------------------------------------------------------------------- */
2816 * g_dbus_connection_new_for_address:
2817 * @address: A D-Bus address.
2818 * @flags: Flags describing how to make the connection.
2819 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2820 * @cancellable: A #GCancellable or %NULL.
2821 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2822 * @user_data: The data to pass to @callback.
2824 * Asynchronously connects and sets up a D-Bus client connection for
2825 * exchanging D-Bus messages with an endpoint specified by @address
2826 * which must be in the D-Bus address format.
2828 * This constructor can only be used to initiate client-side
2829 * connections - use g_dbus_connection_new() if you need to act as the
2830 * server. In particular, @flags cannot contain the
2831 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2832 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2834 * When the operation is finished, @callback will be invoked. You can
2835 * then call g_dbus_connection_new_finish() to get the result of the
2838 * If @observer is not %NULL it may be used to control the
2839 * authentication process.
2841 * This is a asynchronous failable constructor. See
2842 * g_dbus_connection_new_for_address_sync() for the synchronous
2848 g_dbus_connection_new_for_address (const gchar *address,
2849 GDBusConnectionFlags flags,
2850 GDBusAuthObserver *observer,
2851 GCancellable *cancellable,
2852 GAsyncReadyCallback callback,
2855 g_return_if_fail (address != NULL);
2856 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2863 "authentication-observer", observer,
2868 * g_dbus_connection_new_for_address_finish:
2869 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2870 * @error: Return location for error or %NULL.
2872 * Finishes an operation started with g_dbus_connection_new_for_address().
2874 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2879 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
2883 GObject *source_object;
2885 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2886 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2888 source_object = g_async_result_get_source_object (res);
2889 g_assert (source_object != NULL);
2890 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2893 g_object_unref (source_object);
2895 return G_DBUS_CONNECTION (object);
2901 * g_dbus_connection_new_for_address_sync:
2902 * @address: A D-Bus address.
2903 * @flags: Flags describing how to make the connection.
2904 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2905 * @cancellable: A #GCancellable or %NULL.
2906 * @error: Return location for error or %NULL.
2908 * Synchronously connects and sets up a D-Bus client connection for
2909 * exchanging D-Bus messages with an endpoint specified by @address
2910 * which must be in the D-Bus address format.
2912 * This constructor can only be used to initiate client-side
2913 * connections - use g_dbus_connection_new_sync() if you need to act
2914 * as the server. In particular, @flags cannot contain the
2915 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2916 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2918 * This is a synchronous failable constructor. See
2919 * g_dbus_connection_new_for_address() for the asynchronous version.
2921 * If @observer is not %NULL it may be used to control the
2922 * authentication process.
2924 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2929 g_dbus_connection_new_for_address_sync (const gchar *address,
2930 GDBusConnectionFlags flags,
2931 GDBusAuthObserver *observer,
2932 GCancellable *cancellable,
2935 g_return_val_if_fail (address != NULL, NULL);
2936 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2937 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2942 "authentication-observer", observer,
2946 /* ---------------------------------------------------------------------------------------------------- */
2949 * g_dbus_connection_set_exit_on_close:
2950 * @connection: A #GDBusConnection.
2951 * @exit_on_close: Whether the process should be terminated
2952 * when @connection is closed by the remote peer.
2954 * Sets whether the process should be terminated when @connection is
2955 * closed by the remote peer. See #GDBusConnection:exit-on-close for
2958 * Note that this function should be used with care. Most modern UNIX
2959 * desktops tie the notion of a user session the session bus, and expect
2960 * all of a users applications to quit when their bus connection goes away.
2961 * If you are setting @exit_on_close to %FALSE for the shared session
2962 * bus connection, you should make sure that your application exits
2963 * when the user session ends.
2968 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
2969 gboolean exit_on_close)
2971 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2974 g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
2976 g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
2981 * g_dbus_connection_get_exit_on_close:
2982 * @connection: A #GDBusConnection.
2984 * Gets whether the process is terminated when @connection is
2985 * closed by the remote peer. See
2986 * #GDBusConnection:exit-on-close for more details.
2988 * Returns: Whether the process is terminated when @connection is
2989 * closed by the remote peer.
2994 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
2996 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2998 if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
3005 * g_dbus_connection_get_guid:
3006 * @connection: A #GDBusConnection.
3008 * The GUID of the peer performing the role of server when
3009 * authenticating. See #GDBusConnection:guid for more details.
3011 * Returns: The GUID. Do not free this string, it is owned by
3017 g_dbus_connection_get_guid (GDBusConnection *connection)
3019 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3020 return connection->guid;
3024 * g_dbus_connection_get_unique_name:
3025 * @connection: A #GDBusConnection.
3027 * Gets the unique name of @connection as assigned by the message
3028 * bus. This can also be used to figure out if @connection is a
3029 * message bus connection.
3031 * Returns: The unique name or %NULL if @connection is not a message
3032 * bus connection. Do not free this string, it is owned by
3038 g_dbus_connection_get_unique_name (GDBusConnection *connection)
3040 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3042 /* do not use g_return_val_if_fail(), we want the memory barrier */
3043 if (!check_initialized (connection))
3046 return connection->bus_unique_name;
3050 * g_dbus_connection_get_peer_credentials:
3051 * @connection: A #GDBusConnection.
3053 * Gets the credentials of the authenticated peer. This will always
3054 * return %NULL unless @connection acted as a server
3055 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
3056 * when set up and the client passed credentials as part of the
3057 * authentication process.
3059 * In a message bus setup, the message bus is always the server and
3060 * each application is a client. So this method will always return
3061 * %NULL for message bus clients.
3063 * Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free
3064 * this object, it is owned by @connection.
3069 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
3071 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3073 /* do not use g_return_val_if_fail(), we want the memory barrier */
3074 if (!check_initialized (connection))
3077 return connection->credentials;
3080 /* ---------------------------------------------------------------------------------------------------- */
3082 static guint _global_filter_id = 1;
3085 * g_dbus_connection_add_filter:
3086 * @connection: A #GDBusConnection.
3087 * @filter_function: A filter function.
3088 * @user_data: User data to pass to @filter_function.
3089 * @user_data_free_func: Function to free @user_data with when filter
3090 * is removed or %NULL.
3092 * Adds a message filter. Filters are handlers that are run on all
3093 * incoming and outgoing messages, prior to standard dispatch. Filters
3094 * are run in the order that they were added. The same handler can be
3095 * added as a filter more than once, in which case it will be run more
3096 * than once. Filters added during a filter callback won't be run on
3097 * the message being processed. Filter functions are allowed to modify
3098 * and even drop messages.
3100 * Note that filters are run in a dedicated message handling thread so
3101 * they can't block and, generally, can't do anything but signal a
3102 * worker thread. Also note that filters are rarely needed - use API
3103 * such as g_dbus_connection_send_message_with_reply(),
3104 * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
3106 * If a filter consumes an incoming message the message is not
3107 * dispatched anywhere else - not even the standard dispatch machinery
3108 * (that API such as g_dbus_connection_signal_subscribe() and
3109 * g_dbus_connection_send_message_with_reply() relies on) will see the
3110 * message. Similary, if a filter consumes an outgoing message, the
3111 * message will not be sent to the other peer.
3113 * Returns: A filter identifier that can be used with
3114 * g_dbus_connection_remove_filter().
3119 g_dbus_connection_add_filter (GDBusConnection *connection,
3120 GDBusMessageFilterFunction filter_function,
3122 GDestroyNotify user_data_free_func)
3126 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3127 g_return_val_if_fail (filter_function != NULL, 0);
3128 g_return_val_if_fail (check_initialized (connection), 0);
3130 CONNECTION_LOCK (connection);
3131 data = g_new0 (FilterData, 1);
3132 data->id = _global_filter_id++; /* TODO: overflow etc. */
3133 data->filter_function = filter_function;
3134 data->user_data = user_data;
3135 data->user_data_free_func = user_data_free_func;
3136 g_ptr_array_add (connection->filters, data);
3137 CONNECTION_UNLOCK (connection);
3142 /* only called from finalize(), removes all filters */
3144 purge_all_filters (GDBusConnection *connection)
3147 for (n = 0; n < connection->filters->len; n++)
3149 FilterData *data = connection->filters->pdata[n];
3150 if (data->user_data_free_func != NULL)
3151 data->user_data_free_func (data->user_data);
3157 * g_dbus_connection_remove_filter:
3158 * @connection: a #GDBusConnection
3159 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
3166 g_dbus_connection_remove_filter (GDBusConnection *connection,
3170 FilterData *to_destroy;
3172 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3173 g_return_if_fail (check_initialized (connection));
3175 CONNECTION_LOCK (connection);
3177 for (n = 0; n < connection->filters->len; n++)
3179 FilterData *data = connection->filters->pdata[n];
3180 if (data->id == filter_id)
3182 g_ptr_array_remove_index (connection->filters, n);
3187 CONNECTION_UNLOCK (connection);
3189 /* do free without holding lock */
3190 if (to_destroy != NULL)
3192 if (to_destroy->user_data_free_func != NULL)
3193 to_destroy->user_data_free_func (to_destroy->user_data);
3194 g_free (to_destroy);
3198 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
3202 /* ---------------------------------------------------------------------------------------------------- */
3208 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
3209 gchar *interface_name;
3213 GArray *subscribers;
3218 GDBusSignalCallback callback;
3220 GDestroyNotify user_data_free_func;
3222 GMainContext *context;
3226 signal_data_free (SignalData *signal_data)
3228 g_free (signal_data->rule);
3229 g_free (signal_data->sender);
3230 g_free (signal_data->sender_unique_name);
3231 g_free (signal_data->interface_name);
3232 g_free (signal_data->member);
3233 g_free (signal_data->object_path);
3234 g_free (signal_data->arg0);
3235 g_array_free (signal_data->subscribers, TRUE);
3236 g_free (signal_data);
3240 args_to_rule (const gchar *sender,
3241 const gchar *interface_name,
3242 const gchar *member,
3243 const gchar *object_path,
3249 rule = g_string_new ("type='signal'");
3251 g_string_prepend_c (rule, '-');
3253 g_string_append_printf (rule, ",sender='%s'", sender);
3254 if (interface_name != NULL)
3255 g_string_append_printf (rule, ",interface='%s'", interface_name);
3257 g_string_append_printf (rule, ",member='%s'", member);
3258 if (object_path != NULL)
3259 g_string_append_printf (rule, ",path='%s'", object_path);
3261 g_string_append_printf (rule, ",arg0='%s'", arg0);
3263 return g_string_free (rule, FALSE);
3266 static guint _global_subscriber_id = 1;
3267 static guint _global_registration_id = 1;
3268 static guint _global_subtree_registration_id = 1;
3270 /* ---------------------------------------------------------------------------------------------------- */
3272 /* Called in a user thread, lock is held */
3274 add_match_rule (GDBusConnection *connection,
3275 const gchar *match_rule)
3278 GDBusMessage *message;
3280 if (match_rule[0] == '-')
3283 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3284 "/org/freedesktop/DBus", /* path */
3285 "org.freedesktop.DBus", /* interface */
3287 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3289 if (!g_dbus_connection_send_message_unlocked (connection,
3291 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3295 g_critical ("Error while sending AddMatch() message: %s", error->message);
3296 g_error_free (error);
3298 g_object_unref (message);
3301 /* ---------------------------------------------------------------------------------------------------- */
3303 /* Called in a user thread, lock is held */
3305 remove_match_rule (GDBusConnection *connection,
3306 const gchar *match_rule)
3309 GDBusMessage *message;
3311 if (match_rule[0] == '-')
3314 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3315 "/org/freedesktop/DBus", /* path */
3316 "org.freedesktop.DBus", /* interface */
3318 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3321 if (!g_dbus_connection_send_message_unlocked (connection,
3323 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3327 /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
3328 * critical; but we're holding the lock, and our caller checked whether
3329 * we were already closed, so we can't get that error.
3331 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3332 g_error_free (error);
3334 g_object_unref (message);
3337 /* ---------------------------------------------------------------------------------------------------- */
3340 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3342 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3343 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3344 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3345 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3346 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3349 /* ---------------------------------------------------------------------------------------------------- */
3352 * g_dbus_connection_signal_subscribe:
3353 * @connection: A #GDBusConnection.
3354 * @sender: (allow-none): Sender name to match on (unique or well-known name)
3355 * or %NULL to listen from all senders.
3356 * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
3357 * match on all interfaces.
3358 * @member: (allow-none): D-Bus signal name to match on or %NULL to match on all signals.
3359 * @object_path: (allow-none): Object path to match on or %NULL to match on all object paths.
3360 * @arg0: (allow-none): Contents of first string argument to match on or %NULL
3361 * to match on all kinds of arguments.
3362 * @flags: Flags describing how to subscribe to the signal (currently unused).
3363 * @callback: Callback to invoke when there is a signal matching the requested data.
3364 * @user_data: User data to pass to @callback.
3365 * @user_data_free_func: (allow-none): Function to free @user_data with when
3366 * subscription is removed or %NULL.
3368 * Subscribes to signals on @connection and invokes @callback with a
3369 * whenever the signal is received. Note that @callback
3370 * will be invoked in the <link
3371 * linkend="g-main-context-push-thread-default">thread-default main
3372 * loop</link> of the thread you are calling this method from.
3374 * If @connection is not a message bus connection, @sender must be
3377 * If @sender is a well-known name note that @callback is invoked with
3378 * the unique name for the owner of @sender, not the well-known name
3379 * as one would expect. This is because the message bus rewrites the
3380 * name. As such, to avoid certain race conditions, users should be
3381 * tracking the name owner of the well-known name and use that when
3382 * processing the received signal.
3384 * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
3389 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
3390 const gchar *sender,
3391 const gchar *interface_name,
3392 const gchar *member,
3393 const gchar *object_path,
3395 GDBusSignalFlags flags,
3396 GDBusSignalCallback callback,
3398 GDestroyNotify user_data_free_func)
3401 SignalData *signal_data;
3402 SignalSubscriber subscriber;
3403 GPtrArray *signal_data_array;
3404 const gchar *sender_unique_name;
3406 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
3407 * an OOM condition. We might want to change that but that would involve making
3408 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
3409 * handle that. And there's really no sensible way of handling this short of retrying
3410 * to add the match rule... and then there's the little thing that, hey, maybe there's
3411 * a reason the bus in an OOM condition.
3413 * Doable, but not really sure it's worth it...
3416 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3417 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
3418 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
3419 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
3420 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
3421 g_return_val_if_fail (callback != NULL, 0);
3422 g_return_val_if_fail (check_initialized (connection), 0);
3424 CONNECTION_LOCK (connection);
3426 /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
3427 * with a '-' character to prefix the rule (which will otherwise be
3430 * This allows us to hash the rule and do our lifecycle tracking in
3431 * the usual way, but the '-' prevents the match rule from ever
3432 * actually being send to the bus (either for add or remove).
3434 rule = args_to_rule (sender, interface_name, member, object_path, arg0,
3435 (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE) != 0);
3437 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
3438 sender_unique_name = sender;
3440 sender_unique_name = "";
3442 subscriber.callback = callback;
3443 subscriber.user_data = user_data;
3444 subscriber.user_data_free_func = user_data_free_func;
3445 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
3446 subscriber.context = g_main_context_ref_thread_default ();
3448 /* see if we've already have this rule */
3449 signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
3450 if (signal_data != NULL)
3452 g_array_append_val (signal_data->subscribers, subscriber);
3457 signal_data = g_new0 (SignalData, 1);
3458 signal_data->rule = rule;
3459 signal_data->sender = g_strdup (sender);
3460 signal_data->sender_unique_name = g_strdup (sender_unique_name);
3461 signal_data->interface_name = g_strdup (interface_name);
3462 signal_data->member = g_strdup (member);
3463 signal_data->object_path = g_strdup (object_path);
3464 signal_data->arg0 = g_strdup (arg0);
3465 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3466 g_array_append_val (signal_data->subscribers, subscriber);
3468 g_hash_table_insert (connection->map_rule_to_signal_data,
3472 /* Add the match rule to the bus...
3474 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
3475 * always send such messages to us.
3477 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3479 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
3480 add_match_rule (connection, signal_data->rule);
3483 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3484 signal_data->sender_unique_name);
3485 if (signal_data_array == NULL)
3487 signal_data_array = g_ptr_array_new ();
3488 g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
3489 g_strdup (signal_data->sender_unique_name),
3492 g_ptr_array_add (signal_data_array, signal_data);
3495 g_hash_table_insert (connection->map_id_to_signal_data,
3496 GUINT_TO_POINTER (subscriber.id),
3499 CONNECTION_UNLOCK (connection);
3501 return subscriber.id;
3504 /* ---------------------------------------------------------------------------------------------------- */
3506 /* called in any thread */
3507 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
3509 unsubscribe_id_internal (GDBusConnection *connection,
3510 guint subscription_id,
3511 GArray *out_removed_subscribers)
3513 SignalData *signal_data;
3514 GPtrArray *signal_data_array;
3517 signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
3518 GUINT_TO_POINTER (subscription_id));
3519 if (signal_data == NULL)
3521 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
3525 for (n = 0; n < signal_data->subscribers->len; n++)
3527 SignalSubscriber *subscriber;
3529 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
3530 if (subscriber->id != subscription_id)
3533 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
3534 GUINT_TO_POINTER (subscription_id)));
3535 g_array_append_val (out_removed_subscribers, *subscriber);
3536 g_array_remove_index (signal_data->subscribers, n);
3538 if (signal_data->subscribers->len == 0)
3540 g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
3542 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3543 signal_data->sender_unique_name);
3544 g_warn_if_fail (signal_data_array != NULL);
3545 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
3547 if (signal_data_array->len == 0)
3549 g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
3550 signal_data->sender_unique_name));
3553 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
3554 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
3555 !is_signal_data_for_name_lost_or_acquired (signal_data) &&
3556 !g_dbus_connection_is_closed (connection) &&
3557 !connection->finalizing)
3559 /* The check for g_dbus_connection_is_closed() means that
3560 * sending the RemoveMatch message can't fail with
3561 * G_IO_ERROR_CLOSED, because we're holding the lock,
3562 * so on_worker_closed() can't happen between the check we just
3563 * did, and releasing the lock later.
3565 remove_match_rule (connection, signal_data->rule);
3568 signal_data_free (signal_data);
3574 g_assert_not_reached ();
3581 * g_dbus_connection_signal_unsubscribe:
3582 * @connection: A #GDBusConnection.
3583 * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
3585 * Unsubscribes from signals.
3590 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
3591 guint subscription_id)
3593 GArray *subscribers;
3596 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3597 g_return_if_fail (check_initialized (connection));
3599 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3601 CONNECTION_LOCK (connection);
3602 unsubscribe_id_internal (connection,
3605 CONNECTION_UNLOCK (connection);
3608 g_assert (subscribers->len == 0 || subscribers->len == 1);
3610 /* call GDestroyNotify without lock held */
3611 for (n = 0; n < subscribers->len; n++)
3613 SignalSubscriber *subscriber;
3614 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3615 call_destroy_notify (subscriber->context,
3616 subscriber->user_data_free_func,
3617 subscriber->user_data);
3618 g_main_context_unref (subscriber->context);
3621 g_array_free (subscribers, TRUE);
3624 /* ---------------------------------------------------------------------------------------------------- */
3628 guint subscription_id;
3629 GDBusSignalCallback callback;
3631 GDBusMessage *message;
3632 GDBusConnection *connection;
3633 const gchar *sender;
3635 const gchar *interface;
3636 const gchar *member;
3639 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
3643 emit_signal_instance_in_idle_cb (gpointer data)
3645 SignalInstance *signal_instance = data;
3646 GVariant *parameters;
3647 gboolean has_subscription;
3649 parameters = g_dbus_message_get_body (signal_instance->message);
3650 if (parameters == NULL)
3652 parameters = g_variant_new ("()");
3653 g_variant_ref_sink (parameters);
3657 g_variant_ref_sink (parameters);
3661 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
3662 signal_instance->subscription_id,
3663 signal_instance->sender,
3664 signal_instance->path,
3665 signal_instance->interface,
3666 signal_instance->member,
3667 g_variant_print (parameters, TRUE));
3670 /* Careful here, don't do the callback if we no longer has the subscription */
3671 CONNECTION_LOCK (signal_instance->connection);
3672 has_subscription = FALSE;
3673 if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
3674 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
3675 has_subscription = TRUE;
3676 CONNECTION_UNLOCK (signal_instance->connection);
3678 if (has_subscription)
3679 signal_instance->callback (signal_instance->connection,
3680 signal_instance->sender,
3681 signal_instance->path,
3682 signal_instance->interface,
3683 signal_instance->member,
3685 signal_instance->user_data);
3687 g_variant_unref (parameters);
3693 signal_instance_free (SignalInstance *signal_instance)
3695 g_object_unref (signal_instance->message);
3696 g_object_unref (signal_instance->connection);
3697 g_free (signal_instance);
3700 /* called in GDBusWorker thread WITH lock held */
3702 schedule_callbacks (GDBusConnection *connection,
3703 GPtrArray *signal_data_array,
3704 GDBusMessage *message,
3705 const gchar *sender)
3708 const gchar *interface;
3709 const gchar *member;
3718 interface = g_dbus_message_get_interface (message);
3719 member = g_dbus_message_get_member (message);
3720 path = g_dbus_message_get_path (message);
3721 arg0 = g_dbus_message_get_arg0 (message);
3724 g_print ("In schedule_callbacks:\n"
3726 " interface = `%s'\n"
3737 /* TODO: if this is slow, then we can change signal_data_array into
3738 * map_object_path_to_signal_data_array or something.
3740 for (n = 0; n < signal_data_array->len; n++)
3742 SignalData *signal_data = signal_data_array->pdata[n];
3744 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
3747 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
3750 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
3753 if (signal_data->arg0 != NULL && g_strcmp0 (signal_data->arg0, arg0) != 0)
3756 for (m = 0; m < signal_data->subscribers->len; m++)
3758 SignalSubscriber *subscriber;
3759 GSource *idle_source;
3760 SignalInstance *signal_instance;
3762 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
3764 signal_instance = g_new0 (SignalInstance, 1);
3765 signal_instance->subscription_id = subscriber->id;
3766 signal_instance->callback = subscriber->callback;
3767 signal_instance->user_data = subscriber->user_data;
3768 signal_instance->message = g_object_ref (message);
3769 signal_instance->connection = g_object_ref (connection);
3770 signal_instance->sender = sender;
3771 signal_instance->path = path;
3772 signal_instance->interface = interface;
3773 signal_instance->member = member;
3775 idle_source = g_idle_source_new ();
3776 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3777 g_source_set_callback (idle_source,
3778 emit_signal_instance_in_idle_cb,
3780 (GDestroyNotify) signal_instance_free);
3781 g_source_attach (idle_source, subscriber->context);
3782 g_source_unref (idle_source);
3787 /* called in GDBusWorker thread with lock held */
3789 distribute_signals (GDBusConnection *connection,
3790 GDBusMessage *message)
3792 GPtrArray *signal_data_array;
3793 const gchar *sender;
3795 sender = g_dbus_message_get_sender (message);
3797 if (G_UNLIKELY (_g_dbus_debug_signal ()))
3799 _g_dbus_debug_print_lock ();
3800 g_print ("========================================================================\n"
3801 "GDBus-debug:Signal:\n"
3802 " <<<< RECEIVED SIGNAL %s.%s\n"
3804 " sent by name %s\n",
3805 g_dbus_message_get_interface (message),
3806 g_dbus_message_get_member (message),
3807 g_dbus_message_get_path (message),
3808 sender != NULL ? sender : "(none)");
3809 _g_dbus_debug_print_unlock ();
3812 /* collect subscribers that match on sender */
3815 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
3816 if (signal_data_array != NULL)
3817 schedule_callbacks (connection, signal_data_array, message, sender);
3820 /* collect subscribers not matching on sender */
3821 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
3822 if (signal_data_array != NULL)
3823 schedule_callbacks (connection, signal_data_array, message, sender);
3826 /* ---------------------------------------------------------------------------------------------------- */
3828 /* only called from finalize(), removes all subscriptions */
3830 purge_all_signal_subscriptions (GDBusConnection *connection)
3832 GHashTableIter iter;
3835 GArray *subscribers;
3838 ids = g_array_new (FALSE, FALSE, sizeof (guint));
3839 g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
3840 while (g_hash_table_iter_next (&iter, &key, NULL))
3842 guint subscription_id = GPOINTER_TO_UINT (key);
3843 g_array_append_val (ids, subscription_id);
3846 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3847 for (n = 0; n < ids->len; n++)
3849 guint subscription_id = g_array_index (ids, guint, n);
3850 unsubscribe_id_internal (connection,
3854 g_array_free (ids, TRUE);
3856 /* call GDestroyNotify without lock held */
3857 for (n = 0; n < subscribers->len; n++)
3859 SignalSubscriber *subscriber;
3860 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3861 call_destroy_notify (subscriber->context,
3862 subscriber->user_data_free_func,
3863 subscriber->user_data);
3864 g_main_context_unref (subscriber->context);
3867 g_array_free (subscribers, TRUE);
3870 /* ---------------------------------------------------------------------------------------------------- */
3872 static GDBusInterfaceVTable *
3873 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
3875 /* Don't waste memory by copying padding - remember to update this
3876 * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
3878 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3882 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
3887 /* ---------------------------------------------------------------------------------------------------- */
3889 static GDBusSubtreeVTable *
3890 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
3892 /* Don't waste memory by copying padding - remember to update this
3893 * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
3895 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3899 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
3904 /* ---------------------------------------------------------------------------------------------------- */
3906 struct ExportedObject
3909 GDBusConnection *connection;
3911 /* maps gchar* -> ExportedInterface* */
3912 GHashTable *map_if_name_to_ei;
3915 /* only called with lock held */
3917 exported_object_free (ExportedObject *eo)
3919 g_free (eo->object_path);
3920 g_hash_table_unref (eo->map_if_name_to_ei);
3929 gchar *interface_name;
3930 GDBusInterfaceVTable *vtable;
3931 GDBusInterfaceInfo *interface_info;
3933 GMainContext *context;
3935 GDestroyNotify user_data_free_func;
3936 } ExportedInterface;
3938 /* called with lock held */
3940 exported_interface_free (ExportedInterface *ei)
3942 g_dbus_interface_info_cache_release (ei->interface_info);
3943 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
3945 call_destroy_notify (ei->context,
3946 ei->user_data_free_func,
3949 g_main_context_unref (ei->context);
3951 g_free (ei->interface_name);
3952 _g_dbus_interface_vtable_free (ei->vtable);
3956 /* ---------------------------------------------------------------------------------------------------- */
3958 /* Convenience function to check if @registration_id (if not zero) or
3959 * @subtree_registration_id (if not zero) has been unregistered. If
3960 * so, returns %TRUE.
3962 * May be called by any thread. Caller must *not* hold lock.
3965 has_object_been_unregistered (GDBusConnection *connection,
3966 guint registration_id,
3967 guint subtree_registration_id)
3971 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3975 CONNECTION_LOCK (connection);
3976 if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
3977 GUINT_TO_POINTER (registration_id)) == NULL)
3981 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
3982 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
3986 CONNECTION_UNLOCK (connection);
3991 /* ---------------------------------------------------------------------------------------------------- */
3995 GDBusConnection *connection;
3996 GDBusMessage *message;
3998 const gchar *property_name;
3999 const GDBusInterfaceVTable *vtable;
4000 GDBusInterfaceInfo *interface_info;
4001 const GDBusPropertyInfo *property_info;
4002 guint registration_id;
4003 guint subtree_registration_id;
4007 property_data_free (PropertyData *data)
4009 g_object_unref (data->connection);
4010 g_object_unref (data->message);
4014 /* called in thread where object was registered - no locks held */
4016 invoke_get_property_in_idle_cb (gpointer _data)
4018 PropertyData *data = _data;
4021 GDBusMessage *reply;
4023 if (has_object_been_unregistered (data->connection,
4024 data->registration_id,
4025 data->subtree_registration_id))
4027 reply = g_dbus_message_new_method_error (data->message,
4028 "org.freedesktop.DBus.Error.UnknownMethod",
4029 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
4030 g_dbus_message_get_path (data->message));
4031 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4032 g_object_unref (reply);
4037 value = data->vtable->get_property (data->connection,
4038 g_dbus_message_get_sender (data->message),
4039 g_dbus_message_get_path (data->message),
4040 data->interface_info->name,
4041 data->property_name,
4048 g_assert_no_error (error);
4050 g_variant_take_ref (value);
4051 reply = g_dbus_message_new_method_reply (data->message);
4052 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
4053 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4054 g_variant_unref (value);
4055 g_object_unref (reply);
4059 gchar *dbus_error_name;
4060 g_assert (error != NULL);
4061 dbus_error_name = g_dbus_error_encode_gerror (error);
4062 reply = g_dbus_message_new_method_error_literal (data->message,
4065 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4066 g_free (dbus_error_name);
4067 g_error_free (error);
4068 g_object_unref (reply);
4075 /* called in thread where object was registered - no locks held */
4077 invoke_set_property_in_idle_cb (gpointer _data)
4079 PropertyData *data = _data;
4081 GDBusMessage *reply;
4087 g_variant_get (g_dbus_message_get_body (data->message),
4093 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
4094 * of the given value is wrong
4096 if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
4098 reply = g_dbus_message_new_method_error (data->message,
4099 "org.freedesktop.DBus.Error.InvalidArgs",
4100 _("Error setting property `%s': Expected type `%s' but got `%s'"),
4101 data->property_info->name,
4102 data->property_info->signature,
4103 g_variant_get_type_string (value));
4107 if (!data->vtable->set_property (data->connection,
4108 g_dbus_message_get_sender (data->message),
4109 g_dbus_message_get_path (data->message),
4110 data->interface_info->name,
4111 data->property_name,
4116 gchar *dbus_error_name;
4117 g_assert (error != NULL);
4118 dbus_error_name = g_dbus_error_encode_gerror (error);
4119 reply = g_dbus_message_new_method_error_literal (data->message,
4122 g_free (dbus_error_name);
4123 g_error_free (error);
4127 reply = g_dbus_message_new_method_reply (data->message);
4131 g_assert (reply != NULL);
4132 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4133 g_object_unref (reply);
4134 g_variant_unref (value);
4139 /* called in any thread with connection's lock held */
4141 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
4142 GDBusMessage *message,
4143 guint registration_id,
4144 guint subtree_registration_id,
4146 GDBusInterfaceInfo *interface_info,
4147 const GDBusInterfaceVTable *vtable,
4148 GMainContext *main_context,
4152 const char *interface_name;
4153 const char *property_name;
4154 const GDBusPropertyInfo *property_info;
4155 GSource *idle_source;
4156 PropertyData *property_data;
4157 GDBusMessage *reply;
4162 g_variant_get (g_dbus_message_get_body (message),
4167 g_variant_get (g_dbus_message_get_body (message),
4176 if (vtable == NULL || vtable->get_property == NULL)
4181 if (vtable == NULL || vtable->set_property == NULL)
4185 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
4187 property_info = NULL;
4189 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4190 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
4191 if (property_info == NULL)
4193 reply = g_dbus_message_new_method_error (message,
4194 "org.freedesktop.DBus.Error.InvalidArgs",
4195 _("No such property `%s'"),
4197 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4198 g_object_unref (reply);
4203 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4205 reply = g_dbus_message_new_method_error (message,
4206 "org.freedesktop.DBus.Error.InvalidArgs",
4207 _("Property `%s' is not readable"),
4209 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4210 g_object_unref (reply);
4214 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
4216 reply = g_dbus_message_new_method_error (message,
4217 "org.freedesktop.DBus.Error.InvalidArgs",
4218 _("Property `%s' is not writable"),
4220 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4221 g_object_unref (reply);
4226 /* ok, got the property info - call user code in an idle handler */
4227 property_data = g_new0 (PropertyData, 1);
4228 property_data->connection = g_object_ref (connection);
4229 property_data->message = g_object_ref (message);
4230 property_data->user_data = user_data;
4231 property_data->property_name = property_name;
4232 property_data->vtable = vtable;
4233 property_data->interface_info = interface_info;
4234 property_data->property_info = property_info;
4235 property_data->registration_id = registration_id;
4236 property_data->subtree_registration_id = subtree_registration_id;
4238 idle_source = g_idle_source_new ();
4239 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4240 g_source_set_callback (idle_source,
4241 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
4243 (GDestroyNotify) property_data_free);
4244 g_source_attach (idle_source, main_context);
4245 g_source_unref (idle_source);
4253 /* called in GDBusWorker thread with connection's lock held */
4255 handle_getset_property (GDBusConnection *connection,
4257 GDBusMessage *message,
4260 ExportedInterface *ei;
4262 const char *interface_name;
4263 const char *property_name;
4268 g_variant_get (g_dbus_message_get_body (message),
4273 g_variant_get (g_dbus_message_get_body (message),
4279 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4280 * no such interface registered
4282 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4285 GDBusMessage *reply;
4286 reply = g_dbus_message_new_method_error (message,
4287 "org.freedesktop.DBus.Error.InvalidArgs",
4288 _("No such interface `%s'"),
4290 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4291 g_object_unref (reply);
4296 handled = validate_and_maybe_schedule_property_getset (eo->connection,
4309 /* ---------------------------------------------------------------------------------------------------- */
4313 GDBusConnection *connection;
4314 GDBusMessage *message;
4316 const GDBusInterfaceVTable *vtable;
4317 GDBusInterfaceInfo *interface_info;
4318 guint registration_id;
4319 guint subtree_registration_id;
4320 } PropertyGetAllData;
4323 property_get_all_data_free (PropertyData *data)
4325 g_object_unref (data->connection);
4326 g_object_unref (data->message);
4330 /* called in thread where object was registered - no locks held */
4332 invoke_get_all_properties_in_idle_cb (gpointer _data)
4334 PropertyGetAllData *data = _data;
4335 GVariantBuilder builder;
4336 GDBusMessage *reply;
4339 if (has_object_been_unregistered (data->connection,
4340 data->registration_id,
4341 data->subtree_registration_id))
4343 reply = g_dbus_message_new_method_error (data->message,
4344 "org.freedesktop.DBus.Error.UnknownMethod",
4345 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
4346 g_dbus_message_get_path (data->message));
4347 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4348 g_object_unref (reply);
4352 /* TODO: Right now we never fail this call - we just omit values if
4353 * a get_property() call is failing.
4355 * We could fail the whole call if just a single get_property() call
4356 * returns an error. We need clarification in the D-Bus spec about this.
4358 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
4359 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
4360 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
4362 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
4365 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4368 value = data->vtable->get_property (data->connection,
4369 g_dbus_message_get_sender (data->message),
4370 g_dbus_message_get_path (data->message),
4371 data->interface_info->name,
4372 property_info->name,
4379 g_variant_take_ref (value);
4380 g_variant_builder_add (&builder,
4382 property_info->name,
4384 g_variant_unref (value);
4386 g_variant_builder_close (&builder);
4388 reply = g_dbus_message_new_method_reply (data->message);
4389 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
4390 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4391 g_object_unref (reply);
4397 /* called in any thread with connection's lock held */
4399 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
4400 GDBusMessage *message,
4401 guint registration_id,
4402 guint subtree_registration_id,
4403 GDBusInterfaceInfo *interface_info,
4404 const GDBusInterfaceVTable *vtable,
4405 GMainContext *main_context,
4409 const char *interface_name;
4410 GSource *idle_source;
4411 PropertyGetAllData *property_get_all_data;
4415 g_variant_get (g_dbus_message_get_body (message),
4419 if (vtable == NULL || vtable->get_property == NULL)
4422 /* ok, got the property info - call user in an idle handler */
4423 property_get_all_data = g_new0 (PropertyGetAllData, 1);
4424 property_get_all_data->connection = g_object_ref (connection);
4425 property_get_all_data->message = g_object_ref (message);
4426 property_get_all_data->user_data = user_data;
4427 property_get_all_data->vtable = vtable;
4428 property_get_all_data->interface_info = interface_info;
4429 property_get_all_data->registration_id = registration_id;
4430 property_get_all_data->subtree_registration_id = subtree_registration_id;
4432 idle_source = g_idle_source_new ();
4433 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4434 g_source_set_callback (idle_source,
4435 invoke_get_all_properties_in_idle_cb,
4436 property_get_all_data,
4437 (GDestroyNotify) property_get_all_data_free);
4438 g_source_attach (idle_source, main_context);
4439 g_source_unref (idle_source);
4447 /* called in GDBusWorker thread with connection's lock held */
4449 handle_get_all_properties (GDBusConnection *connection,
4451 GDBusMessage *message)
4453 ExportedInterface *ei;
4455 const char *interface_name;
4459 g_variant_get (g_dbus_message_get_body (message),
4463 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4464 * no such interface registered
4466 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4469 GDBusMessage *reply;
4470 reply = g_dbus_message_new_method_error (message,
4471 "org.freedesktop.DBus.Error.InvalidArgs",
4472 _("No such interface"),
4474 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4475 g_object_unref (reply);
4480 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
4492 /* ---------------------------------------------------------------------------------------------------- */
4494 static const gchar introspect_header[] =
4495 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
4496 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
4497 "<!-- GDBus " PACKAGE_VERSION " -->\n"
4500 static const gchar introspect_tail[] =
4503 static const gchar introspect_properties_interface[] =
4504 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
4505 " <method name=\"Get\">\n"
4506 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4507 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4508 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
4510 " <method name=\"GetAll\">\n"
4511 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4512 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
4514 " <method name=\"Set\">\n"
4515 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4516 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4517 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
4519 " <signal name=\"PropertiesChanged\">\n"
4520 " <arg type=\"s\" name=\"interface_name\"/>\n"
4521 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
4522 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
4526 static const gchar introspect_introspectable_interface[] =
4527 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
4528 " <method name=\"Introspect\">\n"
4529 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
4532 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
4533 " <method name=\"Ping\"/>\n"
4534 " <method name=\"GetMachineId\">\n"
4535 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
4540 introspect_append_header (GString *s)
4542 g_string_append (s, introspect_header);
4546 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
4548 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
4554 begin = object_path + path_len;
4555 end = strchr (begin, '/');
4557 s = g_strndup (begin, end - begin);
4559 s = g_strdup (begin);
4561 if (g_hash_table_lookup (set, s) == NULL)
4562 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
4568 /* TODO: we want a nicer public interface for this */
4569 /* called in any thread with connection's lock held */
4571 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
4576 GHashTableIter hash_iter;
4577 const gchar *object_path;
4583 CONNECTION_ENSURE_LOCK (connection);
4585 path_len = strlen (path);
4589 set = g_hash_table_new (g_str_hash, g_str_equal);
4591 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
4592 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4593 maybe_add_path (path, path_len, object_path, set);
4595 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
4596 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4597 maybe_add_path (path, path_len, object_path, set);
4599 p = g_ptr_array_new ();
4600 keys = g_hash_table_get_keys (set);
4601 for (l = keys; l != NULL; l = l->next)
4602 g_ptr_array_add (p, l->data);
4603 g_hash_table_unref (set);
4606 g_ptr_array_add (p, NULL);
4607 ret = (gchar **) g_ptr_array_free (p, FALSE);
4611 /* called in any thread with connection's lock not held */
4613 g_dbus_connection_list_registered (GDBusConnection *connection,
4617 CONNECTION_LOCK (connection);
4618 ret = g_dbus_connection_list_registered_unlocked (connection, path);
4619 CONNECTION_UNLOCK (connection);
4623 /* called in GDBusWorker thread with connection's lock held */
4625 handle_introspect (GDBusConnection *connection,
4627 GDBusMessage *message)
4631 GDBusMessage *reply;
4632 GHashTableIter hash_iter;
4633 ExportedInterface *ei;
4636 /* first the header with the standard interfaces */
4637 s = g_string_sized_new (sizeof (introspect_header) +
4638 sizeof (introspect_properties_interface) +
4639 sizeof (introspect_introspectable_interface) +
4640 sizeof (introspect_tail));
4641 introspect_append_header (s);
4642 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4643 "org.freedesktop.DBus.Properties"))
4644 g_string_append (s, introspect_properties_interface);
4646 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4647 "org.freedesktop.DBus.Introspectable"))
4648 g_string_append (s, introspect_introspectable_interface);
4650 /* then include the registered interfaces */
4651 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
4652 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
4653 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
4655 /* finally include nodes registered below us */
4656 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
4657 for (n = 0; registered != NULL && registered[n] != NULL; n++)
4658 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
4659 g_strfreev (registered);
4660 g_string_append (s, introspect_tail);
4662 reply = g_dbus_message_new_method_reply (message);
4663 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4664 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4665 g_object_unref (reply);
4666 g_string_free (s, TRUE);
4671 /* called in thread where object was registered - no locks held */
4673 call_in_idle_cb (gpointer user_data)
4675 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
4676 GDBusInterfaceVTable *vtable;
4677 guint registration_id;
4678 guint subtree_registration_id;
4680 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
4681 g_assert (vtable != NULL && vtable->method_call != NULL);
4683 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
4684 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
4686 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
4688 subtree_registration_id))
4690 GDBusMessage *reply;
4691 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
4692 "org.freedesktop.DBus.Error.UnknownMethod",
4693 _("No such interface `%s' on object at path %s"),
4694 g_dbus_method_invocation_get_interface_name (invocation),
4695 g_dbus_method_invocation_get_object_path (invocation));
4696 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4697 g_object_unref (reply);
4701 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
4702 g_dbus_method_invocation_get_sender (invocation),
4703 g_dbus_method_invocation_get_object_path (invocation),
4704 g_dbus_method_invocation_get_interface_name (invocation),
4705 g_dbus_method_invocation_get_method_name (invocation),
4706 g_dbus_method_invocation_get_parameters (invocation),
4707 g_object_ref (invocation),
4708 g_dbus_method_invocation_get_user_data (invocation));
4714 /* called in GDBusWorker thread with connection's lock held */
4716 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
4717 GDBusMessage *message,
4718 guint registration_id,
4719 guint subtree_registration_id,
4720 GDBusInterfaceInfo *interface_info,
4721 const GDBusInterfaceVTable *vtable,
4722 GMainContext *main_context,
4725 GDBusMethodInvocation *invocation;
4726 const GDBusMethodInfo *method_info;
4727 GDBusMessage *reply;
4728 GVariant *parameters;
4729 GSource *idle_source;
4731 GVariantType *in_type;
4735 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4736 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
4738 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
4739 * error to the caller
4741 if (method_info == NULL)
4743 reply = g_dbus_message_new_method_error (message,
4744 "org.freedesktop.DBus.Error.UnknownMethod",
4745 _("No such method `%s'"),
4746 g_dbus_message_get_member (message));
4747 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4748 g_object_unref (reply);
4753 parameters = g_dbus_message_get_body (message);
4754 if (parameters == NULL)
4756 parameters = g_variant_new ("()");
4757 g_variant_ref_sink (parameters);
4761 g_variant_ref (parameters);
4764 /* Check that the incoming args are of the right type - if they are not, return
4765 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
4767 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
4768 if (!g_variant_is_of_type (parameters, in_type))
4772 type_string = g_variant_type_dup_string (in_type);
4774 reply = g_dbus_message_new_method_error (message,
4775 "org.freedesktop.DBus.Error.InvalidArgs",
4776 _("Type of message, `%s', does not match expected type `%s'"),
4777 g_variant_get_type_string (parameters),
4779 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4780 g_variant_type_free (in_type);
4781 g_variant_unref (parameters);
4782 g_object_unref (reply);
4783 g_free (type_string);
4787 g_variant_type_free (in_type);
4789 /* schedule the call in idle */
4790 invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
4791 g_dbus_message_get_path (message),
4792 g_dbus_message_get_interface (message),
4793 g_dbus_message_get_member (message),
4799 g_variant_unref (parameters);
4801 /* TODO: would be nicer with a real MethodData like we already
4802 * have PropertyData and PropertyGetAllData... */
4803 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
4804 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
4805 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
4807 idle_source = g_idle_source_new ();
4808 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4809 g_source_set_callback (idle_source,
4813 g_source_attach (idle_source, main_context);
4814 g_source_unref (idle_source);
4822 /* ---------------------------------------------------------------------------------------------------- */
4824 /* called in GDBusWorker thread with connection's lock held */
4826 obj_message_func (GDBusConnection *connection,
4828 GDBusMessage *message)
4830 const gchar *interface_name;
4831 const gchar *member;
4832 const gchar *signature;
4837 interface_name = g_dbus_message_get_interface (message);
4838 member = g_dbus_message_get_member (message);
4839 signature = g_dbus_message_get_signature (message);
4841 /* see if we have an interface for handling this call */
4842 if (interface_name != NULL)
4844 ExportedInterface *ei;
4845 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4848 /* we do - invoke the handler in idle in the right thread */
4850 /* handle no vtable or handler being present */
4851 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
4854 handled = validate_and_maybe_schedule_method_call (connection,
4866 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
4867 g_strcmp0 (member, "Introspect") == 0 &&
4868 g_strcmp0 (signature, "") == 0)
4870 handled = handle_introspect (connection, eo, message);
4873 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4874 g_strcmp0 (member, "Get") == 0 &&
4875 g_strcmp0 (signature, "ss") == 0)
4877 handled = handle_getset_property (connection, eo, message, TRUE);
4880 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4881 g_strcmp0 (member, "Set") == 0 &&
4882 g_strcmp0 (signature, "ssv") == 0)
4884 handled = handle_getset_property (connection, eo, message, FALSE);
4887 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4888 g_strcmp0 (member, "GetAll") == 0 &&
4889 g_strcmp0 (signature, "s") == 0)
4891 handled = handle_get_all_properties (connection, eo, message);
4900 * g_dbus_connection_register_object:
4901 * @connection: A #GDBusConnection.
4902 * @object_path: The object path to register at.
4903 * @interface_info: Introspection data for the interface.
4904 * @vtable: (allow-none): A #GDBusInterfaceVTable to call into or %NULL.
4905 * @user_data: (allow-none): Data to pass to functions in @vtable.
4906 * @user_data_free_func: Function to call when the object path is unregistered.
4907 * @error: Return location for error or %NULL.
4909 * Registers callbacks for exported objects at @object_path with the
4910 * D-Bus interface that is described in @interface_info.
4912 * Calls to functions in @vtable (and @user_data_free_func) will
4913 * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
4914 * loop</link> of the thread you are calling this method from.
4916 * Note that all #GVariant values passed to functions in @vtable will match
4917 * the signature given in @interface_info - if a remote caller passes
4918 * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
4919 * is returned to the remote caller.
4921 * Additionally, if the remote caller attempts to invoke methods or
4922 * access properties not mentioned in @interface_info the
4923 * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
4924 * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
4925 * are returned to the caller.
4927 * It is considered a programming error if the
4928 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
4929 * #GVariant of incorrect type.
4931 * If an existing callback is already registered at @object_path and
4932 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
4934 * GDBus automatically implements the standard D-Bus interfaces
4935 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
4936 * and org.freedesktop.Peer, so you don't have to implement those for
4937 * the objects you export. You <emphasis>can</emphasis> implement
4938 * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
4939 * and setting of properties asynchronously.
4941 * Note that the reference count on @interface_info will be
4942 * incremented by 1 (unless allocated statically, e.g. if the
4943 * reference count is -1, see g_dbus_interface_info_ref()) for as long
4944 * as the object is exported. Also note that @vtable will be copied.
4946 * See <xref linkend="gdbus-server"/> for an example of how to use this method.
4948 * Returns: 0 if @error is set, otherwise a registration id (never 0)
4949 * that can be used with g_dbus_connection_unregister_object() .
4954 g_dbus_connection_register_object (GDBusConnection *connection,
4955 const gchar *object_path,
4956 GDBusInterfaceInfo *interface_info,
4957 const GDBusInterfaceVTable *vtable,
4959 GDestroyNotify user_data_free_func,
4963 ExportedInterface *ei;
4966 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4967 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
4968 g_return_val_if_fail (interface_info != NULL, 0);
4969 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
4970 g_return_val_if_fail (error == NULL || *error == NULL, 0);
4971 g_return_val_if_fail (check_initialized (connection), 0);
4975 CONNECTION_LOCK (connection);
4977 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
4980 eo = g_new0 (ExportedObject, 1);
4981 eo->object_path = g_strdup (object_path);
4982 eo->connection = connection;
4983 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
4986 (GDestroyNotify) exported_interface_free);
4987 g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
4990 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
4996 _("An object is already exported for the interface %s at %s"),
4997 interface_info->name,
5002 ei = g_new0 (ExportedInterface, 1);
5003 ei->id = _global_registration_id++; /* TODO: overflow etc. */
5005 ei->user_data = user_data;
5006 ei->user_data_free_func = user_data_free_func;
5007 ei->vtable = _g_dbus_interface_vtable_copy (vtable);
5008 ei->interface_info = g_dbus_interface_info_ref (interface_info);
5009 g_dbus_interface_info_cache_build (ei->interface_info);
5010 ei->interface_name = g_strdup (interface_info->name);
5011 ei->context = g_main_context_ref_thread_default ();
5013 g_hash_table_insert (eo->map_if_name_to_ei,
5014 (gpointer) ei->interface_name,
5016 g_hash_table_insert (connection->map_id_to_ei,
5017 GUINT_TO_POINTER (ei->id),
5023 CONNECTION_UNLOCK (connection);
5029 * g_dbus_connection_unregister_object:
5030 * @connection: A #GDBusConnection.
5031 * @registration_id: A registration id obtained from g_dbus_connection_register_object().
5033 * Unregisters an object.
5035 * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
5040 g_dbus_connection_unregister_object (GDBusConnection *connection,
5041 guint registration_id)
5043 ExportedInterface *ei;
5047 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5048 g_return_val_if_fail (check_initialized (connection), FALSE);
5052 CONNECTION_LOCK (connection);
5054 ei = g_hash_table_lookup (connection->map_id_to_ei,
5055 GUINT_TO_POINTER (registration_id));
5061 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
5062 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
5063 /* unregister object path if we have no more exported interfaces */
5064 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
5065 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
5071 CONNECTION_UNLOCK (connection);
5076 /* ---------------------------------------------------------------------------------------------------- */
5079 * g_dbus_connection_emit_signal:
5080 * @connection: A #GDBusConnection.
5081 * @destination_bus_name: (allow-none): The unique bus name for the destination
5082 * for the signal or %NULL to emit to all listeners.
5083 * @object_path: Path of remote object.
5084 * @interface_name: D-Bus interface to emit a signal on.
5085 * @signal_name: The name of the signal to emit.
5086 * @parameters: (allow-none): A #GVariant tuple with parameters for the signal
5087 * or %NULL if not passing parameters.
5088 * @error: Return location for error or %NULL.
5092 * If the parameters GVariant is floating, it is consumed.
5094 * This can only fail if @parameters is not compatible with the D-Bus protocol.
5096 * Returns: %TRUE unless @error is set.
5101 g_dbus_connection_emit_signal (GDBusConnection *connection,
5102 const gchar *destination_bus_name,
5103 const gchar *object_path,
5104 const gchar *interface_name,
5105 const gchar *signal_name,
5106 GVariant *parameters,
5109 GDBusMessage *message;
5115 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5116 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
5117 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
5118 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
5119 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
5120 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
5121 g_return_val_if_fail (check_initialized (connection), FALSE);
5123 if (G_UNLIKELY (_g_dbus_debug_emission ()))
5125 _g_dbus_debug_print_lock ();
5126 g_print ("========================================================================\n"
5127 "GDBus-debug:Emission:\n"
5128 " >>>> SIGNAL EMISSION %s.%s()\n"
5130 " destination %s\n",
5131 interface_name, signal_name,
5133 destination_bus_name != NULL ? destination_bus_name : "(none)");
5134 _g_dbus_debug_print_unlock ();
5137 message = g_dbus_message_new_signal (object_path,
5141 if (destination_bus_name != NULL)
5142 g_dbus_message_set_header (message,
5143 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
5144 g_variant_new_string (destination_bus_name));
5146 if (parameters != NULL)
5147 g_dbus_message_set_body (message, parameters);
5149 ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
5150 g_object_unref (message);
5156 add_call_flags (GDBusMessage *message,
5157 GDBusCallFlags flags)
5159 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
5160 g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
5164 decode_method_reply (GDBusMessage *reply,
5165 const gchar *method_name,
5166 const GVariantType *reply_type,
5167 GUnixFDList **out_fd_list,
5173 switch (g_dbus_message_get_message_type (reply))
5175 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
5176 result = g_dbus_message_get_body (reply);
5179 result = g_variant_new ("()");
5180 g_variant_ref_sink (result);
5184 g_variant_ref (result);
5187 if (!g_variant_is_of_type (result, reply_type))
5189 gchar *type_string = g_variant_type_dup_string (reply_type);
5193 G_IO_ERROR_INVALID_ARGUMENT,
5194 _("Method `%s' returned type `%s', but expected `%s'"),
5195 method_name, g_variant_get_type_string (result), type_string);
5197 g_variant_unref (result);
5198 g_free (type_string);
5205 if (out_fd_list != NULL)
5207 *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
5208 if (*out_fd_list != NULL)
5209 g_object_ref (*out_fd_list);
5215 case G_DBUS_MESSAGE_TYPE_ERROR:
5216 g_dbus_message_to_gerror (reply, error);
5220 g_assert_not_reached ();
5230 GSimpleAsyncResult *simple;
5231 GVariantType *reply_type;
5232 gchar *method_name; /* for error message */
5236 GUnixFDList *fd_list;
5240 call_state_free (CallState *state)
5242 g_variant_type_free (state->reply_type);
5243 g_free (state->method_name);
5245 if (state->value != NULL)
5246 g_variant_unref (state->value);
5247 if (state->fd_list != NULL)
5248 g_object_unref (state->fd_list);
5249 g_slice_free (CallState, state);
5252 /* called in any thread, with the connection's lock not held */
5254 g_dbus_connection_call_done (GObject *source,
5255 GAsyncResult *result,
5258 GSimpleAsyncResult *simple;
5259 GDBusConnection *connection = G_DBUS_CONNECTION (source);
5260 CallState *state = user_data;
5262 GDBusMessage *reply;
5265 reply = g_dbus_connection_send_message_with_reply_finish (connection,
5269 if (G_UNLIKELY (_g_dbus_debug_call ()))
5271 _g_dbus_debug_print_lock ();
5272 g_print ("========================================================================\n"
5273 "GDBus-debug:Call:\n"
5274 " <<<< ASYNC COMPLETE %s() (serial %d)\n"
5280 g_print ("SUCCESS\n");
5284 g_print ("FAILED: %s\n",
5287 _g_dbus_debug_print_unlock ();
5291 state->value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
5293 simple = state->simple; /* why? because state is freed before we unref simple.. */
5296 g_simple_async_result_take_error (state->simple, error);
5297 g_simple_async_result_complete (state->simple);
5298 call_state_free (state);
5302 g_simple_async_result_set_op_res_gpointer (state->simple, state, (GDestroyNotify) call_state_free);
5303 g_simple_async_result_complete (state->simple);
5305 g_clear_object (&reply);
5306 g_object_unref (simple);
5309 /* called in any thread, with the connection's lock not held */
5311 g_dbus_connection_call_internal (GDBusConnection *connection,
5312 const gchar *bus_name,
5313 const gchar *object_path,
5314 const gchar *interface_name,
5315 const gchar *method_name,
5316 GVariant *parameters,
5317 const GVariantType *reply_type,
5318 GDBusCallFlags flags,
5320 GUnixFDList *fd_list,
5321 GCancellable *cancellable,
5322 GAsyncReadyCallback callback,
5325 GDBusMessage *message;
5328 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
5329 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
5330 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
5331 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
5332 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
5333 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
5334 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
5335 g_return_if_fail (check_initialized (connection));
5337 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
5339 g_return_if_fail (fd_list == NULL);
5342 state = g_slice_new0 (CallState);
5343 state->simple = g_simple_async_result_new (G_OBJECT (connection),
5344 callback, user_data,
5345 g_dbus_connection_call_internal);
5346 g_simple_async_result_set_check_cancellable (state->simple, cancellable);
5347 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
5349 if (reply_type == NULL)
5350 reply_type = G_VARIANT_TYPE_ANY;
5352 state->reply_type = g_variant_type_copy (reply_type);
5354 message = g_dbus_message_new_method_call (bus_name,
5358 add_call_flags (message, flags);
5359 if (parameters != NULL)
5360 g_dbus_message_set_body (message, parameters);
5363 if (fd_list != NULL)
5364 g_dbus_message_set_unix_fd_list (message, fd_list);
5367 g_dbus_connection_send_message_with_reply (connection,
5369 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5373 g_dbus_connection_call_done,
5376 if (G_UNLIKELY (_g_dbus_debug_call ()))
5378 _g_dbus_debug_print_lock ();
5379 g_print ("========================================================================\n"
5380 "GDBus-debug:Call:\n"
5381 " >>>> ASYNC %s.%s()\n"
5383 " owned by name %s (serial %d)\n",
5387 bus_name != NULL ? bus_name : "(none)",
5389 _g_dbus_debug_print_unlock ();
5392 if (message != NULL)
5393 g_object_unref (message);
5396 /* called in any thread, with the connection's lock not held */
5398 g_dbus_connection_call_finish_internal (GDBusConnection *connection,
5399 GUnixFDList **out_fd_list,
5403 GSimpleAsyncResult *simple;
5406 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5407 g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
5408 g_dbus_connection_call_internal), NULL);
5409 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5411 simple = G_SIMPLE_ASYNC_RESULT (res);
5413 if (g_simple_async_result_propagate_error (simple, error))
5416 state = g_simple_async_result_get_op_res_gpointer (simple);
5417 if (out_fd_list != NULL)
5418 *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
5419 return g_variant_ref (state->value);
5422 /* called in any user thread, with the connection's lock not held */
5424 g_dbus_connection_call_sync_internal (GDBusConnection *connection,
5425 const gchar *bus_name,
5426 const gchar *object_path,
5427 const gchar *interface_name,
5428 const gchar *method_name,
5429 GVariant *parameters,
5430 const GVariantType *reply_type,
5431 GDBusCallFlags flags,
5433 GUnixFDList *fd_list,
5434 GUnixFDList **out_fd_list,
5435 GCancellable *cancellable,
5438 GDBusMessage *message;
5439 GDBusMessage *reply;
5441 GError *local_error;
5442 GDBusSendMessageFlags send_flags;
5448 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5449 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
5450 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
5451 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
5452 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
5453 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
5454 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
5456 g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
5458 g_return_val_if_fail (fd_list == NULL, NULL);
5460 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5462 if (!(flags & CALL_FLAGS_INITIALIZING))
5463 g_return_val_if_fail (check_initialized (connection), FALSE);
5465 if (reply_type == NULL)
5466 reply_type = G_VARIANT_TYPE_ANY;
5468 message = g_dbus_message_new_method_call (bus_name,
5472 add_call_flags (message, flags);
5473 if (parameters != NULL)
5474 g_dbus_message_set_body (message, parameters);
5477 if (fd_list != NULL)
5478 g_dbus_message_set_unix_fd_list (message, fd_list);
5481 if (G_UNLIKELY (_g_dbus_debug_call ()))
5483 _g_dbus_debug_print_lock ();
5484 g_print ("========================================================================\n"
5485 "GDBus-debug:Call:\n"
5486 " >>>> SYNC %s.%s()\n"
5488 " owned by name %s\n",
5492 bus_name != NULL ? bus_name : "(none)");
5493 _g_dbus_debug_print_unlock ();
5498 send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
5500 /* translate from one flavour of flags to another... */
5501 if (flags & CALL_FLAGS_INITIALIZING)
5502 send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
5504 reply = g_dbus_connection_send_message_with_reply_sync (connection,
5508 NULL, /* volatile guint32 *out_serial */
5512 if (G_UNLIKELY (_g_dbus_debug_call ()))
5514 _g_dbus_debug_print_lock ();
5515 g_print ("========================================================================\n"
5516 "GDBus-debug:Call:\n"
5517 " <<<< SYNC COMPLETE %s.%s()\n"
5523 g_print ("SUCCESS\n");
5527 g_print ("FAILED: %s\n",
5528 local_error->message);
5530 _g_dbus_debug_print_unlock ();
5536 *error = local_error;
5538 g_error_free (local_error);
5542 result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
5545 if (message != NULL)
5546 g_object_unref (message);
5548 g_object_unref (reply);
5553 /* ---------------------------------------------------------------------------------------------------- */
5556 * g_dbus_connection_call:
5557 * @connection: A #GDBusConnection.
5558 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5559 * @connection is not a message bus connection.
5560 * @object_path: Path of remote object.
5561 * @interface_name: D-Bus interface to invoke method on.
5562 * @method_name: The name of the method to invoke.
5563 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5564 * or %NULL if not passing parameters.
5565 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5566 * @flags: Flags from the #GDBusCallFlags enumeration.
5567 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5568 * timeout or %G_MAXINT for no timeout.
5569 * @cancellable: A #GCancellable or %NULL.
5570 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
5571 * satisfied or %NULL if you don't care about the result of the
5572 * method invocation.
5573 * @user_data: The data to pass to @callback.
5575 * Asynchronously invokes the @method_name method on the
5576 * @interface_name D-Bus interface on the remote object at
5577 * @object_path owned by @bus_name.
5579 * If @connection is closed then the operation will fail with
5580 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
5581 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
5582 * not compatible with the D-Bus protocol, the operation fails with
5583 * %G_IO_ERROR_INVALID_ARGUMENT.
5585 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
5586 * error will be raised if it does not match. Said another way, if you give a @reply_type
5587 * then any non-%NULL return value will be of this type.
5589 * If the @parameters #GVariant is floating, it is consumed. This allows
5590 * convenient 'inline' use of g_variant_new(), e.g.:
5592 * g_dbus_connection_call (connection,
5593 * "org.freedesktop.StringThings",
5594 * "/org/freedesktop/StringThings",
5595 * "org.freedesktop.StringThings",
5597 * g_variant_new ("(ss)",
5601 * G_DBUS_CALL_FLAGS_NONE,
5604 * (GAsyncReadyCallback) two_strings_done,
5608 * This is an asynchronous method. When the operation is finished, @callback will be invoked
5609 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
5610 * of the thread you are calling this method from. You can then call
5611 * g_dbus_connection_call_finish() to get the result of the operation.
5612 * See g_dbus_connection_call_sync() for the synchronous version of this
5618 g_dbus_connection_call (GDBusConnection *connection,
5619 const gchar *bus_name,
5620 const gchar *object_path,
5621 const gchar *interface_name,
5622 const gchar *method_name,
5623 GVariant *parameters,
5624 const GVariantType *reply_type,
5625 GDBusCallFlags flags,
5627 GCancellable *cancellable,
5628 GAsyncReadyCallback callback,
5631 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);
5635 * g_dbus_connection_call_finish:
5636 * @connection: A #GDBusConnection.
5637 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
5638 * @error: Return location for error or %NULL.
5640 * Finishes an operation started with g_dbus_connection_call().
5642 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5643 * return values. Free with g_variant_unref().
5648 g_dbus_connection_call_finish (GDBusConnection *connection,
5652 return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
5656 * g_dbus_connection_call_sync:
5657 * @connection: A #GDBusConnection.
5658 * @bus_name: A unique or well-known bus name.
5659 * @object_path: Path of remote object.
5660 * @interface_name: D-Bus interface to invoke method on.
5661 * @method_name: The name of the method to invoke.
5662 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5663 * or %NULL if not passing parameters.
5664 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5665 * @flags: Flags from the #GDBusCallFlags enumeration.
5666 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5667 * timeout or %G_MAXINT for no timeout.
5668 * @cancellable: A #GCancellable or %NULL.
5669 * @error: Return location for error or %NULL.
5671 * Synchronously invokes the @method_name method on the
5672 * @interface_name D-Bus interface on the remote object at
5673 * @object_path owned by @bus_name.
5675 * If @connection is closed then the operation will fail with
5676 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
5677 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
5678 * contains a value not compatible with the D-Bus protocol, the operation
5679 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
5681 * If @reply_type is non-%NULL then the reply will be checked for having
5682 * this type and an error will be raised if it does not match. Said
5683 * another way, if you give a @reply_type then any non-%NULL return
5684 * value will be of this type.
5686 * If the @parameters #GVariant is floating, it is consumed.
5687 * This allows convenient 'inline' use of g_variant_new(), e.g.:
5689 * g_dbus_connection_call_sync (connection,
5690 * "org.freedesktop.StringThings",
5691 * "/org/freedesktop/StringThings",
5692 * "org.freedesktop.StringThings",
5694 * g_variant_new ("(ss)",
5698 * G_DBUS_CALL_FLAGS_NONE,
5704 * The calling thread is blocked until a reply is received. See
5705 * g_dbus_connection_call() for the asynchronous version of
5708 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5709 * return values. Free with g_variant_unref().
5714 g_dbus_connection_call_sync (GDBusConnection *connection,
5715 const gchar *bus_name,
5716 const gchar *object_path,
5717 const gchar *interface_name,
5718 const gchar *method_name,
5719 GVariant *parameters,
5720 const GVariantType *reply_type,
5721 GDBusCallFlags flags,
5723 GCancellable *cancellable,
5726 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);
5729 /* ---------------------------------------------------------------------------------------------------- */
5734 * g_dbus_connection_call_with_unix_fd_list:
5735 * @connection: A #GDBusConnection.
5736 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5737 * @connection is not a message bus connection.
5738 * @object_path: Path of remote object.
5739 * @interface_name: D-Bus interface to invoke method on.
5740 * @method_name: The name of the method to invoke.
5741 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5742 * or %NULL if not passing parameters.
5743 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5744 * @flags: Flags from the #GDBusCallFlags enumeration.
5745 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5746 * timeout or %G_MAXINT for no timeout.
5747 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
5748 * @cancellable: A #GCancellable or %NULL.
5749 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
5750 * satisfied or %NULL if you don't * care about the result of the
5751 * method invocation.
5752 * @user_data: The data to pass to @callback.
5754 * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
5756 * This method is only available on UNIX.
5761 g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
5762 const gchar *bus_name,
5763 const gchar *object_path,
5764 const gchar *interface_name,
5765 const gchar *method_name,
5766 GVariant *parameters,
5767 const GVariantType *reply_type,
5768 GDBusCallFlags flags,
5770 GUnixFDList *fd_list,
5771 GCancellable *cancellable,
5772 GAsyncReadyCallback callback,
5775 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);
5779 * g_dbus_connection_call_with_unix_fd_list_finish:
5780 * @connection: A #GDBusConnection.
5781 * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.
5782 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list().
5783 * @error: Return location for error or %NULL.
5785 * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
5787 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5788 * return values. Free with g_variant_unref().
5793 g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
5794 GUnixFDList **out_fd_list,
5798 return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
5802 * g_dbus_connection_call_with_unix_fd_list_sync:
5803 * @connection: A #GDBusConnection.
5804 * @bus_name: A unique or well-known bus name.
5805 * @object_path: Path of remote object.
5806 * @interface_name: D-Bus interface to invoke method on.
5807 * @method_name: The name of the method to invoke.
5808 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5809 * or %NULL if not passing parameters.
5810 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5811 * @flags: Flags from the #GDBusCallFlags enumeration.
5812 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5813 * timeout or %G_MAXINT for no timeout.
5814 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
5815 * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.
5816 * @cancellable: A #GCancellable or %NULL.
5817 * @error: Return location for error or %NULL.
5819 * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
5821 * This method is only available on UNIX.
5823 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5824 * return values. Free with g_variant_unref().
5829 g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
5830 const gchar *bus_name,
5831 const gchar *object_path,
5832 const gchar *interface_name,
5833 const gchar *method_name,
5834 GVariant *parameters,
5835 const GVariantType *reply_type,
5836 GDBusCallFlags flags,
5838 GUnixFDList *fd_list,
5839 GUnixFDList **out_fd_list,
5840 GCancellable *cancellable,
5843 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);
5846 #endif /* G_OS_UNIX */
5848 /* ---------------------------------------------------------------------------------------------------- */
5850 struct ExportedSubtree
5854 GDBusConnection *connection;
5855 GDBusSubtreeVTable *vtable;
5856 GDBusSubtreeFlags flags;
5858 GMainContext *context;
5860 GDestroyNotify user_data_free_func;
5864 exported_subtree_free (ExportedSubtree *es)
5866 call_destroy_notify (es->context,
5867 es->user_data_free_func,
5870 g_main_context_unref (es->context);
5872 _g_dbus_subtree_vtable_free (es->vtable);
5873 g_free (es->object_path);
5877 /* called without lock held in the thread where the caller registered
5881 handle_subtree_introspect (GDBusConnection *connection,
5882 ExportedSubtree *es,
5883 GDBusMessage *message)
5887 GDBusMessage *reply;
5890 const gchar *sender;
5891 const gchar *requested_object_path;
5892 const gchar *requested_node;
5893 GDBusInterfaceInfo **interfaces;
5895 gchar **subnode_paths;
5896 gboolean has_properties_interface;
5897 gboolean has_introspectable_interface;
5901 requested_object_path = g_dbus_message_get_path (message);
5902 sender = g_dbus_message_get_sender (message);
5903 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
5905 s = g_string_new (NULL);
5906 introspect_append_header (s);
5908 /* Strictly we don't need the children in dynamic mode, but we avoid the
5909 * conditionals to preserve code clarity
5911 children = es->vtable->enumerate (es->connection,
5918 requested_node = strrchr (requested_object_path, '/') + 1;
5920 /* Assert existence of object if we are not dynamic */
5921 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
5922 !_g_strv_has_string ((const gchar * const *) children, requested_node))
5927 requested_node = NULL;
5930 interfaces = es->vtable->introspect (es->connection,
5935 if (interfaces != NULL)
5937 has_properties_interface = FALSE;
5938 has_introspectable_interface = FALSE;
5940 for (n = 0; interfaces[n] != NULL; n++)
5942 if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
5943 has_properties_interface = TRUE;
5944 else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
5945 has_introspectable_interface = TRUE;
5947 if (!has_properties_interface)
5948 g_string_append (s, introspect_properties_interface);
5949 if (!has_introspectable_interface)
5950 g_string_append (s, introspect_introspectable_interface);
5952 for (n = 0; interfaces[n] != NULL; n++)
5954 g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
5955 g_dbus_interface_info_unref (interfaces[n]);
5957 g_free (interfaces);
5960 /* then include <node> entries from the Subtree for the root */
5963 for (n = 0; children != NULL && children[n] != NULL; n++)
5964 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
5967 /* finally include nodes registered below us */
5968 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
5969 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
5970 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
5971 g_strfreev (subnode_paths);
5973 g_string_append (s, "</node>\n");
5975 reply = g_dbus_message_new_method_reply (message);
5976 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5977 g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5978 g_object_unref (reply);
5983 g_string_free (s, TRUE);
5984 g_strfreev (children);
5988 /* called without lock held in the thread where the caller registered
5992 handle_subtree_method_invocation (GDBusConnection *connection,
5993 ExportedSubtree *es,
5994 GDBusMessage *message)
5997 const gchar *sender;
5998 const gchar *interface_name;
5999 const gchar *member;
6000 const gchar *signature;
6001 const gchar *requested_object_path;
6002 const gchar *requested_node;
6004 GDBusInterfaceInfo *interface_info;
6005 const GDBusInterfaceVTable *interface_vtable;
6006 gpointer interface_user_data;
6008 GDBusInterfaceInfo **interfaces;
6009 gboolean is_property_get;
6010 gboolean is_property_set;
6011 gboolean is_property_get_all;
6016 requested_object_path = g_dbus_message_get_path (message);
6017 sender = g_dbus_message_get_sender (message);
6018 interface_name = g_dbus_message_get_interface (message);
6019 member = g_dbus_message_get_member (message);
6020 signature = g_dbus_message_get_signature (message);
6021 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6023 is_property_get = FALSE;
6024 is_property_set = FALSE;
6025 is_property_get_all = FALSE;
6026 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
6028 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
6029 is_property_get = TRUE;
6030 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
6031 is_property_set = TRUE;
6032 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
6033 is_property_get_all = TRUE;
6038 requested_node = strrchr (requested_object_path, '/') + 1;
6040 if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
6042 /* We don't want to dispatch to unenumerated
6043 * nodes, so ensure that the child exists.
6048 children = es->vtable->enumerate (es->connection,
6053 exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
6054 g_strfreev (children);
6062 requested_node = NULL;
6065 /* get introspection data for the node */
6066 interfaces = es->vtable->introspect (es->connection,
6068 requested_object_path,
6072 if (interfaces == NULL)
6075 interface_info = NULL;
6076 for (n = 0; interfaces[n] != NULL; n++)
6078 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6079 interface_info = interfaces[n];
6082 /* dispatch the call if the user wants to handle it */
6083 if (interface_info != NULL)
6085 /* figure out where to dispatch the method call */
6086 interface_user_data = NULL;
6087 interface_vtable = es->vtable->dispatch (es->connection,
6092 &interface_user_data,
6094 if (interface_vtable == NULL)
6097 CONNECTION_LOCK (connection);
6098 handled = validate_and_maybe_schedule_method_call (es->connection,
6105 interface_user_data);
6106 CONNECTION_UNLOCK (connection);
6108 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
6109 else if (is_property_get || is_property_set || is_property_get_all)
6111 if (is_property_get)
6112 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
6113 else if (is_property_set)
6114 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
6115 else if (is_property_get_all)
6116 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
6118 g_assert_not_reached ();
6120 /* see if the object supports this interface at all */
6121 for (n = 0; interfaces[n] != NULL; n++)
6123 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6124 interface_info = interfaces[n];
6127 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
6128 * claims it won't support the interface
6130 if (interface_info == NULL)
6132 GDBusMessage *reply;
6133 reply = g_dbus_message_new_method_error (message,
6134 "org.freedesktop.DBus.Error.InvalidArgs",
6135 _("No such interface `%s'"),
6137 g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6138 g_object_unref (reply);
6143 /* figure out where to dispatch the property get/set/getall calls */
6144 interface_user_data = NULL;
6145 interface_vtable = es->vtable->dispatch (es->connection,
6150 &interface_user_data,
6152 if (interface_vtable == NULL)
6154 g_warning ("The subtree introspection function indicates that '%s' "
6155 "is a valid interface name, but calling the dispatch "
6156 "function on that interface gave us NULL", interface_name);
6160 if (is_property_get || is_property_set)
6162 CONNECTION_LOCK (connection);
6163 handled = validate_and_maybe_schedule_property_getset (es->connection,
6171 interface_user_data);
6172 CONNECTION_UNLOCK (connection);
6174 else if (is_property_get_all)
6176 CONNECTION_LOCK (connection);
6177 handled = validate_and_maybe_schedule_property_get_all (es->connection,
6184 interface_user_data);
6185 CONNECTION_UNLOCK (connection);
6190 if (interfaces != NULL)
6192 for (n = 0; interfaces[n] != NULL; n++)
6193 g_dbus_interface_info_unref (interfaces[n]);
6194 g_free (interfaces);
6202 GDBusMessage *message;
6203 ExportedSubtree *es;
6204 } SubtreeDeferredData;
6207 subtree_deferred_data_free (SubtreeDeferredData *data)
6209 g_object_unref (data->message);
6213 /* called without lock held in the thread where the caller registered the subtree */
6215 process_subtree_vtable_message_in_idle_cb (gpointer _data)
6217 SubtreeDeferredData *data = _data;
6222 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
6223 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
6224 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
6225 handled = handle_subtree_introspect (data->es->connection,
6229 handled = handle_subtree_method_invocation (data->es->connection,
6235 CONNECTION_LOCK (data->es->connection);
6236 handled = handle_generic_unlocked (data->es->connection, data->message);
6237 CONNECTION_UNLOCK (data->es->connection);
6240 /* if we couldn't handle the request, just bail with the UnknownMethod error */
6243 GDBusMessage *reply;
6244 reply = g_dbus_message_new_method_error (data->message,
6245 "org.freedesktop.DBus.Error.UnknownMethod",
6246 _("Method `%s' on interface `%s' with signature `%s' does not exist"),
6247 g_dbus_message_get_member (data->message),
6248 g_dbus_message_get_interface (data->message),
6249 g_dbus_message_get_signature (data->message));
6250 g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6251 g_object_unref (reply);
6257 /* called in GDBusWorker thread with connection's lock held */
6259 subtree_message_func (GDBusConnection *connection,
6260 ExportedSubtree *es,
6261 GDBusMessage *message)
6263 GSource *idle_source;
6264 SubtreeDeferredData *data;
6266 data = g_new0 (SubtreeDeferredData, 1);
6267 data->message = g_object_ref (message);
6270 /* defer this call to an idle handler in the right thread */
6271 idle_source = g_idle_source_new ();
6272 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
6273 g_source_set_callback (idle_source,
6274 process_subtree_vtable_message_in_idle_cb,
6276 (GDestroyNotify) subtree_deferred_data_free);
6277 g_source_attach (idle_source, es->context);
6278 g_source_unref (idle_source);
6280 /* since we own the entire subtree, handlers for objects not in the subtree have been
6281 * tried already by libdbus-1 - so we just need to ensure that we're always going
6282 * to reply to the message
6288 * g_dbus_connection_register_subtree:
6289 * @connection: A #GDBusConnection.
6290 * @object_path: The object path to register the subtree at.
6291 * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
6292 * @flags: Flags used to fine tune the behavior of the subtree.
6293 * @user_data: Data to pass to functions in @vtable.
6294 * @user_data_free_func: Function to call when the subtree is unregistered.
6295 * @error: Return location for error or %NULL.
6297 * Registers a whole subtree of <quote>dynamic</quote> objects.
6299 * The @enumerate and @introspection functions in @vtable are used to
6300 * convey, to remote callers, what nodes exist in the subtree rooted
6303 * When handling remote calls into any node in the subtree, first the
6304 * @enumerate function is used to check if the node exists. If the node exists
6305 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
6306 * the @introspection function is used to check if the node supports the
6307 * requested method. If so, the @dispatch function is used to determine
6308 * where to dispatch the call. The collected #GDBusInterfaceVTable and
6309 * #gpointer will be used to call into the interface vtable for processing
6312 * All calls into user-provided code will be invoked in the <link
6313 * linkend="g-main-context-push-thread-default">thread-default main
6314 * loop</link> of the thread you are calling this method from.
6316 * If an existing subtree is already registered at @object_path or
6317 * then @error is set to #G_IO_ERROR_EXISTS.
6319 * Note that it is valid to register regular objects (using
6320 * g_dbus_connection_register_object()) in a subtree registered with
6321 * g_dbus_connection_register_subtree() - if so, the subtree handler
6322 * is tried as the last resort. One way to think about a subtree
6323 * handler is to consider it a <quote>fallback handler</quote>
6324 * for object paths not registered via g_dbus_connection_register_object()
6325 * or other bindings.
6327 * Note that @vtable will be copied so you cannot change it after
6330 * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
6332 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
6333 * that can be used with g_dbus_connection_unregister_subtree() .
6338 g_dbus_connection_register_subtree (GDBusConnection *connection,
6339 const gchar *object_path,
6340 const GDBusSubtreeVTable *vtable,
6341 GDBusSubtreeFlags flags,
6343 GDestroyNotify user_data_free_func,
6347 ExportedSubtree *es;
6349 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
6350 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
6351 g_return_val_if_fail (vtable != NULL, 0);
6352 g_return_val_if_fail (error == NULL || *error == NULL, 0);
6353 g_return_val_if_fail (check_initialized (connection), 0);
6357 CONNECTION_LOCK (connection);
6359 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6365 _("A subtree is already exported for %s"),
6370 es = g_new0 (ExportedSubtree, 1);
6371 es->object_path = g_strdup (object_path);
6372 es->connection = connection;
6374 es->vtable = _g_dbus_subtree_vtable_copy (vtable);
6376 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
6377 es->user_data = user_data;
6378 es->user_data_free_func = user_data_free_func;
6379 es->context = g_main_context_ref_thread_default ();
6381 g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
6382 g_hash_table_insert (connection->map_id_to_es,
6383 GUINT_TO_POINTER (es->id),
6389 CONNECTION_UNLOCK (connection);
6394 /* ---------------------------------------------------------------------------------------------------- */
6397 * g_dbus_connection_unregister_subtree:
6398 * @connection: A #GDBusConnection.
6399 * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
6401 * Unregisters a subtree.
6403 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
6408 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
6409 guint registration_id)
6411 ExportedSubtree *es;
6414 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
6415 g_return_val_if_fail (check_initialized (connection), FALSE);
6419 CONNECTION_LOCK (connection);
6421 es = g_hash_table_lookup (connection->map_id_to_es,
6422 GUINT_TO_POINTER (registration_id));
6426 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
6427 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
6432 CONNECTION_UNLOCK (connection);
6437 /* ---------------------------------------------------------------------------------------------------- */
6439 /* may be called in any thread, with connection's lock held */
6441 handle_generic_ping_unlocked (GDBusConnection *connection,
6442 const gchar *object_path,
6443 GDBusMessage *message)
6445 GDBusMessage *reply;
6446 reply = g_dbus_message_new_method_reply (message);
6447 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6448 g_object_unref (reply);
6451 /* may be called in any thread, with connection's lock held */
6453 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
6454 const gchar *object_path,
6455 GDBusMessage *message)
6457 GDBusMessage *reply;
6460 if (connection->machine_id == NULL)
6465 connection->machine_id = _g_dbus_get_machine_id (&error);
6466 if (connection->machine_id == NULL)
6468 reply = g_dbus_message_new_method_error_literal (message,
6469 "org.freedesktop.DBus.Error.Failed",
6471 g_error_free (error);
6477 reply = g_dbus_message_new_method_reply (message);
6478 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
6480 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6481 g_object_unref (reply);
6484 /* may be called in any thread, with connection's lock held */
6486 handle_generic_introspect_unlocked (GDBusConnection *connection,
6487 const gchar *object_path,
6488 GDBusMessage *message)
6493 GDBusMessage *reply;
6495 /* first the header */
6496 s = g_string_new (NULL);
6497 introspect_append_header (s);
6499 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
6500 for (n = 0; registered != NULL && registered[n] != NULL; n++)
6501 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
6502 g_strfreev (registered);
6503 g_string_append (s, "</node>\n");
6505 reply = g_dbus_message_new_method_reply (message);
6506 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6507 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6508 g_object_unref (reply);
6509 g_string_free (s, TRUE);
6512 /* may be called in any thread, with connection's lock held */
6514 handle_generic_unlocked (GDBusConnection *connection,
6515 GDBusMessage *message)
6518 const gchar *interface_name;
6519 const gchar *member;
6520 const gchar *signature;
6523 CONNECTION_ENSURE_LOCK (connection);
6527 interface_name = g_dbus_message_get_interface (message);
6528 member = g_dbus_message_get_member (message);
6529 signature = g_dbus_message_get_signature (message);
6530 path = g_dbus_message_get_path (message);
6532 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
6533 g_strcmp0 (member, "Introspect") == 0 &&
6534 g_strcmp0 (signature, "") == 0)
6536 handle_generic_introspect_unlocked (connection, path, message);
6539 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6540 g_strcmp0 (member, "Ping") == 0 &&
6541 g_strcmp0 (signature, "") == 0)
6543 handle_generic_ping_unlocked (connection, path, message);
6546 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6547 g_strcmp0 (member, "GetMachineId") == 0 &&
6548 g_strcmp0 (signature, "") == 0)
6550 handle_generic_get_machine_id_unlocked (connection, path, message);
6557 /* ---------------------------------------------------------------------------------------------------- */
6559 /* called in GDBusWorker thread with connection's lock held */
6561 distribute_method_call (GDBusConnection *connection,
6562 GDBusMessage *message)
6564 GDBusMessage *reply;
6566 ExportedSubtree *es;
6567 const gchar *object_path;
6568 const gchar *interface_name;
6569 const gchar *member;
6571 gchar *subtree_path;
6574 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
6576 interface_name = g_dbus_message_get_interface (message);
6577 member = g_dbus_message_get_member (message);
6578 path = g_dbus_message_get_path (message);
6579 subtree_path = g_strdup (path);
6580 needle = strrchr (subtree_path, '/');
6581 if (needle != NULL && needle != subtree_path)
6587 g_free (subtree_path);
6588 subtree_path = NULL;
6592 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
6594 _g_dbus_debug_print_lock ();
6595 g_print ("========================================================================\n"
6596 "GDBus-debug:Incoming:\n"
6597 " <<<< METHOD INVOCATION %s.%s()\n"
6599 " invoked by name %s\n"
6601 interface_name, member,
6603 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
6604 g_dbus_message_get_serial (message));
6605 _g_dbus_debug_print_unlock ();
6608 object_path = g_dbus_message_get_path (message);
6609 g_assert (object_path != NULL);
6611 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
6614 if (obj_message_func (connection, eo, message))
6618 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6621 if (subtree_message_func (connection, es, message))
6625 if (subtree_path != NULL)
6627 es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
6630 if (subtree_message_func (connection, es, message))
6635 if (handle_generic_unlocked (connection, message))
6638 /* if we end up here, the message has not been not handled - so return an error saying this */
6639 reply = g_dbus_message_new_method_error (message,
6640 "org.freedesktop.DBus.Error.UnknownMethod",
6641 _("No such interface `%s' on object at path %s"),
6644 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6645 g_object_unref (reply);
6648 g_free (subtree_path);
6651 /* ---------------------------------------------------------------------------------------------------- */
6653 /* Called in any user thread, with the message_bus_lock held. */
6655 message_bus_get_singleton (GBusType bus_type,
6659 const gchar *starter_bus;
6665 case G_BUS_TYPE_SESSION:
6666 ret = &the_session_bus;
6669 case G_BUS_TYPE_SYSTEM:
6670 ret = &the_system_bus;
6673 case G_BUS_TYPE_STARTER:
6674 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
6675 if (g_strcmp0 (starter_bus, "session") == 0)
6677 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
6680 else if (g_strcmp0 (starter_bus, "system") == 0)
6682 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
6687 if (starter_bus != NULL)
6691 G_IO_ERROR_INVALID_ARGUMENT,
6692 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
6693 " - unknown value `%s'"),
6698 g_set_error_literal (error,
6700 G_IO_ERROR_INVALID_ARGUMENT,
6701 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
6702 "variable is not set"));
6708 g_assert_not_reached ();
6716 /* Called in any user thread, without holding locks. */
6717 static GDBusConnection *
6718 get_uninitialized_connection (GBusType bus_type,
6719 GCancellable *cancellable,
6722 GWeakRef *singleton;
6723 GDBusConnection *ret;
6727 G_LOCK (message_bus_lock);
6728 singleton = message_bus_get_singleton (bus_type, error);
6729 if (singleton == NULL)
6732 ret = g_weak_ref_get (singleton);
6737 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
6738 if (address == NULL)
6740 ret = g_object_new (G_TYPE_DBUS_CONNECTION,
6742 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
6743 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
6744 "exit-on-close", TRUE,
6747 g_weak_ref_set (singleton, ret);
6751 g_assert (ret != NULL);
6754 G_UNLOCK (message_bus_lock);
6760 * @bus_type: A #GBusType.
6761 * @cancellable: A #GCancellable or %NULL.
6762 * @error: Return location for error or %NULL.
6764 * Synchronously connects to the message bus specified by @bus_type.
6765 * Note that the returned object may shared with other callers,
6766 * e.g. if two separate parts of a process calls this function with
6767 * the same @bus_type, they will share the same object.
6769 * This is a synchronous failable function. See g_bus_get() and
6770 * g_bus_get_finish() for the asynchronous version.
6772 * The returned object is a singleton, that is, shared with other
6773 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6774 * event that you need a private message bus connection, use
6775 * g_dbus_address_get_for_bus_sync() and
6776 * g_dbus_connection_new_for_address().
6778 * Note that the returned #GDBusConnection object will (usually) have
6779 * the #GDBusConnection:exit-on-close property set to %TRUE.
6781 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
6786 g_bus_get_sync (GBusType bus_type,
6787 GCancellable *cancellable,
6790 GDBusConnection *connection;
6792 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6794 connection = get_uninitialized_connection (bus_type, cancellable, error);
6795 if (connection == NULL)
6798 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
6800 g_object_unref (connection);
6809 bus_get_async_initable_cb (GObject *source_object,
6813 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
6817 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
6821 g_assert (error != NULL);
6822 g_simple_async_result_take_error (simple, error);
6823 g_object_unref (source_object);
6827 g_simple_async_result_set_op_res_gpointer (simple,
6831 g_simple_async_result_complete_in_idle (simple);
6832 g_object_unref (simple);
6837 * @bus_type: A #GBusType.
6838 * @cancellable: A #GCancellable or %NULL.
6839 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
6840 * @user_data: The data to pass to @callback.
6842 * Asynchronously connects to the message bus specified by @bus_type.
6844 * When the operation is finished, @callback will be invoked. You can
6845 * then call g_bus_get_finish() to get the result of the operation.
6847 * This is a asynchronous failable function. See g_bus_get_sync() for
6848 * the synchronous version.
6853 g_bus_get (GBusType bus_type,
6854 GCancellable *cancellable,
6855 GAsyncReadyCallback callback,
6858 GDBusConnection *connection;
6859 GSimpleAsyncResult *simple;
6862 simple = g_simple_async_result_new (NULL,
6866 g_simple_async_result_set_check_cancellable (simple, cancellable);
6869 connection = get_uninitialized_connection (bus_type, cancellable, &error);
6870 if (connection == NULL)
6872 g_assert (error != NULL);
6873 g_simple_async_result_take_error (simple, error);
6874 g_simple_async_result_complete_in_idle (simple);
6875 g_object_unref (simple);
6879 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
6882 bus_get_async_initable_cb,
6889 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
6890 * @error: Return location for error or %NULL.
6892 * Finishes an operation started with g_bus_get().
6894 * The returned object is a singleton, that is, shared with other
6895 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6896 * event that you need a private message bus connection, use
6897 * g_dbus_address_get_for_bus_sync() and
6898 * g_dbus_connection_new_for_address().
6900 * Note that the returned #GDBusConnection object will (usually) have
6901 * the #GDBusConnection:exit-on-close property set to %TRUE.
6903 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
6908 g_bus_get_finish (GAsyncResult *res,
6911 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
6913 GDBusConnection *ret;
6915 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6917 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
6921 if (g_simple_async_result_propagate_error (simple, error))
6924 object = g_simple_async_result_get_op_res_gpointer (simple);
6925 g_assert (object != NULL);
6926 ret = g_object_ref (G_DBUS_CONNECTION (object));
6932 /* ---------------------------------------------------------------------------------------------------- */