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, see <http://www.gnu.org/licenses/>.
18 * Author: David Zeuthen <davidz@redhat.com>
24 * - would be nice to expose GDBusAuthMechanism and an extension point
26 * - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
27 * the mechanism VFuncs need to be able to set an error.
29 * - Need to document other mechanisms/sources for determining the D-Bus
30 * address of a well-known bus.
32 * - e.g. on Win32 we need code like from here
34 * http://cgit.freedesktop.org/~david/gdbus-standalone/tree/gdbus/gdbusaddress.c#n900
36 * that was never copied over here because it originally was copy-paste
37 * from the GPLv2 / AFL 2.1 libdbus sources.
39 * - on OS X we need to look in launchd for the address
41 * https://bugs.freedesktop.org/show_bug.cgi?id=14259
43 * - on X11 we need to look in a X11 property on the X server
44 * - (we can also just use dbus-launch(1) from the D-Bus
47 * - (ideally) this requires D-Bus spec work because none of
48 * this has never really been specced out properly (except
51 * - Related to the above, we also need to be able to launch a message bus
52 * instance.... Since we don't want to write our own bus daemon we should
53 * launch dbus-daemon(1) (thus: Win32 and OS X need to bundle it)
55 * - probably want a G_DBUS_NONCE_TCP_TMPDIR environment variable
56 * to specify where the nonce is stored. This will allow people to use
57 * G_DBUS_NONCE_TCP_TMPDIR=/mnt/secure.company.server/dbus-nonce-dir
58 * to easily achieve secure RPC via nonce-tcp.
60 * - need to expose an extension point for resolving D-Bus address and
61 * turning them into GIOStream objects. This will allow us to implement
62 * e.g. X11 D-Bus transports without dlopen()'ing or linking against
64 * - see g_dbus_address_connect() in gdbusaddress.c
66 * - would be cute to use kernel-specific APIs to resolve fds for
67 * debug output when using G_DBUS_DEBUG=message, e.g. in addition to
69 * fd 21: dev=8:1,mode=0100644,ino=1171231,uid=0,gid=0,rdev=0:0,size=234,atime=1273070640,mtime=1267126160,ctime=1267126160
71 * maybe we can show more information about what fd 21 really is.
72 * Ryan suggests looking in /proc/self/fd for clues / symlinks!
73 * Initial experiments on Linux 2.6 suggests that the symlink looks
78 * e.g. not of much use.
80 * - GDBus High-Level docs
81 * - Proxy: properties, signals...
82 * - Connection: IOStream based, ::close, connection setup steps
83 * mainloop integration, threading
84 * - Differences from libdbus (extend "Migrating from")
85 * - the message handling thread
86 * - Using GVariant instead of GValue
87 * - Explain why the high-level API is a good thing and what
88 * kind of pitfalls it avoids
89 * - Export objects before claiming names
90 * - Talk about auto-starting services (cf. GBusNameWatcherFlags)
92 * - use abstract sockets in test code
93 * - right now it doesn't work, dbus-daemon(1) fails with
95 * /gdbus/connection/filter: Failed to start message bus: Failed to bind
96 * socket "/tmp/g-dbus-tests-pid-28531": Address already in use
97 * ** WARNING **: Error reading address from dbus daemon, 0 bytes read
107 #include "gdbusauth.h"
108 #include "gdbusutils.h"
109 #include "gdbusaddress.h"
110 #include "gdbusmessage.h"
111 #include "gdbusconnection.h"
112 #include "gdbuserror.h"
113 #include "gioenumtypes.h"
114 #include "gdbusintrospection.h"
115 #include "gdbusmethodinvocation.h"
116 #include "gdbusprivate.h"
117 #include "gdbusauthobserver.h"
118 #include "ginitable.h"
119 #include "gasyncinitable.h"
120 #include "giostream.h"
121 #include "gasyncresult.h"
125 #include "gunixconnection.h"
126 #include "gunixfdmessage.h"
129 #include "glibintl.h"
132 * SECTION:gdbusconnection
133 * @short_description: D-Bus Connections
134 * @include: gio/gio.h
136 * The #GDBusConnection type is used for D-Bus connections to remote
137 * peers such as a message buses. It is a low-level API that offers a
138 * lot of flexibility. For instance, it lets you establish a connection
139 * over any transport that can by represented as an #GIOStream.
141 * This class is rarely used directly in D-Bus clients. If you are writing
142 * a D-Bus client, it is often easier to use the g_bus_own_name(),
143 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
145 * As an exception to the usual GLib rule that a particular object must not
146 * be used by two threads at the same time, #GDBusConnection's methods may be
147 * called from any thread. This is so that g_bus_get() and g_bus_get_sync()
148 * can safely return the same #GDBusConnection when called from any thread.
150 * Most of the ways to obtain a #GDBusConnection automatically initialize it
151 * (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
152 * g_bus_get(), and the synchronous versions of those methods, give you an
153 * initialized connection. Language bindings for GIO should use
154 * g_initable_new() or g_async_initable_new_async(), which also initialize the
157 * If you construct an uninitialized #GDBusConnection, such as via
158 * g_object_new(), you must initialize it via g_initable_init() or
159 * g_async_initable_init_async() before using its methods or properties.
160 * Calling methods or accessing properties on a #GDBusConnection that has not
161 * completed initialization successfully is considered to be invalid, and leads
162 * to undefined behaviour. In particular, if initialization fails with a
163 * #GError, the only valid thing you can do with that #GDBusConnection is to
164 * free it with g_object_unref().
166 * ## An example D-Bus server # {#gdbus-server}
168 * Here is an example for a D-Bus server:
169 * [gdbus-example-server.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-server.c)
171 * ## An example for exporting a subtree # {#gdbus-subtree-server}
173 * Here is an example for exporting a subtree:
174 * [gdbus-example-subtree.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-subtree.c)
176 * ## An example for file descriptor passing # {#gdbus-unix-fd-client}
178 * Here is an example for passing UNIX file descriptors:
179 * [gdbus-unix-fd-client.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-unix-fd-client.c)
181 * ## An example for exporting a GObject # {#gdbus-export}
183 * Here is an example for exporting a #GObject:
184 * [gdbus-example-export.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-export.c)
187 /* ---------------------------------------------------------------------------------------------------- */
189 typedef struct _GDBusConnectionClass GDBusConnectionClass;
192 * GDBusConnectionClass:
193 * @closed: Signal class handler for the #GDBusConnection::closed signal.
195 * Class structure for #GDBusConnection.
199 struct _GDBusConnectionClass
202 GObjectClass parent_class;
206 void (*closed) (GDBusConnection *connection,
207 gboolean remote_peer_vanished,
211 G_LOCK_DEFINE_STATIC (message_bus_lock);
213 static GWeakRef the_session_bus;
214 static GWeakRef the_system_bus;
216 /* Extra pseudo-member of GDBusSendMessageFlags.
217 * Set by initable_init() to indicate that despite not being initialized yet,
218 * enough of the only-valid-after-init members are set that we can send a
219 * message, and we're being called from its thread, so no memory barrier is
220 * required before accessing them.
222 #define SEND_MESSAGE_FLAGS_INITIALIZING (1<<31)
224 /* Same as SEND_MESSAGE_FLAGS_INITIALIZING, but in GDBusCallFlags */
225 #define CALL_FLAGS_INITIALIZING (1<<31)
227 /* ---------------------------------------------------------------------------------------------------- */
231 GDestroyNotify callback;
233 GMainContext *context;
234 } CallDestroyNotifyData;
237 call_destroy_notify_data_in_idle (gpointer user_data)
239 CallDestroyNotifyData *data = user_data;
240 data->callback (data->user_data);
245 call_destroy_notify_data_free (CallDestroyNotifyData *data)
247 if (data->context != NULL)
248 g_main_context_unref (data->context);
253 * call_destroy_notify: <internal>
254 * @context: (allow-none): A #GMainContext or %NULL.
255 * @callback: (allow-none): A #GDestroyNotify or %NULL.
256 * @user_data: Data to pass to @callback.
258 * Schedules @callback to run in @context.
261 call_destroy_notify (GMainContext *context,
262 GDestroyNotify callback,
265 GSource *idle_source;
266 CallDestroyNotifyData *data;
268 if (callback == NULL)
271 data = g_new0 (CallDestroyNotifyData, 1);
272 data->callback = callback;
273 data->user_data = user_data;
274 data->context = context;
275 if (data->context != NULL)
276 g_main_context_ref (data->context);
278 idle_source = g_idle_source_new ();
279 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
280 g_source_set_callback (idle_source,
281 call_destroy_notify_data_in_idle,
283 (GDestroyNotify) call_destroy_notify_data_free);
284 g_source_set_name (idle_source, "[gio] call_destroy_notify_data_in_idle");
285 g_source_attach (idle_source, data->context);
286 g_source_unref (idle_source);
292 /* ---------------------------------------------------------------------------------------------------- */
295 _g_strv_has_string (const gchar* const *haystack,
300 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
302 if (g_strcmp0 (haystack[n], needle) == 0)
308 /* ---------------------------------------------------------------------------------------------------- */
311 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
313 // TODO: for some reason this doesn't work on Windows
314 #define CONNECTION_ENSURE_LOCK(obj) do { \
315 if (G_UNLIKELY (g_mutex_trylock(&(obj)->lock))) \
317 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
318 "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
323 #define CONNECTION_LOCK(obj) do { \
324 g_mutex_lock (&(obj)->lock); \
327 #define CONNECTION_UNLOCK(obj) do { \
328 g_mutex_unlock (&(obj)->lock); \
331 /* Flags in connection->atomic_flags */
333 FLAG_INITIALIZED = 1 << 0,
334 FLAG_EXIT_ON_CLOSE = 1 << 1,
341 * The #GDBusConnection structure contains only private data and
342 * should only be accessed using the provided API.
346 struct _GDBusConnection
349 GObject parent_instance;
351 /* ------------------------------------------------------------------------ */
352 /* -- General object state ------------------------------------------------ */
353 /* ------------------------------------------------------------------------ */
355 /* General-purpose lock for most fields */
358 /* A lock used in the init() method of the GInitable interface - see comments
359 * in initable_init() for why a separate lock is needed.
361 * If you need both @lock and @init_lock, you must take @init_lock first.
365 /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
366 * someone calls org.freedesktop.DBus.Peer.GetMachineId(). Protected by @lock.
370 /* The underlying stream used for communication
371 * Read-only after initable_init(), so it may be read if you either
372 * hold @init_lock or check for initialization first.
376 /* The object used for authentication (if any).
377 * Read-only after initable_init(), so it may be read if you either
378 * hold @init_lock or check for initialization first.
382 /* Last serial used. Protected by @lock. */
385 /* The object used to send/receive messages.
386 * Read-only after initable_init(), so it may be read if you either
387 * hold @init_lock or check for initialization first.
391 /* If connected to a message bus, this contains the unique name assigned to
392 * us by the bus (e.g. ":1.42").
393 * Read-only after initable_init(), so it may be read if you either
394 * hold @init_lock or check for initialization first.
396 gchar *bus_unique_name;
398 /* The GUID returned by the other side if we authenticed as a client or
399 * the GUID to use if authenticating as a server.
400 * Read-only after initable_init(), so it may be read if you either
401 * hold @init_lock or check for initialization first.
405 /* FLAG_INITIALIZED is set exactly when initable_init() has finished running.
406 * Inspect @initialization_error to see whether it succeeded or failed.
408 * FLAG_EXIT_ON_CLOSE is the exit-on-close property.
410 * FLAG_CLOSED is the closed property. It may be read at any time, but
411 * may only be written while holding @lock.
413 volatile gint atomic_flags;
415 /* If the connection could not be established during initable_init(),
416 * this GError will be set.
417 * Read-only after initable_init(), so it may be read if you either
418 * hold @init_lock or check for initialization first.
420 GError *initialization_error;
422 /* The result of g_main_context_ref_thread_default() when the object
423 * was created (the GObject _init() function) - this is used for delivery
424 * of the :closed GObject signal.
426 * Only set in the GObject init function, so no locks are needed.
428 GMainContext *main_context_at_construction;
430 /* Read-only construct properties, no locks needed */
432 GDBusConnectionFlags flags;
434 /* Map used for managing method replies, protected by @lock */
435 GHashTable *map_method_serial_to_task; /* guint32 -> GTask* */
437 /* Maps used for managing signal subscription, protected by @lock */
438 GHashTable *map_rule_to_signal_data; /* match rule (gchar*) -> SignalData */
439 GHashTable *map_id_to_signal_data; /* id (guint) -> SignalData */
440 GHashTable *map_sender_unique_name_to_signal_data_array; /* unique sender (gchar*) -> GPtrArray* of SignalData */
442 /* Maps used for managing exported objects and subtrees,
445 GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
446 GHashTable *map_id_to_ei; /* guint -> ExportedInterface* */
447 GHashTable *map_object_path_to_es; /* gchar* -> ExportedSubtree* */
448 GHashTable *map_id_to_es; /* guint -> ExportedSubtree* */
450 /* Map used for storing last used serials for each thread, protected by @lock */
451 GHashTable *map_thread_to_last_serial;
453 /* Structure used for message filters, protected by @lock */
456 /* Capabilities negotiated during authentication
457 * Read-only after initable_init(), so it may be read without holding a
458 * lock, if you check for initialization first.
460 GDBusCapabilityFlags capabilities;
462 /* Protected by @init_lock */
463 GDBusAuthObserver *authentication_observer;
465 /* Read-only after initable_init(), so it may be read if you either
466 * hold @init_lock or check for initialization first.
468 GCredentials *credentials;
470 /* set to TRUE when finalizing */
474 typedef struct ExportedObject ExportedObject;
475 static void exported_object_free (ExportedObject *eo);
477 typedef struct ExportedSubtree ExportedSubtree;
478 static void exported_subtree_free (ExportedSubtree *es);
496 PROP_CAPABILITY_FLAGS,
497 PROP_AUTHENTICATION_OBSERVER,
500 static void distribute_signals (GDBusConnection *connection,
501 GDBusMessage *message);
503 static void distribute_method_call (GDBusConnection *connection,
504 GDBusMessage *message);
506 static gboolean handle_generic_unlocked (GDBusConnection *connection,
507 GDBusMessage *message);
510 static void purge_all_signal_subscriptions (GDBusConnection *connection);
511 static void purge_all_filters (GDBusConnection *connection);
513 static void schedule_method_call (GDBusConnection *connection,
514 GDBusMessage *message,
515 guint registration_id,
516 guint subtree_registration_id,
517 const GDBusInterfaceInfo *interface_info,
518 const GDBusMethodInfo *method_info,
519 const GDBusPropertyInfo *property_info,
520 GVariant *parameters,
521 const GDBusInterfaceVTable *vtable,
522 GMainContext *main_context,
525 #define _G_ENSURE_LOCK(name) do { \
526 if (G_UNLIKELY (G_TRYLOCK(name))) \
528 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
529 "_G_ENSURE_LOCK: Lock '" #name "' is not locked"); \
533 static guint signals[LAST_SIGNAL] = { 0 };
535 static void initable_iface_init (GInitableIface *initable_iface);
536 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
538 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
539 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
540 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
544 * Check that all members of @connection that can only be accessed after
545 * the connection is initialized can safely be accessed. If not,
546 * log a critical warning. This function is a memory barrier.
548 * Returns: %TRUE if initialized
551 check_initialized (GDBusConnection *connection)
553 /* The access to @atomic_flags isn't conditional, so that this function
554 * provides a memory barrier for thread-safety even if checks are disabled.
555 * (If you don't want this stricter guarantee, you can call
556 * g_return_if_fail (check_initialized (c)).)
558 * This isn't strictly necessary now that we've decided use of an
559 * uninitialized GDBusConnection is undefined behaviour, but it seems
560 * better to be as deterministic as is feasible.
562 * (Anything that could suffer a crash from seeing undefined values
563 * must have a race condition - thread A initializes the connection while
564 * thread B calls a method without initialization, hoping that thread A will
565 * win the race - so its behaviour is undefined anyway.)
567 gint flags = g_atomic_int_get (&connection->atomic_flags);
569 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
571 /* We can safely access this, due to the memory barrier above */
572 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
578 MAY_BE_UNINITIALIZED = (1<<1)
579 } CheckUnclosedFlags;
582 * Check the same thing as check_initialized(), and also that the
583 * connection is not closed. If the connection is uninitialized,
584 * raise a critical warning (it's programmer error); if it's closed,
585 * raise a recoverable GError (it's a runtime error).
587 * This function is a memory barrier.
589 * Returns: %TRUE if initialized and not closed
592 check_unclosed (GDBusConnection *connection,
593 CheckUnclosedFlags check,
596 /* check_initialized() is effectively inlined, so we don't waste time
597 * doing two memory barriers
599 gint flags = g_atomic_int_get (&connection->atomic_flags);
601 if (!(check & MAY_BE_UNINITIALIZED))
603 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
604 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
607 if (flags & FLAG_CLOSED)
609 g_set_error_literal (error,
612 _("The connection is closed"));
619 static GHashTable *alive_connections = NULL;
622 g_dbus_connection_dispose (GObject *object)
624 GDBusConnection *connection = G_DBUS_CONNECTION (object);
626 G_LOCK (message_bus_lock);
627 CONNECTION_LOCK (connection);
628 if (connection->worker != NULL)
630 _g_dbus_worker_stop (connection->worker);
631 connection->worker = NULL;
632 if (alive_connections != NULL)
633 g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
637 if (alive_connections != NULL)
638 g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
640 CONNECTION_UNLOCK (connection);
641 G_UNLOCK (message_bus_lock);
643 if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
644 G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
648 g_dbus_connection_finalize (GObject *object)
650 GDBusConnection *connection = G_DBUS_CONNECTION (object);
652 connection->finalizing = TRUE;
654 purge_all_signal_subscriptions (connection);
656 purge_all_filters (connection);
657 g_ptr_array_unref (connection->filters);
659 if (connection->authentication_observer != NULL)
660 g_object_unref (connection->authentication_observer);
662 if (connection->auth != NULL)
663 g_object_unref (connection->auth);
665 if (connection->credentials)
666 g_object_unref (connection->credentials);
668 if (connection->stream != NULL)
670 g_object_unref (connection->stream);
671 connection->stream = NULL;
674 g_free (connection->address);
676 g_free (connection->guid);
677 g_free (connection->bus_unique_name);
679 if (connection->initialization_error != NULL)
680 g_error_free (connection->initialization_error);
682 g_hash_table_unref (connection->map_method_serial_to_task);
684 g_hash_table_unref (connection->map_rule_to_signal_data);
685 g_hash_table_unref (connection->map_id_to_signal_data);
686 g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
688 g_hash_table_unref (connection->map_id_to_ei);
689 g_hash_table_unref (connection->map_object_path_to_eo);
690 g_hash_table_unref (connection->map_id_to_es);
691 g_hash_table_unref (connection->map_object_path_to_es);
693 g_hash_table_unref (connection->map_thread_to_last_serial);
695 g_main_context_unref (connection->main_context_at_construction);
697 g_free (connection->machine_id);
699 g_mutex_clear (&connection->init_lock);
700 g_mutex_clear (&connection->lock);
702 G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
705 /* called in any user thread, with the connection's lock not held */
707 g_dbus_connection_get_property (GObject *object,
712 GDBusConnection *connection = G_DBUS_CONNECTION (object);
717 g_value_set_object (value, g_dbus_connection_get_stream (connection));
721 g_value_set_string (value, g_dbus_connection_get_guid (connection));
724 case PROP_UNIQUE_NAME:
725 g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
729 g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
732 case PROP_EXIT_ON_CLOSE:
733 g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
736 case PROP_CAPABILITY_FLAGS:
737 g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
741 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
746 /* called in any user thread, with the connection's lock not held */
748 g_dbus_connection_set_property (GObject *object,
753 GDBusConnection *connection = G_DBUS_CONNECTION (object);
758 connection->stream = g_value_dup_object (value);
762 connection->guid = g_value_dup_string (value);
766 connection->address = g_value_dup_string (value);
770 connection->flags = g_value_get_flags (value);
773 case PROP_EXIT_ON_CLOSE:
774 g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
777 case PROP_AUTHENTICATION_OBSERVER:
778 connection->authentication_observer = g_value_dup_object (value);
782 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
787 /* Base-class implementation of GDBusConnection::closed.
789 * Called in a user thread, by the main context that was thread-default when
790 * the object was constructed.
793 g_dbus_connection_real_closed (GDBusConnection *connection,
794 gboolean remote_peer_vanished,
797 gint flags = g_atomic_int_get (&connection->atomic_flags);
799 /* Because atomic int access is a memory barrier, we can safely read
800 * initialization_error without a lock, as long as we do it afterwards.
802 if (remote_peer_vanished &&
803 (flags & FLAG_EXIT_ON_CLOSE) != 0 &&
804 (flags & FLAG_INITIALIZED) != 0 &&
805 connection->initialization_error == NULL)
812 g_dbus_connection_class_init (GDBusConnectionClass *klass)
814 GObjectClass *gobject_class;
816 gobject_class = G_OBJECT_CLASS (klass);
818 gobject_class->finalize = g_dbus_connection_finalize;
819 gobject_class->dispose = g_dbus_connection_dispose;
820 gobject_class->set_property = g_dbus_connection_set_property;
821 gobject_class->get_property = g_dbus_connection_get_property;
823 klass->closed = g_dbus_connection_real_closed;
826 * GDBusConnection:stream:
828 * The underlying #GIOStream used for I/O.
830 * If this is passed on construction and is a #GSocketConnection,
831 * then the corresponding #GSocket will be put into non-blocking mode.
833 * While the #GDBusConnection is active, it will interact with this
834 * stream from a worker thread, so it is not safe to interact with
835 * the stream directly.
839 g_object_class_install_property (gobject_class,
841 g_param_spec_object ("stream",
843 P_("The underlying streams used for I/O"),
847 G_PARAM_CONSTRUCT_ONLY |
848 G_PARAM_STATIC_NAME |
849 G_PARAM_STATIC_BLURB |
850 G_PARAM_STATIC_NICK));
853 * GDBusConnection:address:
855 * A D-Bus address specifying potential endpoints that can be used
856 * when establishing the connection.
860 g_object_class_install_property (gobject_class,
862 g_param_spec_string ("address",
864 P_("D-Bus address specifying potential socket endpoints"),
867 G_PARAM_CONSTRUCT_ONLY |
868 G_PARAM_STATIC_NAME |
869 G_PARAM_STATIC_BLURB |
870 G_PARAM_STATIC_NICK));
873 * GDBusConnection:flags:
875 * Flags from the #GDBusConnectionFlags enumeration.
879 g_object_class_install_property (gobject_class,
881 g_param_spec_flags ("flags",
884 G_TYPE_DBUS_CONNECTION_FLAGS,
885 G_DBUS_CONNECTION_FLAGS_NONE,
887 G_PARAM_CONSTRUCT_ONLY |
888 G_PARAM_STATIC_NAME |
889 G_PARAM_STATIC_BLURB |
890 G_PARAM_STATIC_NICK));
893 * GDBusConnection:guid:
895 * The GUID of the peer performing the role of server when
898 * If you are constructing a #GDBusConnection and pass
899 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
900 * #GDBusConnection:flags property then you MUST also set this
901 * property to a valid guid.
903 * If you are constructing a #GDBusConnection and pass
904 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
905 * #GDBusConnection:flags property you will be able to read the GUID
906 * of the other peer here after the connection has been successfully
911 g_object_class_install_property (gobject_class,
913 g_param_spec_string ("guid",
915 P_("GUID of the server peer"),
919 G_PARAM_CONSTRUCT_ONLY |
920 G_PARAM_STATIC_NAME |
921 G_PARAM_STATIC_BLURB |
922 G_PARAM_STATIC_NICK));
925 * GDBusConnection:unique-name:
927 * The unique name as assigned by the message bus or %NULL if the
928 * connection is not open or not a message bus connection.
932 g_object_class_install_property (gobject_class,
934 g_param_spec_string ("unique-name",
936 P_("Unique name of bus connection"),
939 G_PARAM_STATIC_NAME |
940 G_PARAM_STATIC_BLURB |
941 G_PARAM_STATIC_NICK));
944 * GDBusConnection:closed:
946 * A boolean specifying whether the connection has been closed.
950 g_object_class_install_property (gobject_class,
952 g_param_spec_boolean ("closed",
954 P_("Whether the connection is closed"),
957 G_PARAM_STATIC_NAME |
958 G_PARAM_STATIC_BLURB |
959 G_PARAM_STATIC_NICK));
962 * GDBusConnection:exit-on-close:
964 * A boolean specifying whether the process will be terminated (by
965 * calling `raise(SIGTERM)`) if the connection is closed by the
968 * Note that #GDBusConnection objects returned by g_bus_get_finish()
969 * and g_bus_get_sync() will (usually) have this property set to %TRUE.
973 g_object_class_install_property (gobject_class,
975 g_param_spec_boolean ("exit-on-close",
977 P_("Whether the process is terminated when the connection is closed"),
981 G_PARAM_STATIC_NAME |
982 G_PARAM_STATIC_BLURB |
983 G_PARAM_STATIC_NICK));
986 * GDBusConnection:capabilities:
988 * Flags from the #GDBusCapabilityFlags enumeration
989 * representing connection features negotiated with the other peer.
993 g_object_class_install_property (gobject_class,
994 PROP_CAPABILITY_FLAGS,
995 g_param_spec_flags ("capabilities",
998 G_TYPE_DBUS_CAPABILITY_FLAGS,
999 G_DBUS_CAPABILITY_FLAGS_NONE,
1001 G_PARAM_STATIC_NAME |
1002 G_PARAM_STATIC_BLURB |
1003 G_PARAM_STATIC_NICK));
1006 * GDBusConnection:authentication-observer:
1008 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
1012 g_object_class_install_property (gobject_class,
1013 PROP_AUTHENTICATION_OBSERVER,
1014 g_param_spec_object ("authentication-observer",
1015 P_("Authentication Observer"),
1016 P_("Object used to assist in the authentication process"),
1017 G_TYPE_DBUS_AUTH_OBSERVER,
1019 G_PARAM_CONSTRUCT_ONLY |
1020 G_PARAM_STATIC_NAME |
1021 G_PARAM_STATIC_BLURB |
1022 G_PARAM_STATIC_NICK));
1025 * GDBusConnection::closed:
1026 * @connection: the #GDBusConnection emitting the signal
1027 * @remote_peer_vanished: %TRUE if @connection is closed because the
1028 * remote peer closed its end of the connection
1029 * @error: (allow-none): a #GError with more details about the event or %NULL
1031 * Emitted when the connection is closed.
1033 * The cause of this event can be
1035 * - If g_dbus_connection_close() is called. In this case
1036 * @remote_peer_vanished is set to %FALSE and @error is %NULL.
1038 * - If the remote peer closes the connection. In this case
1039 * @remote_peer_vanished is set to %TRUE and @error is set.
1041 * - If the remote peer sends invalid or malformed data. In this
1042 * case @remote_peer_vanished is set to %FALSE and @error is set.
1044 * Upon receiving this signal, you should give up your reference to
1045 * @connection. You are guaranteed that this signal is emitted only
1050 signals[CLOSED_SIGNAL] = g_signal_new ("closed",
1051 G_TYPE_DBUS_CONNECTION,
1053 G_STRUCT_OFFSET (GDBusConnectionClass, closed),
1064 g_dbus_connection_init (GDBusConnection *connection)
1066 g_mutex_init (&connection->lock);
1067 g_mutex_init (&connection->init_lock);
1069 connection->map_method_serial_to_task = g_hash_table_new (g_direct_hash, g_direct_equal);
1071 connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
1073 connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
1075 connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
1078 (GDestroyNotify) g_ptr_array_unref);
1080 connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
1083 (GDestroyNotify) exported_object_free);
1085 connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
1088 connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
1091 (GDestroyNotify) exported_subtree_free);
1093 connection->map_id_to_es = g_hash_table_new (g_direct_hash,
1096 connection->map_thread_to_last_serial = g_hash_table_new (g_direct_hash,
1099 connection->main_context_at_construction = g_main_context_ref_thread_default ();
1101 connection->filters = g_ptr_array_new ();
1105 * g_dbus_connection_get_stream:
1106 * @connection: a #GDBusConnection
1108 * Gets the underlying stream used for IO.
1110 * While the #GDBusConnection is active, it will interact with this
1111 * stream from a worker thread, so it is not safe to interact with
1112 * the stream directly.
1114 * Returns: (transfer none): the stream used for IO
1119 g_dbus_connection_get_stream (GDBusConnection *connection)
1121 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1123 /* do not use g_return_val_if_fail(), we want the memory barrier */
1124 if (!check_initialized (connection))
1127 return connection->stream;
1131 * g_dbus_connection_start_message_processing:
1132 * @connection: a #GDBusConnection
1134 * If @connection was created with
1135 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
1136 * starts processing messages. Does nothing on if @connection wasn't
1137 * created with this flag or if the method has already been called.
1142 g_dbus_connection_start_message_processing (GDBusConnection *connection)
1144 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1146 /* do not use g_return_val_if_fail(), we want the memory barrier */
1147 if (!check_initialized (connection))
1150 g_assert (connection->worker != NULL);
1151 _g_dbus_worker_unfreeze (connection->worker);
1155 * g_dbus_connection_is_closed:
1156 * @connection: a #GDBusConnection
1158 * Gets whether @connection is closed.
1160 * Returns: %TRUE if the connection is closed, %FALSE otherwise
1165 g_dbus_connection_is_closed (GDBusConnection *connection)
1169 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1171 flags = g_atomic_int_get (&connection->atomic_flags);
1173 return (flags & FLAG_CLOSED) ? TRUE : FALSE;
1177 * g_dbus_connection_get_capabilities:
1178 * @connection: a #GDBusConnection
1180 * Gets the capabilities negotiated with the remote peer
1182 * Returns: zero or more flags from the #GDBusCapabilityFlags enumeration
1186 GDBusCapabilityFlags
1187 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1189 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1191 /* do not use g_return_val_if_fail(), we want the memory barrier */
1192 if (!check_initialized (connection))
1193 return G_DBUS_CAPABILITY_FLAGS_NONE;
1195 return connection->capabilities;
1198 /* ---------------------------------------------------------------------------------------------------- */
1200 /* Called in a temporary thread without holding locks. */
1202 flush_in_thread_func (GTask *task,
1203 gpointer source_object,
1205 GCancellable *cancellable)
1207 GError *error = NULL;
1209 if (g_dbus_connection_flush_sync (source_object,
1212 g_task_return_boolean (task, TRUE);
1214 g_task_return_error (task, error);
1218 * g_dbus_connection_flush:
1219 * @connection: a #GDBusConnection
1220 * @cancellable: (allow-none): a #GCancellable or %NULL
1221 * @callback: (allow-none): a #GAsyncReadyCallback to call when the
1222 * request is satisfied or %NULL if you don't care about the result
1223 * @user_data: The data to pass to @callback
1225 * Asynchronously flushes @connection, that is, writes all queued
1226 * outgoing message to the transport and then flushes the transport
1227 * (using g_output_stream_flush_async()). This is useful in programs
1228 * that wants to emit a D-Bus signal and then exit immediately. Without
1229 * flushing the connection, there is no guaranteed that the message has
1230 * been sent to the networking buffers in the OS kernel.
1232 * This is an asynchronous method. When the operation is finished,
1233 * @callback will be invoked in the
1234 * [thread-default main context][g-main-context-push-thread-default]
1235 * of the thread you are calling this method from. You can
1236 * then call g_dbus_connection_flush_finish() to get the result of the
1237 * operation. See g_dbus_connection_flush_sync() for the synchronous
1243 g_dbus_connection_flush (GDBusConnection *connection,
1244 GCancellable *cancellable,
1245 GAsyncReadyCallback callback,
1250 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1252 task = g_task_new (connection, cancellable, callback, user_data);
1253 g_task_run_in_thread (task, flush_in_thread_func);
1254 g_object_unref (task);
1258 * g_dbus_connection_flush_finish:
1259 * @connection: a #GDBusConnection
1260 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1261 * to g_dbus_connection_flush()
1262 * @error: return location for error or %NULL
1264 * Finishes an operation started with g_dbus_connection_flush().
1266 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1271 g_dbus_connection_flush_finish (GDBusConnection *connection,
1275 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1276 g_return_val_if_fail (g_task_is_valid (res, connection), FALSE);
1277 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1279 return g_task_propagate_boolean (G_TASK (res), error);
1283 * g_dbus_connection_flush_sync:
1284 * @connection: a #GDBusConnection
1285 * @cancellable: (allow-none): a #GCancellable or %NULL
1286 * @error: return location for error or %NULL
1288 * Synchronously flushes @connection. The calling thread is blocked
1289 * until this is done. See g_dbus_connection_flush() for the
1290 * asynchronous version of this method and more details about what it
1293 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1298 g_dbus_connection_flush_sync (GDBusConnection *connection,
1299 GCancellable *cancellable,
1304 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1305 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1309 /* This is only a best-effort attempt to see whether the connection is
1310 * closed, so it doesn't need the lock. If the connection closes just
1311 * after this check, but before scheduling the flush operation, the
1312 * result will be more or less the same as if the connection closed while
1313 * the flush operation was pending - it'll fail with either CLOSED or
1316 if (!check_unclosed (connection, 0, error))
1319 g_assert (connection->worker != NULL);
1321 ret = _g_dbus_worker_flush_sync (connection->worker,
1329 /* ---------------------------------------------------------------------------------------------------- */
1333 GDBusConnection *connection;
1335 gboolean remote_peer_vanished;
1339 emit_closed_data_free (EmitClosedData *data)
1341 g_object_unref (data->connection);
1342 if (data->error != NULL)
1343 g_error_free (data->error);
1347 /* Called in a user thread that has acquired the main context that was
1348 * thread-default when the object was constructed
1351 emit_closed_in_idle (gpointer user_data)
1353 EmitClosedData *data = user_data;
1356 g_object_notify (G_OBJECT (data->connection), "closed");
1357 g_signal_emit (data->connection,
1358 signals[CLOSED_SIGNAL],
1360 data->remote_peer_vanished,
1366 /* Can be called from any thread, must hold lock.
1367 * FLAG_CLOSED must already have been set.
1370 schedule_closed_unlocked (GDBusConnection *connection,
1371 gboolean remote_peer_vanished,
1374 GSource *idle_source;
1375 EmitClosedData *data;
1377 CONNECTION_ENSURE_LOCK (connection);
1379 data = g_new0 (EmitClosedData, 1);
1380 data->connection = g_object_ref (connection);
1381 data->remote_peer_vanished = remote_peer_vanished;
1382 data->error = error != NULL ? g_error_copy (error) : NULL;
1384 idle_source = g_idle_source_new ();
1385 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1386 g_source_set_callback (idle_source,
1387 emit_closed_in_idle,
1389 (GDestroyNotify) emit_closed_data_free);
1390 g_source_set_name (idle_source, "[gio] emit_closed_in_idle");
1391 g_source_attach (idle_source, connection->main_context_at_construction);
1392 g_source_unref (idle_source);
1395 /* ---------------------------------------------------------------------------------------------------- */
1398 * g_dbus_connection_close:
1399 * @connection: a #GDBusConnection
1400 * @cancellable: (allow-none): a #GCancellable or %NULL
1401 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
1402 * satisfied or %NULL if you don't care about the result
1403 * @user_data: The data to pass to @callback
1405 * Closes @connection. Note that this never causes the process to
1406 * exit (this might only happen if the other end of a shared message
1407 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1409 * Once the connection is closed, operations such as sending a message
1410 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1411 * will not automatically flush the connection so queued messages may
1412 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1414 * If @connection is already closed, this method fails with
1415 * %G_IO_ERROR_CLOSED.
1417 * When @connection has been closed, the #GDBusConnection::closed
1418 * signal is emitted in the
1419 * [thread-default main context][g-main-context-push-thread-default]
1420 * of the thread that @connection was constructed in.
1422 * This is an asynchronous method. When the operation is finished,
1423 * @callback will be invoked in the
1424 * [thread-default main context][g-main-context-push-thread-default]
1425 * of the thread you are calling this method from. You can
1426 * then call g_dbus_connection_close_finish() to get the result of the
1427 * operation. See g_dbus_connection_close_sync() for the synchronous
1433 g_dbus_connection_close (GDBusConnection *connection,
1434 GCancellable *cancellable,
1435 GAsyncReadyCallback callback,
1440 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1442 /* do not use g_return_val_if_fail(), we want the memory barrier */
1443 if (!check_initialized (connection))
1446 g_assert (connection->worker != NULL);
1448 task = g_task_new (connection, cancellable, callback, user_data);
1449 _g_dbus_worker_close (connection->worker, task);
1450 g_object_unref (task);
1454 * g_dbus_connection_close_finish:
1455 * @connection: a #GDBusConnection
1456 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1457 * to g_dbus_connection_close()
1458 * @error: return location for error or %NULL
1460 * Finishes an operation started with g_dbus_connection_close().
1462 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1467 g_dbus_connection_close_finish (GDBusConnection *connection,
1471 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1472 g_return_val_if_fail (g_task_is_valid (res, connection), FALSE);
1473 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1475 return g_task_propagate_boolean (G_TASK (res), error);
1480 GAsyncResult *result;
1483 /* Can be called by any thread, without the connection lock */
1485 sync_close_cb (GObject *source_object,
1489 SyncCloseData *data = user_data;
1491 data->result = g_object_ref (res);
1492 g_main_loop_quit (data->loop);
1496 * g_dbus_connection_close_sync:
1497 * @connection: a #GDBusConnection
1498 * @cancellable: (allow-none): a #GCancellable or %NULL
1499 * @error: return location for error or %NULL
1501 * Synchronously closees @connection. The calling thread is blocked
1502 * until this is done. See g_dbus_connection_close() for the
1503 * asynchronous version of this method and more details about what it
1506 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1511 g_dbus_connection_close_sync (GDBusConnection *connection,
1512 GCancellable *cancellable,
1517 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1518 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1522 if (check_unclosed (connection, 0, error))
1524 GMainContext *context;
1527 context = g_main_context_new ();
1528 g_main_context_push_thread_default (context);
1529 data.loop = g_main_loop_new (context, TRUE);
1532 g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
1533 g_main_loop_run (data.loop);
1534 ret = g_dbus_connection_close_finish (connection, data.result, error);
1536 g_object_unref (data.result);
1537 g_main_loop_unref (data.loop);
1538 g_main_context_pop_thread_default (context);
1539 g_main_context_unref (context);
1545 /* ---------------------------------------------------------------------------------------------------- */
1548 * g_dbus_connection_get_last_serial:
1549 * @connection: a #GDBusConnection
1551 * Retrieves the last serial number assigned to a #GDBusMessage on
1552 * the current thread. This includes messages sent via both low-level
1553 * API such as g_dbus_connection_send_message() as well as
1554 * high-level API such as g_dbus_connection_emit_signal(),
1555 * g_dbus_connection_call() or g_dbus_proxy_call().
1557 * Returns: the last used serial or zero when no message has been sent
1558 * within the current thread
1563 g_dbus_connection_get_last_serial (GDBusConnection *connection)
1567 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
1569 CONNECTION_LOCK (connection);
1570 ret = GPOINTER_TO_UINT (g_hash_table_lookup (connection->map_thread_to_last_serial,
1572 CONNECTION_UNLOCK (connection);
1577 /* ---------------------------------------------------------------------------------------------------- */
1579 /* Can be called by any thread, with the connection lock held */
1581 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
1582 GDBusMessage *message,
1583 GDBusSendMessageFlags flags,
1584 volatile guint32 *out_serial,
1589 guint32 serial_to_use;
1592 CONNECTION_ENSURE_LOCK (connection);
1594 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1595 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1597 /* TODO: check all necessary headers are present */
1602 if (out_serial != NULL)
1605 /* If we're in initable_init(), don't check for being initialized, to avoid
1606 * chicken-and-egg problems. initable_init() is responsible for setting up
1607 * our prerequisites (mainly connection->worker), and only calling us
1608 * from its own thread (so no memory barrier is needed).
1610 if (!check_unclosed (connection,
1611 (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
1615 blob = g_dbus_message_to_blob (message,
1617 connection->capabilities,
1622 if (flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL)
1623 serial_to_use = g_dbus_message_get_serial (message);
1625 serial_to_use = ++connection->last_serial; /* TODO: handle overflow */
1630 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
1633 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
1636 g_assert_not_reached ();
1641 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
1642 blob_size, serial_to_use, connection);
1643 g_printerr ("----\n");
1644 hexdump (blob, blob_size);
1645 g_printerr ("----\n");
1648 /* TODO: use connection->auth to encode the blob */
1650 if (out_serial != NULL)
1651 *out_serial = serial_to_use;
1653 /* store used serial for the current thread */
1654 /* TODO: watch the thread disposal and remove associated record
1656 * - see https://bugzilla.gnome.org/show_bug.cgi?id=676825#c7
1658 g_hash_table_replace (connection->map_thread_to_last_serial,
1660 GUINT_TO_POINTER (serial_to_use));
1662 if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
1663 g_dbus_message_set_serial (message, serial_to_use);
1665 g_dbus_message_lock (message);
1666 _g_dbus_worker_send_message (connection->worker,
1670 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
1681 * g_dbus_connection_send_message:
1682 * @connection: a #GDBusConnection
1683 * @message: a #GDBusMessage
1684 * @flags: flags affecting how the message is sent
1685 * @out_serial: (out) (allow-none): return location for serial number assigned
1686 * to @message when sending it or %NULL
1687 * @error: Return location for error or %NULL
1689 * Asynchronously sends @message to the peer represented by @connection.
1691 * Unless @flags contain the
1692 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1693 * will be assigned by @connection and set on @message via
1694 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1695 * serial number used will be written to this location prior to
1696 * submitting the message to the underlying transport.
1698 * If @connection is closed then the operation will fail with
1699 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
1700 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1702 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
1703 * for an example of how to use this low-level API to send and receive
1704 * UNIX file descriptors.
1706 * Note that @message must be unlocked, unless @flags contain the
1707 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1709 * Returns: %TRUE if the message was well-formed and queued for
1710 * transmission, %FALSE if @error is set
1715 g_dbus_connection_send_message (GDBusConnection *connection,
1716 GDBusMessage *message,
1717 GDBusSendMessageFlags flags,
1718 volatile guint32 *out_serial,
1723 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1724 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1725 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
1726 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1728 CONNECTION_LOCK (connection);
1729 ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
1730 CONNECTION_UNLOCK (connection);
1734 /* ---------------------------------------------------------------------------------------------------- */
1740 gulong cancellable_handler_id;
1742 GSource *timeout_source;
1747 /* Can be called from any thread with or without lock held */
1749 send_message_data_free (SendMessageData *data)
1751 g_assert (data->timeout_source == NULL);
1752 g_assert (data->cancellable_handler_id == 0);
1754 g_slice_free (SendMessageData, data);
1757 /* ---------------------------------------------------------------------------------------------------- */
1759 /* can be called from any thread with lock held */
1761 send_message_with_reply_cleanup (GTask *task, gboolean remove)
1763 GDBusConnection *connection = g_task_get_source_object (task);
1764 SendMessageData *data = g_task_get_task_data (task);
1766 CONNECTION_ENSURE_LOCK (connection);
1768 g_assert (!data->delivered);
1770 data->delivered = TRUE;
1772 if (data->timeout_source != NULL)
1774 g_source_destroy (data->timeout_source);
1775 data->timeout_source = NULL;
1777 if (data->cancellable_handler_id > 0)
1779 g_cancellable_disconnect (g_task_get_cancellable (task), data->cancellable_handler_id);
1780 data->cancellable_handler_id = 0;
1785 gboolean removed = g_hash_table_remove (connection->map_method_serial_to_task,
1786 GUINT_TO_POINTER (data->serial));
1787 g_warn_if_fail (removed);
1790 g_object_unref (task);
1793 /* ---------------------------------------------------------------------------------------------------- */
1795 /* Called from GDBus worker thread with lock held */
1797 send_message_data_deliver_reply_unlocked (GTask *task,
1798 GDBusMessage *reply)
1800 SendMessageData *data = g_task_get_task_data (task);
1802 if (data->delivered)
1805 g_task_return_pointer (task, g_object_ref (reply), g_object_unref);
1807 send_message_with_reply_cleanup (task, TRUE);
1813 /* Called from a user thread, lock is not held */
1815 send_message_data_deliver_error (GTask *task,
1818 const char *message)
1820 GDBusConnection *connection = g_task_get_source_object (task);
1821 SendMessageData *data = g_task_get_task_data (task);
1823 CONNECTION_LOCK (connection);
1824 if (data->delivered)
1826 CONNECTION_UNLOCK (connection);
1830 g_object_ref (task);
1831 send_message_with_reply_cleanup (task, TRUE);
1832 CONNECTION_UNLOCK (connection);
1834 g_task_return_new_error (task, domain, code, "%s", message);
1835 g_object_unref (task);
1838 /* ---------------------------------------------------------------------------------------------------- */
1840 /* Called from a user thread, lock is not held */
1842 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
1844 GTask *task = user_data;
1846 send_message_data_deliver_error (task, G_IO_ERROR, G_IO_ERROR_CANCELLED,
1847 _("Operation was cancelled"));
1851 /* Can be called from any thread with or without lock held */
1853 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
1856 GTask *task = user_data;
1857 GSource *idle_source;
1859 /* postpone cancellation to idle handler since we may be called directly
1860 * via g_cancellable_connect() (e.g. holding lock)
1862 idle_source = g_idle_source_new ();
1863 g_source_set_name (idle_source, "[gio] send_message_with_reply_cancelled_idle_cb");
1864 g_task_attach_source (task, idle_source, send_message_with_reply_cancelled_idle_cb);
1865 g_source_unref (idle_source);
1868 /* ---------------------------------------------------------------------------------------------------- */
1870 /* Called from a user thread, lock is not held */
1872 send_message_with_reply_timeout_cb (gpointer user_data)
1874 GTask *task = user_data;
1876 send_message_data_deliver_error (task, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
1877 _("Timeout was reached"));
1881 /* ---------------------------------------------------------------------------------------------------- */
1883 /* Called from a user thread, connection's lock is held */
1885 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
1886 GDBusMessage *message,
1887 GDBusSendMessageFlags flags,
1889 volatile guint32 *out_serial,
1890 GCancellable *cancellable,
1891 GAsyncReadyCallback callback,
1895 SendMessageData *data;
1896 GError *error = NULL;
1897 volatile guint32 serial;
1899 if (out_serial == NULL)
1900 out_serial = &serial;
1902 if (timeout_msec == -1)
1903 timeout_msec = 25 * 1000;
1905 data = g_slice_new0 (SendMessageData);
1906 task = g_task_new (connection, cancellable, callback, user_data);
1907 g_task_set_task_data (task, data, (GDestroyNotify) send_message_data_free);
1909 if (g_task_return_error_if_cancelled (task))
1911 g_object_unref (task);
1915 if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
1917 g_task_return_error (task, error);
1918 g_object_unref (task);
1921 data->serial = *out_serial;
1923 if (cancellable != NULL)
1925 data->cancellable_handler_id = g_cancellable_connect (cancellable,
1926 G_CALLBACK (send_message_with_reply_cancelled_cb),
1927 g_object_ref (task),
1931 if (timeout_msec != G_MAXINT)
1933 data->timeout_source = g_timeout_source_new (timeout_msec);
1934 g_task_attach_source (task, data->timeout_source,
1935 (GSourceFunc) send_message_with_reply_timeout_cb);
1936 g_source_unref (data->timeout_source);
1939 g_hash_table_insert (connection->map_method_serial_to_task,
1940 GUINT_TO_POINTER (*out_serial),
1945 * g_dbus_connection_send_message_with_reply:
1946 * @connection: a #GDBusConnection
1947 * @message: a #GDBusMessage
1948 * @flags: flags affecting how the message is sent
1949 * @timeout_msec: the timeout in milliseconds, -1 to use the default
1950 * timeout or %G_MAXINT for no timeout
1951 * @out_serial: (out) (allow-none): return location for serial number assigned
1952 * to @message when sending it or %NULL
1953 * @cancellable: (allow-none): a #GCancellable or %NULL
1954 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
1955 * is satisfied or %NULL if you don't care about the result
1956 * @user_data: The data to pass to @callback
1958 * Asynchronously sends @message to the peer represented by @connection.
1960 * Unless @flags contain the
1961 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1962 * will be assigned by @connection and set on @message via
1963 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1964 * serial number used will be written to this location prior to
1965 * submitting the message to the underlying transport.
1967 * If @connection is closed then the operation will fail with
1968 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1969 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1970 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1972 * This is an asynchronous method. When the operation is finished, @callback
1973 * will be invoked in the
1974 * [thread-default main context][g-main-context-push-thread-default]
1975 * of the thread you are calling this method from. You can then call
1976 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
1977 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
1979 * Note that @message must be unlocked, unless @flags contain the
1980 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1982 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
1983 * for an example of how to use this low-level API to send and receive
1984 * UNIX file descriptors.
1989 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
1990 GDBusMessage *message,
1991 GDBusSendMessageFlags flags,
1993 volatile guint32 *out_serial,
1994 GCancellable *cancellable,
1995 GAsyncReadyCallback callback,
1998 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1999 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2000 g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
2001 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
2003 CONNECTION_LOCK (connection);
2004 g_dbus_connection_send_message_with_reply_unlocked (connection,
2012 CONNECTION_UNLOCK (connection);
2016 * g_dbus_connection_send_message_with_reply_finish:
2017 * @connection: a #GDBusConnection
2018 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
2019 * g_dbus_connection_send_message_with_reply()
2020 * @error: teturn location for error or %NULL
2022 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
2024 * Note that @error is only set if a local in-process error
2025 * occurred. That is to say that the returned #GDBusMessage object may
2026 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2027 * g_dbus_message_to_gerror() to transcode this to a #GError.
2029 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2030 * for an example of how to use this low-level API to send and receive
2031 * UNIX file descriptors.
2033 * Returns: (transfer full): a locked #GDBusMessage or %NULL if @error is set
2038 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
2042 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2043 g_return_val_if_fail (g_task_is_valid (res, connection), NULL);
2044 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2046 return g_task_propagate_pointer (G_TASK (res), error);
2049 /* ---------------------------------------------------------------------------------------------------- */
2054 GMainContext *context;
2056 } SendMessageSyncData;
2058 /* Called from a user thread, lock is not held */
2060 send_message_with_reply_sync_cb (GDBusConnection *connection,
2064 SendMessageSyncData *data = user_data;
2065 data->res = g_object_ref (res);
2066 g_main_loop_quit (data->loop);
2070 * g_dbus_connection_send_message_with_reply_sync:
2071 * @connection: a #GDBusConnection
2072 * @message: a #GDBusMessage
2073 * @flags: flags affecting how the message is sent.
2074 * @timeout_msec: the timeout in milliseconds, -1 to use the default
2075 * timeout or %G_MAXINT for no timeout
2076 * @out_serial: (out) (allow-none): return location for serial number
2077 * assigned to @message when sending it or %NULL
2078 * @cancellable: (allow-none): a #GCancellable or %NULL
2079 * @error: return location for error or %NULL
2081 * Synchronously sends @message to the peer represented by @connection
2082 * and blocks the calling thread until a reply is received or the
2083 * timeout is reached. See g_dbus_connection_send_message_with_reply()
2084 * for the asynchronous version of this method.
2086 * Unless @flags contain the
2087 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2088 * will be assigned by @connection and set on @message via
2089 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2090 * serial number used will be written to this location prior to
2091 * submitting the message to the underlying transport.
2093 * If @connection is closed then the operation will fail with
2094 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2095 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2096 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2098 * Note that @error is only set if a local in-process error
2099 * occurred. That is to say that the returned #GDBusMessage object may
2100 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2101 * g_dbus_message_to_gerror() to transcode this to a #GError.
2103 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2104 * for an example of how to use this low-level API to send and receive
2105 * UNIX file descriptors.
2107 * Note that @message must be unlocked, unless @flags contain the
2108 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2110 * Returns: (transfer full): a locked #GDBusMessage that is the reply
2111 * to @message or %NULL if @error is set
2116 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
2117 GDBusMessage *message,
2118 GDBusSendMessageFlags flags,
2120 volatile guint32 *out_serial,
2121 GCancellable *cancellable,
2124 SendMessageSyncData data;
2125 GDBusMessage *reply;
2127 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2128 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2129 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
2130 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2131 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2134 data.context = g_main_context_new ();
2135 data.loop = g_main_loop_new (data.context, FALSE);
2137 g_main_context_push_thread_default (data.context);
2139 g_dbus_connection_send_message_with_reply (connection,
2145 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2147 g_main_loop_run (data.loop);
2148 reply = g_dbus_connection_send_message_with_reply_finish (connection,
2152 g_main_context_pop_thread_default (data.context);
2154 g_main_context_unref (data.context);
2155 g_main_loop_unref (data.loop);
2157 g_object_unref (data.res);
2162 /* ---------------------------------------------------------------------------------------------------- */
2166 GDBusMessageFilterFunction func;
2173 GDBusMessageFilterFunction filter_function;
2175 GDestroyNotify user_data_free_func;
2178 /* Called in GDBusWorker's thread - we must not block - with no lock held */
2180 on_worker_message_received (GDBusWorker *worker,
2181 GDBusMessage *message,
2184 GDBusConnection *connection;
2185 FilterCallback *filters;
2190 G_LOCK (message_bus_lock);
2191 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2194 G_UNLOCK (message_bus_lock);
2197 connection = G_DBUS_CONNECTION (user_data);
2198 g_object_ref (connection);
2199 G_UNLOCK (message_bus_lock);
2201 //g_debug ("in on_worker_message_received");
2203 g_object_ref (message);
2204 g_dbus_message_lock (message);
2206 //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2208 /* First collect the set of callback functions */
2209 CONNECTION_LOCK (connection);
2210 num_filters = connection->filters->len;
2211 filters = g_new0 (FilterCallback, num_filters);
2212 for (n = 0; n < num_filters; n++)
2214 FilterData *data = connection->filters->pdata[n];
2215 filters[n].func = data->filter_function;
2216 filters[n].user_data = data->user_data;
2218 CONNECTION_UNLOCK (connection);
2220 /* then call the filters in order (without holding the lock) */
2221 for (n = 0; n < num_filters; n++)
2223 message = filters[n].func (connection,
2226 filters[n].user_data);
2227 if (message == NULL)
2229 g_dbus_message_lock (message);
2232 /* Standard dispatch unless the filter ate the message - no need to
2233 * do anything if the message was altered
2235 if (message != NULL)
2237 GDBusMessageType message_type;
2239 message_type = g_dbus_message_get_message_type (message);
2240 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2242 guint32 reply_serial;
2245 reply_serial = g_dbus_message_get_reply_serial (message);
2246 CONNECTION_LOCK (connection);
2247 task = g_hash_table_lookup (connection->map_method_serial_to_task,
2248 GUINT_TO_POINTER (reply_serial));
2251 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2252 send_message_data_deliver_reply_unlocked (task, message);
2256 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2258 CONNECTION_UNLOCK (connection);
2260 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2262 CONNECTION_LOCK (connection);
2263 distribute_signals (connection, message);
2264 CONNECTION_UNLOCK (connection);
2266 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2268 CONNECTION_LOCK (connection);
2269 distribute_method_call (connection, message);
2270 CONNECTION_UNLOCK (connection);
2274 if (message != NULL)
2275 g_object_unref (message);
2276 g_object_unref (connection);
2280 /* Called in GDBusWorker's thread, lock is not held */
2281 static GDBusMessage *
2282 on_worker_message_about_to_be_sent (GDBusWorker *worker,
2283 GDBusMessage *message,
2286 GDBusConnection *connection;
2287 FilterCallback *filters;
2292 G_LOCK (message_bus_lock);
2293 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2296 G_UNLOCK (message_bus_lock);
2299 connection = G_DBUS_CONNECTION (user_data);
2300 g_object_ref (connection);
2301 G_UNLOCK (message_bus_lock);
2303 //g_debug ("in on_worker_message_about_to_be_sent");
2305 /* First collect the set of callback functions */
2306 CONNECTION_LOCK (connection);
2307 num_filters = connection->filters->len;
2308 filters = g_new0 (FilterCallback, num_filters);
2309 for (n = 0; n < num_filters; n++)
2311 FilterData *data = connection->filters->pdata[n];
2312 filters[n].func = data->filter_function;
2313 filters[n].user_data = data->user_data;
2315 CONNECTION_UNLOCK (connection);
2317 /* then call the filters in order (without holding the lock) */
2318 for (n = 0; n < num_filters; n++)
2320 g_dbus_message_lock (message);
2321 message = filters[n].func (connection,
2324 filters[n].user_data);
2325 if (message == NULL)
2329 g_object_unref (connection);
2335 /* called with connection lock held, in GDBusWorker thread */
2337 cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
2339 GTask *task = value;
2340 SendMessageData *data = g_task_get_task_data (task);
2342 if (data->delivered)
2345 g_task_return_new_error (task,
2348 _("The connection is closed"));
2350 /* Ask send_message_with_reply_cleanup not to remove the element from the
2351 * hash table - we're in the middle of a foreach; that would be unsafe.
2352 * Instead, return TRUE from this function so that it gets removed safely.
2354 send_message_with_reply_cleanup (task, FALSE);
2358 /* Called in GDBusWorker's thread - we must not block - without lock held */
2360 on_worker_closed (GDBusWorker *worker,
2361 gboolean remote_peer_vanished,
2365 GDBusConnection *connection;
2367 guint old_atomic_flags;
2369 G_LOCK (message_bus_lock);
2370 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2373 G_UNLOCK (message_bus_lock);
2376 connection = G_DBUS_CONNECTION (user_data);
2377 g_object_ref (connection);
2378 G_UNLOCK (message_bus_lock);
2380 //g_debug ("in on_worker_closed: %s", error->message);
2382 CONNECTION_LOCK (connection);
2383 /* Even though this is atomic, we do it inside the lock to avoid breaking
2384 * assumptions in remove_match_rule(). We'd need the lock in a moment
2385 * anyway, so, no loss.
2387 old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
2389 if (!(old_atomic_flags & FLAG_CLOSED))
2391 g_hash_table_foreach_remove (connection->map_method_serial_to_task, cancel_method_on_close, NULL);
2392 schedule_closed_unlocked (connection, remote_peer_vanished, error);
2394 CONNECTION_UNLOCK (connection);
2396 g_object_unref (connection);
2399 /* ---------------------------------------------------------------------------------------------------- */
2401 /* Determines the biggest set of capabilities we can support on this
2404 * Called with the init_lock held.
2406 static GDBusCapabilityFlags
2407 get_offered_capabilities_max (GDBusConnection *connection)
2409 GDBusCapabilityFlags ret;
2410 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
2412 if (G_IS_UNIX_CONNECTION (connection->stream))
2413 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
2418 /* Called in a user thread, lock is not held */
2420 initable_init (GInitable *initable,
2421 GCancellable *cancellable,
2424 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
2427 /* This method needs to be idempotent to work with the singleton
2428 * pattern. See the docs for g_initable_init(). We implement this by
2431 * Unfortunately we can't use the main lock since the on_worker_*()
2432 * callbacks above needs the lock during initialization (for message
2433 * bus connections we do a synchronous Hello() call on the bus).
2435 g_mutex_lock (&connection->init_lock);
2439 /* Make this a no-op if we're already initialized (successfully or
2442 if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
2444 ret = (connection->initialization_error == NULL);
2448 /* Because of init_lock, we can't get here twice in different threads */
2449 g_assert (connection->initialization_error == NULL);
2451 /* The user can pass multiple (but mutally exclusive) construct
2454 * - stream (of type GIOStream)
2455 * - address (of type gchar*)
2457 * At the end of the day we end up with a non-NULL GIOStream
2458 * object in connection->stream.
2460 if (connection->address != NULL)
2462 g_assert (connection->stream == NULL);
2464 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
2465 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
2467 g_set_error_literal (&connection->initialization_error,
2469 G_IO_ERROR_INVALID_ARGUMENT,
2470 _("Unsupported flags encountered when constructing a client-side connection"));
2474 connection->stream = g_dbus_address_get_stream_sync (connection->address,
2475 NULL, /* TODO: out_guid */
2477 &connection->initialization_error);
2478 if (connection->stream == NULL)
2481 else if (connection->stream != NULL)
2487 g_assert_not_reached ();
2490 /* Authenticate the connection */
2491 if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
2493 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
2494 g_assert (connection->guid != NULL);
2495 connection->auth = _g_dbus_auth_new (connection->stream);
2496 if (!_g_dbus_auth_run_server (connection->auth,
2497 connection->authentication_observer,
2499 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
2500 get_offered_capabilities_max (connection),
2501 &connection->capabilities,
2502 &connection->credentials,
2504 &connection->initialization_error))
2507 else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
2509 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
2510 g_assert (connection->guid == NULL);
2511 connection->auth = _g_dbus_auth_new (connection->stream);
2512 connection->guid = _g_dbus_auth_run_client (connection->auth,
2513 connection->authentication_observer,
2514 get_offered_capabilities_max (connection),
2515 &connection->capabilities,
2517 &connection->initialization_error);
2518 if (connection->guid == NULL)
2522 if (connection->authentication_observer != NULL)
2524 g_object_unref (connection->authentication_observer);
2525 connection->authentication_observer = NULL;
2528 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
2530 //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
2533 /* We want all IO operations to be non-blocking since they happen in
2534 * the worker thread which is shared by _all_ connections.
2536 if (G_IS_SOCKET_CONNECTION (connection->stream))
2538 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
2542 G_LOCK (message_bus_lock);
2543 if (alive_connections == NULL)
2544 alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
2545 g_hash_table_insert (alive_connections, connection, connection);
2546 G_UNLOCK (message_bus_lock);
2548 connection->worker = _g_dbus_worker_new (connection->stream,
2549 connection->capabilities,
2550 ((connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0),
2551 on_worker_message_received,
2552 on_worker_message_about_to_be_sent,
2556 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
2557 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2559 GVariant *hello_result;
2561 /* we could lift this restriction by adding code in gdbusprivate.c */
2562 if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
2564 g_set_error_literal (&connection->initialization_error,
2567 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
2571 hello_result = g_dbus_connection_call_sync (connection,
2572 "org.freedesktop.DBus", /* name */
2573 "/org/freedesktop/DBus", /* path */
2574 "org.freedesktop.DBus", /* interface */
2576 NULL, /* parameters */
2577 G_VARIANT_TYPE ("(s)"),
2578 CALL_FLAGS_INITIALIZING,
2580 NULL, /* TODO: cancellable */
2581 &connection->initialization_error);
2582 if (hello_result == NULL)
2585 g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
2586 g_variant_unref (hello_result);
2587 //g_debug ("unique name is '%s'", connection->bus_unique_name);
2594 g_assert (connection->initialization_error != NULL);
2595 g_propagate_error (error, g_error_copy (connection->initialization_error));
2598 g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
2599 g_mutex_unlock (&connection->init_lock);
2605 initable_iface_init (GInitableIface *initable_iface)
2607 initable_iface->init = initable_init;
2610 /* ---------------------------------------------------------------------------------------------------- */
2613 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
2618 /* ---------------------------------------------------------------------------------------------------- */
2621 * g_dbus_connection_new:
2622 * @stream: a #GIOStream
2623 * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
2624 * @flags: flags describing how to make the connection
2625 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
2626 * @cancellable: (allow-none): a #GCancellable or %NULL
2627 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
2628 * @user_data: the data to pass to @callback
2630 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
2631 * with the end represented by @stream.
2633 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2634 * will be put into non-blocking mode.
2636 * The D-Bus connection will interact with @stream from a worker thread.
2637 * As a result, the caller should not interact with @stream after this
2638 * method has been called, except by calling g_object_unref() on it.
2640 * If @observer is not %NULL it may be used to control the
2641 * authentication process.
2643 * When the operation is finished, @callback will be invoked. You can
2644 * then call g_dbus_connection_new_finish() to get the result of the
2647 * This is a asynchronous failable constructor. See
2648 * g_dbus_connection_new_sync() for the synchronous
2654 g_dbus_connection_new (GIOStream *stream,
2656 GDBusConnectionFlags flags,
2657 GDBusAuthObserver *observer,
2658 GCancellable *cancellable,
2659 GAsyncReadyCallback callback,
2662 g_return_if_fail (G_IS_IO_STREAM (stream));
2663 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2671 "authentication-observer", observer,
2676 * g_dbus_connection_new_finish:
2677 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback
2678 * passed to g_dbus_connection_new().
2679 * @error: return location for error or %NULL
2681 * Finishes an operation started with g_dbus_connection_new().
2683 * Returns: a #GDBusConnection or %NULL if @error is set. Free
2684 * with g_object_unref().
2689 g_dbus_connection_new_finish (GAsyncResult *res,
2693 GObject *source_object;
2695 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2696 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2698 source_object = g_async_result_get_source_object (res);
2699 g_assert (source_object != NULL);
2700 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2703 g_object_unref (source_object);
2705 return G_DBUS_CONNECTION (object);
2711 * g_dbus_connection_new_sync:
2712 * @stream: a #GIOStream
2713 * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
2714 * @flags: flags describing how to make the connection
2715 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
2716 * @cancellable: (allow-none): a #GCancellable or %NULL
2717 * @error: return location for error or %NULL
2719 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2720 * with the end represented by @stream.
2722 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2723 * will be put into non-blocking mode.
2725 * The D-Bus connection will interact with @stream from a worker thread.
2726 * As a result, the caller should not interact with @stream after this
2727 * method has been called, except by calling g_object_unref() on it.
2729 * If @observer is not %NULL it may be used to control the
2730 * authentication process.
2732 * This is a synchronous failable constructor. See
2733 * g_dbus_connection_new() for the asynchronous version.
2735 * Returns: a #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2740 g_dbus_connection_new_sync (GIOStream *stream,
2742 GDBusConnectionFlags flags,
2743 GDBusAuthObserver *observer,
2744 GCancellable *cancellable,
2747 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2748 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2749 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2755 "authentication-observer", observer,
2759 /* ---------------------------------------------------------------------------------------------------- */
2762 * g_dbus_connection_new_for_address:
2763 * @address: a D-Bus address
2764 * @flags: flags describing how to make the connection
2765 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
2766 * @cancellable: (allow-none): a #GCancellable or %NULL
2767 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
2768 * @user_data: the data to pass to @callback
2770 * Asynchronously connects and sets up a D-Bus client connection for
2771 * exchanging D-Bus messages with an endpoint specified by @address
2772 * which must be in the D-Bus address format.
2774 * This constructor can only be used to initiate client-side
2775 * connections - use g_dbus_connection_new() if you need to act as the
2776 * server. In particular, @flags cannot contain the
2777 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2778 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2780 * When the operation is finished, @callback will be invoked. You can
2781 * then call g_dbus_connection_new_finish() to get the result of the
2784 * If @observer is not %NULL it may be used to control the
2785 * authentication process.
2787 * This is a asynchronous failable constructor. See
2788 * g_dbus_connection_new_for_address_sync() for the synchronous
2794 g_dbus_connection_new_for_address (const gchar *address,
2795 GDBusConnectionFlags flags,
2796 GDBusAuthObserver *observer,
2797 GCancellable *cancellable,
2798 GAsyncReadyCallback callback,
2801 g_return_if_fail (address != NULL);
2802 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2809 "authentication-observer", observer,
2814 * g_dbus_connection_new_for_address_finish:
2815 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
2816 * to g_dbus_connection_new()
2817 * @error: return location for error or %NULL
2819 * Finishes an operation started with g_dbus_connection_new_for_address().
2821 * Returns: a #GDBusConnection or %NULL if @error is set. Free with
2827 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
2831 GObject *source_object;
2833 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2834 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2836 source_object = g_async_result_get_source_object (res);
2837 g_assert (source_object != NULL);
2838 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2841 g_object_unref (source_object);
2843 return G_DBUS_CONNECTION (object);
2849 * g_dbus_connection_new_for_address_sync:
2850 * @address: a D-Bus address
2851 * @flags: flags describing how to make the connection
2852 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
2853 * @cancellable: (allow-none): a #GCancellable or %NULL
2854 * @error: return location for error or %NULL
2856 * Synchronously connects and sets up a D-Bus client connection for
2857 * exchanging D-Bus messages with an endpoint specified by @address
2858 * which must be in the D-Bus address format.
2860 * This constructor can only be used to initiate client-side
2861 * connections - use g_dbus_connection_new_sync() if you need to act
2862 * as the server. In particular, @flags cannot contain the
2863 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2864 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2866 * This is a synchronous failable constructor. See
2867 * g_dbus_connection_new_for_address() for the asynchronous version.
2869 * If @observer is not %NULL it may be used to control the
2870 * authentication process.
2872 * Returns: a #GDBusConnection or %NULL if @error is set. Free with
2878 g_dbus_connection_new_for_address_sync (const gchar *address,
2879 GDBusConnectionFlags flags,
2880 GDBusAuthObserver *observer,
2881 GCancellable *cancellable,
2884 g_return_val_if_fail (address != NULL, NULL);
2885 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2886 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2891 "authentication-observer", observer,
2895 /* ---------------------------------------------------------------------------------------------------- */
2898 * g_dbus_connection_set_exit_on_close:
2899 * @connection: a #GDBusConnection
2900 * @exit_on_close: whether the process should be terminated
2901 * when @connection is closed by the remote peer
2903 * Sets whether the process should be terminated when @connection is
2904 * closed by the remote peer. See #GDBusConnection:exit-on-close for
2907 * Note that this function should be used with care. Most modern UNIX
2908 * desktops tie the notion of a user session the session bus, and expect
2909 * all of a users applications to quit when their bus connection goes away.
2910 * If you are setting @exit_on_close to %FALSE for the shared session
2911 * bus connection, you should make sure that your application exits
2912 * when the user session ends.
2917 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
2918 gboolean exit_on_close)
2920 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2923 g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
2925 g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
2930 * g_dbus_connection_get_exit_on_close:
2931 * @connection: a #GDBusConnection
2933 * Gets whether the process is terminated when @connection is
2934 * closed by the remote peer. See
2935 * #GDBusConnection:exit-on-close for more details.
2937 * Returns: whether the process is terminated when @connection is
2938 * closed by the remote peer
2943 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
2945 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2947 if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
2954 * g_dbus_connection_get_guid:
2955 * @connection: a #GDBusConnection
2957 * The GUID of the peer performing the role of server when
2958 * authenticating. See #GDBusConnection:guid for more details.
2960 * Returns: The GUID. Do not free this string, it is owned by
2966 g_dbus_connection_get_guid (GDBusConnection *connection)
2968 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2969 return connection->guid;
2973 * g_dbus_connection_get_unique_name:
2974 * @connection: a #GDBusConnection
2976 * Gets the unique name of @connection as assigned by the message
2977 * bus. This can also be used to figure out if @connection is a
2978 * message bus connection.
2980 * Returns: the unique name or %NULL if @connection is not a message
2981 * bus connection. Do not free this string, it is owned by
2987 g_dbus_connection_get_unique_name (GDBusConnection *connection)
2989 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2991 /* do not use g_return_val_if_fail(), we want the memory barrier */
2992 if (!check_initialized (connection))
2995 return connection->bus_unique_name;
2999 * g_dbus_connection_get_peer_credentials:
3000 * @connection: a #GDBusConnection
3002 * Gets the credentials of the authenticated peer. This will always
3003 * return %NULL unless @connection acted as a server
3004 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
3005 * when set up and the client passed credentials as part of the
3006 * authentication process.
3008 * In a message bus setup, the message bus is always the server and
3009 * each application is a client. So this method will always return
3010 * %NULL for message bus clients.
3012 * Returns: (transfer none): a #GCredentials or %NULL if not available.
3013 * Do not free this object, it is owned by @connection.
3018 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
3020 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3022 /* do not use g_return_val_if_fail(), we want the memory barrier */
3023 if (!check_initialized (connection))
3026 return connection->credentials;
3029 /* ---------------------------------------------------------------------------------------------------- */
3031 static guint _global_filter_id = 1;
3034 * g_dbus_connection_add_filter:
3035 * @connection: a #GDBusConnection
3036 * @filter_function: a filter function
3037 * @user_data: user data to pass to @filter_function
3038 * @user_data_free_func: function to free @user_data with when filter
3039 * is removed or %NULL
3041 * Adds a message filter. Filters are handlers that are run on all
3042 * incoming and outgoing messages, prior to standard dispatch. Filters
3043 * are run in the order that they were added. The same handler can be
3044 * added as a filter more than once, in which case it will be run more
3045 * than once. Filters added during a filter callback won't be run on
3046 * the message being processed. Filter functions are allowed to modify
3047 * and even drop messages.
3049 * Note that filters are run in a dedicated message handling thread so
3050 * they can't block and, generally, can't do anything but signal a
3051 * worker thread. Also note that filters are rarely needed - use API
3052 * such as g_dbus_connection_send_message_with_reply(),
3053 * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
3055 * If a filter consumes an incoming message the message is not
3056 * dispatched anywhere else - not even the standard dispatch machinery
3057 * (that API such as g_dbus_connection_signal_subscribe() and
3058 * g_dbus_connection_send_message_with_reply() relies on) will see the
3059 * message. Similary, if a filter consumes an outgoing message, the
3060 * message will not be sent to the other peer.
3062 * Returns: a filter identifier that can be used with
3063 * g_dbus_connection_remove_filter()
3068 g_dbus_connection_add_filter (GDBusConnection *connection,
3069 GDBusMessageFilterFunction filter_function,
3071 GDestroyNotify user_data_free_func)
3075 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3076 g_return_val_if_fail (filter_function != NULL, 0);
3077 g_return_val_if_fail (check_initialized (connection), 0);
3079 CONNECTION_LOCK (connection);
3080 data = g_new0 (FilterData, 1);
3081 data->id = _global_filter_id++; /* TODO: overflow etc. */
3082 data->filter_function = filter_function;
3083 data->user_data = user_data;
3084 data->user_data_free_func = user_data_free_func;
3085 g_ptr_array_add (connection->filters, data);
3086 CONNECTION_UNLOCK (connection);
3091 /* only called from finalize(), removes all filters */
3093 purge_all_filters (GDBusConnection *connection)
3096 for (n = 0; n < connection->filters->len; n++)
3098 FilterData *data = connection->filters->pdata[n];
3099 if (data->user_data_free_func != NULL)
3100 data->user_data_free_func (data->user_data);
3106 * g_dbus_connection_remove_filter:
3107 * @connection: a #GDBusConnection
3108 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
3115 g_dbus_connection_remove_filter (GDBusConnection *connection,
3119 FilterData *to_destroy;
3121 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3122 g_return_if_fail (check_initialized (connection));
3124 CONNECTION_LOCK (connection);
3126 for (n = 0; n < connection->filters->len; n++)
3128 FilterData *data = connection->filters->pdata[n];
3129 if (data->id == filter_id)
3131 g_ptr_array_remove_index (connection->filters, n);
3136 CONNECTION_UNLOCK (connection);
3138 /* do free without holding lock */
3139 if (to_destroy != NULL)
3141 if (to_destroy->user_data_free_func != NULL)
3142 to_destroy->user_data_free_func (to_destroy->user_data);
3143 g_free (to_destroy);
3147 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
3151 /* ---------------------------------------------------------------------------------------------------- */
3157 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
3158 gchar *interface_name;
3162 GDBusSignalFlags flags;
3163 GArray *subscribers;
3168 GDBusSignalCallback callback;
3170 GDestroyNotify user_data_free_func;
3172 GMainContext *context;
3176 signal_data_free (SignalData *signal_data)
3178 g_free (signal_data->rule);
3179 g_free (signal_data->sender);
3180 g_free (signal_data->sender_unique_name);
3181 g_free (signal_data->interface_name);
3182 g_free (signal_data->member);
3183 g_free (signal_data->object_path);
3184 g_free (signal_data->arg0);
3185 g_array_free (signal_data->subscribers, TRUE);
3186 g_free (signal_data);
3190 args_to_rule (const gchar *sender,
3191 const gchar *interface_name,
3192 const gchar *member,
3193 const gchar *object_path,
3195 GDBusSignalFlags flags)
3199 rule = g_string_new ("type='signal'");
3200 if (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE)
3201 g_string_prepend_c (rule, '-');
3203 g_string_append_printf (rule, ",sender='%s'", sender);
3204 if (interface_name != NULL)
3205 g_string_append_printf (rule, ",interface='%s'", interface_name);
3207 g_string_append_printf (rule, ",member='%s'", member);
3208 if (object_path != NULL)
3209 g_string_append_printf (rule, ",path='%s'", object_path);
3213 if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
3214 g_string_append_printf (rule, ",arg0path='%s'", arg0);
3215 else if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
3216 g_string_append_printf (rule, ",arg0namespace='%s'", arg0);
3218 g_string_append_printf (rule, ",arg0='%s'", arg0);
3221 return g_string_free (rule, FALSE);
3224 static guint _global_subscriber_id = 1;
3225 static guint _global_registration_id = 1;
3226 static guint _global_subtree_registration_id = 1;
3228 /* ---------------------------------------------------------------------------------------------------- */
3230 /* Called in a user thread, lock is held */
3232 add_match_rule (GDBusConnection *connection,
3233 const gchar *match_rule)
3236 GDBusMessage *message;
3238 if (match_rule[0] == '-')
3241 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3242 "/org/freedesktop/DBus", /* path */
3243 "org.freedesktop.DBus", /* interface */
3245 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3247 if (!g_dbus_connection_send_message_unlocked (connection,
3249 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3253 g_critical ("Error while sending AddMatch() message: %s", error->message);
3254 g_error_free (error);
3256 g_object_unref (message);
3259 /* ---------------------------------------------------------------------------------------------------- */
3261 /* Called in a user thread, lock is held */
3263 remove_match_rule (GDBusConnection *connection,
3264 const gchar *match_rule)
3267 GDBusMessage *message;
3269 if (match_rule[0] == '-')
3272 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3273 "/org/freedesktop/DBus", /* path */
3274 "org.freedesktop.DBus", /* interface */
3276 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3279 if (!g_dbus_connection_send_message_unlocked (connection,
3281 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3285 /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
3286 * critical; but we're holding the lock, and our caller checked whether
3287 * we were already closed, so we can't get that error.
3289 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3290 g_error_free (error);
3292 g_object_unref (message);
3295 /* ---------------------------------------------------------------------------------------------------- */
3298 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3300 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3301 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3302 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3303 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3304 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3307 /* ---------------------------------------------------------------------------------------------------- */
3310 * g_dbus_connection_signal_subscribe:
3311 * @connection: a #GDBusConnection
3312 * @sender: (allow-none): sender name to match on (unique or well-known name)
3313 * or %NULL to listen from all senders
3314 * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
3315 * match on all interfaces
3316 * @member: (allow-none): D-Bus signal name to match on or %NULL to match on
3318 * @object_path: (allow-none): object path to match on or %NULL to match on
3320 * @arg0: (allow-none): contents of first string argument to match on or %NULL
3321 * to match on all kinds of arguments
3322 * @flags: #GDBusSignalFlags describing how arg0 is used in subscribing to the
3324 * @callback: callback to invoke when there is a signal matching the requested data
3325 * @user_data: user data to pass to @callback
3326 * @user_data_free_func: (allow-none): function to free @user_data with when
3327 * subscription is removed or %NULL
3329 * Subscribes to signals on @connection and invokes @callback with a whenever
3330 * the signal is received. Note that @callback will be invoked in the
3331 * [thread-default main context][g-main-context-push-thread-default]
3332 * of the thread you are calling this method from.
3334 * If @connection is not a message bus connection, @sender must be
3337 * If @sender is a well-known name note that @callback is invoked with
3338 * the unique name for the owner of @sender, not the well-known name
3339 * as one would expect. This is because the message bus rewrites the
3340 * name. As such, to avoid certain race conditions, users should be
3341 * tracking the name owner of the well-known name and use that when
3342 * processing the received signal.
3344 * If one of %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE or
3345 * %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH are given, @arg0 is
3346 * interpreted as part of a namespace or path. The first argument
3347 * of a signal is matched against that part as specified by D-Bus.
3349 * Returns: a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe()
3354 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
3355 const gchar *sender,
3356 const gchar *interface_name,
3357 const gchar *member,
3358 const gchar *object_path,
3360 GDBusSignalFlags flags,
3361 GDBusSignalCallback callback,
3363 GDestroyNotify user_data_free_func)
3366 SignalData *signal_data;
3367 SignalSubscriber subscriber;
3368 GPtrArray *signal_data_array;
3369 const gchar *sender_unique_name;
3371 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
3372 * an OOM condition. We might want to change that but that would involve making
3373 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
3374 * handle that. And there's really no sensible way of handling this short of retrying
3375 * to add the match rule... and then there's the little thing that, hey, maybe there's
3376 * a reason the bus in an OOM condition.
3378 * Doable, but not really sure it's worth it...
3381 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3382 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
3383 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
3384 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
3385 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
3386 g_return_val_if_fail (callback != NULL, 0);
3387 g_return_val_if_fail (check_initialized (connection), 0);
3388 g_return_val_if_fail (!((flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH) && (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)), 0);
3389 g_return_val_if_fail (!(arg0 == NULL && (flags & (G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH | G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE))), 0);
3391 CONNECTION_LOCK (connection);
3393 /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
3394 * with a '-' character to prefix the rule (which will otherwise be
3397 * This allows us to hash the rule and do our lifecycle tracking in
3398 * the usual way, but the '-' prevents the match rule from ever
3399 * actually being send to the bus (either for add or remove).
3401 rule = args_to_rule (sender, interface_name, member, object_path, arg0, flags);
3403 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
3404 sender_unique_name = sender;
3406 sender_unique_name = "";
3408 subscriber.callback = callback;
3409 subscriber.user_data = user_data;
3410 subscriber.user_data_free_func = user_data_free_func;
3411 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
3412 subscriber.context = g_main_context_ref_thread_default ();
3414 /* see if we've already have this rule */
3415 signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
3416 if (signal_data != NULL)
3418 g_array_append_val (signal_data->subscribers, subscriber);
3423 signal_data = g_new0 (SignalData, 1);
3424 signal_data->rule = rule;
3425 signal_data->sender = g_strdup (sender);
3426 signal_data->sender_unique_name = g_strdup (sender_unique_name);
3427 signal_data->interface_name = g_strdup (interface_name);
3428 signal_data->member = g_strdup (member);
3429 signal_data->object_path = g_strdup (object_path);
3430 signal_data->arg0 = g_strdup (arg0);
3431 signal_data->flags = flags;
3432 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3433 g_array_append_val (signal_data->subscribers, subscriber);
3435 g_hash_table_insert (connection->map_rule_to_signal_data,
3439 /* Add the match rule to the bus...
3441 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
3442 * always send such messages to us.
3444 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3446 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
3447 add_match_rule (connection, signal_data->rule);
3450 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3451 signal_data->sender_unique_name);
3452 if (signal_data_array == NULL)
3454 signal_data_array = g_ptr_array_new ();
3455 g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
3456 g_strdup (signal_data->sender_unique_name),
3459 g_ptr_array_add (signal_data_array, signal_data);
3462 g_hash_table_insert (connection->map_id_to_signal_data,
3463 GUINT_TO_POINTER (subscriber.id),
3466 CONNECTION_UNLOCK (connection);
3468 return subscriber.id;
3471 /* ---------------------------------------------------------------------------------------------------- */
3473 /* called in any thread */
3474 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
3476 unsubscribe_id_internal (GDBusConnection *connection,
3477 guint subscription_id,
3478 GArray *out_removed_subscribers)
3480 SignalData *signal_data;
3481 GPtrArray *signal_data_array;
3484 signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
3485 GUINT_TO_POINTER (subscription_id));
3486 if (signal_data == NULL)
3488 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
3492 for (n = 0; n < signal_data->subscribers->len; n++)
3494 SignalSubscriber *subscriber;
3496 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
3497 if (subscriber->id != subscription_id)
3500 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
3501 GUINT_TO_POINTER (subscription_id)));
3502 g_array_append_val (out_removed_subscribers, *subscriber);
3503 g_array_remove_index (signal_data->subscribers, n);
3505 if (signal_data->subscribers->len == 0)
3507 g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
3509 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3510 signal_data->sender_unique_name);
3511 g_warn_if_fail (signal_data_array != NULL);
3512 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
3514 if (signal_data_array->len == 0)
3516 g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
3517 signal_data->sender_unique_name));
3520 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
3521 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
3522 !is_signal_data_for_name_lost_or_acquired (signal_data) &&
3523 !g_dbus_connection_is_closed (connection) &&
3524 !connection->finalizing)
3526 /* The check for g_dbus_connection_is_closed() means that
3527 * sending the RemoveMatch message can't fail with
3528 * G_IO_ERROR_CLOSED, because we're holding the lock,
3529 * so on_worker_closed() can't happen between the check we just
3530 * did, and releasing the lock later.
3532 remove_match_rule (connection, signal_data->rule);
3535 signal_data_free (signal_data);
3541 g_assert_not_reached ();
3548 * g_dbus_connection_signal_unsubscribe:
3549 * @connection: a #GDBusConnection
3550 * @subscription_id: a subscription id obtained from
3551 * g_dbus_connection_signal_subscribe()
3553 * Unsubscribes from signals.
3558 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
3559 guint subscription_id)
3561 GArray *subscribers;
3564 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3565 g_return_if_fail (check_initialized (connection));
3567 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3569 CONNECTION_LOCK (connection);
3570 unsubscribe_id_internal (connection,
3573 CONNECTION_UNLOCK (connection);
3576 g_assert (subscribers->len == 0 || subscribers->len == 1);
3578 /* call GDestroyNotify without lock held */
3579 for (n = 0; n < subscribers->len; n++)
3581 SignalSubscriber *subscriber;
3582 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3583 call_destroy_notify (subscriber->context,
3584 subscriber->user_data_free_func,
3585 subscriber->user_data);
3586 g_main_context_unref (subscriber->context);
3589 g_array_free (subscribers, TRUE);
3592 /* ---------------------------------------------------------------------------------------------------- */
3596 guint subscription_id;
3597 GDBusSignalCallback callback;
3599 GDBusMessage *message;
3600 GDBusConnection *connection;
3601 const gchar *sender;
3603 const gchar *interface;
3604 const gchar *member;
3607 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
3611 emit_signal_instance_in_idle_cb (gpointer data)
3613 SignalInstance *signal_instance = data;
3614 GVariant *parameters;
3615 gboolean has_subscription;
3617 parameters = g_dbus_message_get_body (signal_instance->message);
3618 if (parameters == NULL)
3620 parameters = g_variant_new ("()");
3621 g_variant_ref_sink (parameters);
3625 g_variant_ref_sink (parameters);
3629 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
3630 signal_instance->subscription_id,
3631 signal_instance->sender,
3632 signal_instance->path,
3633 signal_instance->interface,
3634 signal_instance->member,
3635 g_variant_print (parameters, TRUE));
3638 /* Careful here, don't do the callback if we no longer has the subscription */
3639 CONNECTION_LOCK (signal_instance->connection);
3640 has_subscription = FALSE;
3641 if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
3642 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
3643 has_subscription = TRUE;
3644 CONNECTION_UNLOCK (signal_instance->connection);
3646 if (has_subscription)
3647 signal_instance->callback (signal_instance->connection,
3648 signal_instance->sender,
3649 signal_instance->path,
3650 signal_instance->interface,
3651 signal_instance->member,
3653 signal_instance->user_data);
3655 g_variant_unref (parameters);
3661 signal_instance_free (SignalInstance *signal_instance)
3663 g_object_unref (signal_instance->message);
3664 g_object_unref (signal_instance->connection);
3665 g_free (signal_instance);
3669 namespace_rule_matches (const gchar *namespace,
3675 len_namespace = strlen (namespace);
3676 len_name = strlen (name);
3678 if (len_name < len_namespace)
3681 if (memcmp (namespace, name, len_namespace) != 0)
3684 return len_namespace == len_name || name[len_namespace] == '.';
3688 path_rule_matches (const gchar *path_a,
3689 const gchar *path_b)
3693 len_a = strlen (path_a);
3694 len_b = strlen (path_b);
3696 if (len_a < len_b && (len_a == 0 || path_a[len_a - 1] != '/'))
3699 if (len_b < len_a && (len_b == 0 || path_b[len_b - 1] != '/'))
3702 return memcmp (path_a, path_b, MIN (len_a, len_b)) == 0;
3705 /* called in GDBusWorker thread WITH lock held */
3707 schedule_callbacks (GDBusConnection *connection,
3708 GPtrArray *signal_data_array,
3709 GDBusMessage *message,
3710 const gchar *sender)
3713 const gchar *interface;
3714 const gchar *member;
3723 interface = g_dbus_message_get_interface (message);
3724 member = g_dbus_message_get_member (message);
3725 path = g_dbus_message_get_path (message);
3726 arg0 = g_dbus_message_get_arg0 (message);
3729 g_print ("In schedule_callbacks:\n"
3731 " interface = '%s'\n"
3742 /* TODO: if this is slow, then we can change signal_data_array into
3743 * map_object_path_to_signal_data_array or something.
3745 for (n = 0; n < signal_data_array->len; n++)
3747 SignalData *signal_data = signal_data_array->pdata[n];
3749 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
3752 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
3755 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
3758 if (signal_data->arg0 != NULL)
3763 if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
3765 if (!namespace_rule_matches (signal_data->arg0, arg0))
3768 else if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
3770 if (!path_rule_matches (signal_data->arg0, arg0))
3773 else if (!g_str_equal (signal_data->arg0, arg0))
3777 for (m = 0; m < signal_data->subscribers->len; m++)
3779 SignalSubscriber *subscriber;
3780 GSource *idle_source;
3781 SignalInstance *signal_instance;
3783 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
3785 signal_instance = g_new0 (SignalInstance, 1);
3786 signal_instance->subscription_id = subscriber->id;
3787 signal_instance->callback = subscriber->callback;
3788 signal_instance->user_data = subscriber->user_data;
3789 signal_instance->message = g_object_ref (message);
3790 signal_instance->connection = g_object_ref (connection);
3791 signal_instance->sender = sender;
3792 signal_instance->path = path;
3793 signal_instance->interface = interface;
3794 signal_instance->member = member;
3796 idle_source = g_idle_source_new ();
3797 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3798 g_source_set_callback (idle_source,
3799 emit_signal_instance_in_idle_cb,
3801 (GDestroyNotify) signal_instance_free);
3802 g_source_set_name (idle_source, "[gio] emit_signal_instance_in_idle_cb");
3803 g_source_attach (idle_source, subscriber->context);
3804 g_source_unref (idle_source);
3809 /* called in GDBusWorker thread with lock held */
3811 distribute_signals (GDBusConnection *connection,
3812 GDBusMessage *message)
3814 GPtrArray *signal_data_array;
3815 const gchar *sender;
3817 sender = g_dbus_message_get_sender (message);
3819 if (G_UNLIKELY (_g_dbus_debug_signal ()))
3821 _g_dbus_debug_print_lock ();
3822 g_print ("========================================================================\n"
3823 "GDBus-debug:Signal:\n"
3824 " <<<< RECEIVED SIGNAL %s.%s\n"
3826 " sent by name %s\n",
3827 g_dbus_message_get_interface (message),
3828 g_dbus_message_get_member (message),
3829 g_dbus_message_get_path (message),
3830 sender != NULL ? sender : "(none)");
3831 _g_dbus_debug_print_unlock ();
3834 /* collect subscribers that match on sender */
3837 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
3838 if (signal_data_array != NULL)
3839 schedule_callbacks (connection, signal_data_array, message, sender);
3842 /* collect subscribers not matching on sender */
3843 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
3844 if (signal_data_array != NULL)
3845 schedule_callbacks (connection, signal_data_array, message, sender);
3848 /* ---------------------------------------------------------------------------------------------------- */
3850 /* only called from finalize(), removes all subscriptions */
3852 purge_all_signal_subscriptions (GDBusConnection *connection)
3854 GHashTableIter iter;
3857 GArray *subscribers;
3860 ids = g_array_new (FALSE, FALSE, sizeof (guint));
3861 g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
3862 while (g_hash_table_iter_next (&iter, &key, NULL))
3864 guint subscription_id = GPOINTER_TO_UINT (key);
3865 g_array_append_val (ids, subscription_id);
3868 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3869 for (n = 0; n < ids->len; n++)
3871 guint subscription_id = g_array_index (ids, guint, n);
3872 unsubscribe_id_internal (connection,
3876 g_array_free (ids, TRUE);
3878 /* call GDestroyNotify without lock held */
3879 for (n = 0; n < subscribers->len; n++)
3881 SignalSubscriber *subscriber;
3882 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3883 call_destroy_notify (subscriber->context,
3884 subscriber->user_data_free_func,
3885 subscriber->user_data);
3886 g_main_context_unref (subscriber->context);
3889 g_array_free (subscribers, TRUE);
3892 /* ---------------------------------------------------------------------------------------------------- */
3894 static GDBusInterfaceVTable *
3895 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
3897 /* Don't waste memory by copying padding - remember to update this
3898 * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
3900 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3904 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
3909 /* ---------------------------------------------------------------------------------------------------- */
3911 static GDBusSubtreeVTable *
3912 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
3914 /* Don't waste memory by copying padding - remember to update this
3915 * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
3917 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3921 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
3926 /* ---------------------------------------------------------------------------------------------------- */
3928 struct ExportedObject
3931 GDBusConnection *connection;
3933 /* maps gchar* -> ExportedInterface* */
3934 GHashTable *map_if_name_to_ei;
3937 /* only called with lock held */
3939 exported_object_free (ExportedObject *eo)
3941 g_free (eo->object_path);
3942 g_hash_table_unref (eo->map_if_name_to_ei);
3951 gchar *interface_name;
3952 GDBusInterfaceVTable *vtable;
3953 GDBusInterfaceInfo *interface_info;
3955 GMainContext *context;
3957 GDestroyNotify user_data_free_func;
3958 } ExportedInterface;
3960 /* called with lock held */
3962 exported_interface_free (ExportedInterface *ei)
3964 g_dbus_interface_info_cache_release (ei->interface_info);
3965 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
3967 call_destroy_notify (ei->context,
3968 ei->user_data_free_func,
3971 g_main_context_unref (ei->context);
3973 g_free (ei->interface_name);
3974 _g_dbus_interface_vtable_free (ei->vtable);
3978 /* ---------------------------------------------------------------------------------------------------- */
3980 /* Convenience function to check if @registration_id (if not zero) or
3981 * @subtree_registration_id (if not zero) has been unregistered. If
3982 * so, returns %TRUE.
3984 * May be called by any thread. Caller must *not* hold lock.
3987 has_object_been_unregistered (GDBusConnection *connection,
3988 guint registration_id,
3989 guint subtree_registration_id)
3993 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3997 CONNECTION_LOCK (connection);
3998 if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
3999 GUINT_TO_POINTER (registration_id)) == NULL)
4003 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
4004 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
4008 CONNECTION_UNLOCK (connection);
4013 /* ---------------------------------------------------------------------------------------------------- */
4017 GDBusConnection *connection;
4018 GDBusMessage *message;
4020 const gchar *property_name;
4021 const GDBusInterfaceVTable *vtable;
4022 GDBusInterfaceInfo *interface_info;
4023 const GDBusPropertyInfo *property_info;
4024 guint registration_id;
4025 guint subtree_registration_id;
4029 property_data_free (PropertyData *data)
4031 g_object_unref (data->connection);
4032 g_object_unref (data->message);
4036 /* called in thread where object was registered - no locks held */
4038 invoke_get_property_in_idle_cb (gpointer _data)
4040 PropertyData *data = _data;
4043 GDBusMessage *reply;
4045 if (has_object_been_unregistered (data->connection,
4046 data->registration_id,
4047 data->subtree_registration_id))
4049 reply = g_dbus_message_new_method_error (data->message,
4050 "org.freedesktop.DBus.Error.UnknownMethod",
4051 _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
4052 g_dbus_message_get_path (data->message));
4053 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4054 g_object_unref (reply);
4059 value = data->vtable->get_property (data->connection,
4060 g_dbus_message_get_sender (data->message),
4061 g_dbus_message_get_path (data->message),
4062 data->interface_info->name,
4063 data->property_name,
4070 g_assert_no_error (error);
4072 g_variant_take_ref (value);
4073 reply = g_dbus_message_new_method_reply (data->message);
4074 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
4075 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4076 g_variant_unref (value);
4077 g_object_unref (reply);
4081 gchar *dbus_error_name;
4082 g_assert (error != NULL);
4083 dbus_error_name = g_dbus_error_encode_gerror (error);
4084 reply = g_dbus_message_new_method_error_literal (data->message,
4087 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4088 g_free (dbus_error_name);
4089 g_error_free (error);
4090 g_object_unref (reply);
4097 /* called in thread where object was registered - no locks held */
4099 invoke_set_property_in_idle_cb (gpointer _data)
4101 PropertyData *data = _data;
4103 GDBusMessage *reply;
4109 g_variant_get (g_dbus_message_get_body (data->message),
4115 if (!data->vtable->set_property (data->connection,
4116 g_dbus_message_get_sender (data->message),
4117 g_dbus_message_get_path (data->message),
4118 data->interface_info->name,
4119 data->property_name,
4124 gchar *dbus_error_name;
4125 g_assert (error != NULL);
4126 dbus_error_name = g_dbus_error_encode_gerror (error);
4127 reply = g_dbus_message_new_method_error_literal (data->message,
4130 g_free (dbus_error_name);
4131 g_error_free (error);
4135 reply = g_dbus_message_new_method_reply (data->message);
4138 g_assert (reply != NULL);
4139 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4140 g_object_unref (reply);
4141 g_variant_unref (value);
4146 /* called in any thread with connection's lock held */
4148 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
4149 GDBusMessage *message,
4150 guint registration_id,
4151 guint subtree_registration_id,
4153 GDBusInterfaceInfo *interface_info,
4154 const GDBusInterfaceVTable *vtable,
4155 GMainContext *main_context,
4159 const char *interface_name;
4160 const char *property_name;
4161 const GDBusPropertyInfo *property_info;
4162 GSource *idle_source;
4163 PropertyData *property_data;
4164 GDBusMessage *reply;
4169 g_variant_get (g_dbus_message_get_body (message),
4174 g_variant_get (g_dbus_message_get_body (message),
4183 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
4185 property_info = NULL;
4187 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4188 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
4189 if (property_info == NULL)
4191 reply = g_dbus_message_new_method_error (message,
4192 "org.freedesktop.DBus.Error.InvalidArgs",
4193 _("No such property '%s'"),
4195 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4196 g_object_unref (reply);
4201 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4203 reply = g_dbus_message_new_method_error (message,
4204 "org.freedesktop.DBus.Error.InvalidArgs",
4205 _("Property '%s' is not readable"),
4207 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4208 g_object_unref (reply);
4212 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
4214 reply = g_dbus_message_new_method_error (message,
4215 "org.freedesktop.DBus.Error.InvalidArgs",
4216 _("Property '%s' is not writable"),
4218 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4219 g_object_unref (reply);
4228 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
4229 * of the given value is wrong
4231 g_variant_get_child (g_dbus_message_get_body (message), 2, "v", &value);
4232 if (g_strcmp0 (g_variant_get_type_string (value), property_info->signature) != 0)
4234 reply = g_dbus_message_new_method_error (message,
4235 "org.freedesktop.DBus.Error.InvalidArgs",
4236 _("Error setting property '%s': Expected type '%s' but got '%s'"),
4237 property_name, property_info->signature,
4238 g_variant_get_type_string (value));
4239 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4240 g_variant_unref (value);
4241 g_object_unref (reply);
4246 g_variant_unref (value);
4249 /* If the vtable pointer for get_property() resp. set_property() is
4250 * NULL then dispatch the call via the method_call() handler.
4254 if (vtable->get_property == NULL)
4256 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4257 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4258 vtable, main_context, user_data);
4265 if (vtable->set_property == NULL)
4267 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4268 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4269 vtable, main_context, user_data);
4275 /* ok, got the property info - call user code in an idle handler */
4276 property_data = g_new0 (PropertyData, 1);
4277 property_data->connection = g_object_ref (connection);
4278 property_data->message = g_object_ref (message);
4279 property_data->user_data = user_data;
4280 property_data->property_name = property_name;
4281 property_data->vtable = vtable;
4282 property_data->interface_info = interface_info;
4283 property_data->property_info = property_info;
4284 property_data->registration_id = registration_id;
4285 property_data->subtree_registration_id = subtree_registration_id;
4287 idle_source = g_idle_source_new ();
4288 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4289 g_source_set_callback (idle_source,
4290 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
4292 (GDestroyNotify) property_data_free);
4294 g_source_set_name (idle_source, "[gio] invoke_get_property_in_idle_cb");
4296 g_source_set_name (idle_source, "[gio] invoke_set_property_in_idle_cb");
4297 g_source_attach (idle_source, main_context);
4298 g_source_unref (idle_source);
4306 /* called in GDBusWorker thread with connection's lock held */
4308 handle_getset_property (GDBusConnection *connection,
4310 GDBusMessage *message,
4313 ExportedInterface *ei;
4315 const char *interface_name;
4316 const char *property_name;
4321 g_variant_get (g_dbus_message_get_body (message),
4326 g_variant_get (g_dbus_message_get_body (message),
4332 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4333 * no such interface registered
4335 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4338 GDBusMessage *reply;
4339 reply = g_dbus_message_new_method_error (message,
4340 "org.freedesktop.DBus.Error.InvalidArgs",
4341 _("No such interface '%s'"),
4343 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4344 g_object_unref (reply);
4349 handled = validate_and_maybe_schedule_property_getset (eo->connection,
4362 /* ---------------------------------------------------------------------------------------------------- */
4366 GDBusConnection *connection;
4367 GDBusMessage *message;
4369 const GDBusInterfaceVTable *vtable;
4370 GDBusInterfaceInfo *interface_info;
4371 guint registration_id;
4372 guint subtree_registration_id;
4373 } PropertyGetAllData;
4376 property_get_all_data_free (PropertyData *data)
4378 g_object_unref (data->connection);
4379 g_object_unref (data->message);
4383 /* called in thread where object was registered - no locks held */
4385 invoke_get_all_properties_in_idle_cb (gpointer _data)
4387 PropertyGetAllData *data = _data;
4388 GVariantBuilder builder;
4389 GDBusMessage *reply;
4392 if (has_object_been_unregistered (data->connection,
4393 data->registration_id,
4394 data->subtree_registration_id))
4396 reply = g_dbus_message_new_method_error (data->message,
4397 "org.freedesktop.DBus.Error.UnknownMethod",
4398 _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
4399 g_dbus_message_get_path (data->message));
4400 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4401 g_object_unref (reply);
4405 /* TODO: Right now we never fail this call - we just omit values if
4406 * a get_property() call is failing.
4408 * We could fail the whole call if just a single get_property() call
4409 * returns an error. We need clarification in the D-Bus spec about this.
4411 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
4412 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
4413 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
4415 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
4418 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4421 value = data->vtable->get_property (data->connection,
4422 g_dbus_message_get_sender (data->message),
4423 g_dbus_message_get_path (data->message),
4424 data->interface_info->name,
4425 property_info->name,
4432 g_variant_take_ref (value);
4433 g_variant_builder_add (&builder,
4435 property_info->name,
4437 g_variant_unref (value);
4439 g_variant_builder_close (&builder);
4441 reply = g_dbus_message_new_method_reply (data->message);
4442 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
4443 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4444 g_object_unref (reply);
4451 interface_has_readable_properties (GDBusInterfaceInfo *interface_info)
4455 if (!interface_info->properties)
4458 for (i = 0; interface_info->properties[i]; i++)
4459 if (interface_info->properties[i]->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)
4465 /* called in any thread with connection's lock held */
4467 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
4468 GDBusMessage *message,
4469 guint registration_id,
4470 guint subtree_registration_id,
4471 GDBusInterfaceInfo *interface_info,
4472 const GDBusInterfaceVTable *vtable,
4473 GMainContext *main_context,
4477 GSource *idle_source;
4478 PropertyGetAllData *property_get_all_data;
4485 /* If the vtable pointer for get_property() is NULL but we have a
4486 * non-zero number of readable properties, then dispatch the call via
4487 * the method_call() handler.
4489 if (vtable->get_property == NULL && interface_has_readable_properties (interface_info))
4491 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4492 interface_info, NULL, NULL, g_dbus_message_get_body (message),
4493 vtable, main_context, user_data);
4498 /* ok, got the property info - call user in an idle handler */
4499 property_get_all_data = g_new0 (PropertyGetAllData, 1);
4500 property_get_all_data->connection = g_object_ref (connection);
4501 property_get_all_data->message = g_object_ref (message);
4502 property_get_all_data->user_data = user_data;
4503 property_get_all_data->vtable = vtable;
4504 property_get_all_data->interface_info = interface_info;
4505 property_get_all_data->registration_id = registration_id;
4506 property_get_all_data->subtree_registration_id = subtree_registration_id;
4508 idle_source = g_idle_source_new ();
4509 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4510 g_source_set_callback (idle_source,
4511 invoke_get_all_properties_in_idle_cb,
4512 property_get_all_data,
4513 (GDestroyNotify) property_get_all_data_free);
4514 g_source_set_name (idle_source, "[gio] invoke_get_all_properties_in_idle_cb");
4515 g_source_attach (idle_source, main_context);
4516 g_source_unref (idle_source);
4524 /* called in GDBusWorker thread with connection's lock held */
4526 handle_get_all_properties (GDBusConnection *connection,
4528 GDBusMessage *message)
4530 ExportedInterface *ei;
4532 const char *interface_name;
4536 g_variant_get (g_dbus_message_get_body (message),
4540 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4541 * no such interface registered
4543 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4546 GDBusMessage *reply;
4547 reply = g_dbus_message_new_method_error (message,
4548 "org.freedesktop.DBus.Error.InvalidArgs",
4549 _("No such interface"),
4551 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4552 g_object_unref (reply);
4557 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
4569 /* ---------------------------------------------------------------------------------------------------- */
4571 static const gchar introspect_header[] =
4572 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
4573 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
4574 "<!-- GDBus " PACKAGE_VERSION " -->\n"
4577 static const gchar introspect_tail[] =
4580 static const gchar introspect_properties_interface[] =
4581 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
4582 " <method name=\"Get\">\n"
4583 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4584 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4585 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
4587 " <method name=\"GetAll\">\n"
4588 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4589 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
4591 " <method name=\"Set\">\n"
4592 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4593 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4594 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
4596 " <signal name=\"PropertiesChanged\">\n"
4597 " <arg type=\"s\" name=\"interface_name\"/>\n"
4598 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
4599 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
4603 static const gchar introspect_introspectable_interface[] =
4604 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
4605 " <method name=\"Introspect\">\n"
4606 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
4609 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
4610 " <method name=\"Ping\"/>\n"
4611 " <method name=\"GetMachineId\">\n"
4612 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
4617 introspect_append_header (GString *s)
4619 g_string_append (s, introspect_header);
4623 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
4625 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
4631 begin = object_path + path_len;
4632 end = strchr (begin, '/');
4634 s = g_strndup (begin, end - begin);
4636 s = g_strdup (begin);
4638 if (g_hash_table_lookup (set, s) == NULL)
4639 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
4645 /* TODO: we want a nicer public interface for this */
4646 /* called in any thread with connection's lock held */
4648 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
4653 GHashTableIter hash_iter;
4654 const gchar *object_path;
4660 CONNECTION_ENSURE_LOCK (connection);
4662 path_len = strlen (path);
4666 set = g_hash_table_new (g_str_hash, g_str_equal);
4668 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
4669 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4670 maybe_add_path (path, path_len, object_path, set);
4672 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
4673 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4674 maybe_add_path (path, path_len, object_path, set);
4676 p = g_ptr_array_new ();
4677 keys = g_hash_table_get_keys (set);
4678 for (l = keys; l != NULL; l = l->next)
4679 g_ptr_array_add (p, l->data);
4680 g_hash_table_unref (set);
4683 g_ptr_array_add (p, NULL);
4684 ret = (gchar **) g_ptr_array_free (p, FALSE);
4688 /* called in any thread with connection's lock not held */
4690 g_dbus_connection_list_registered (GDBusConnection *connection,
4694 CONNECTION_LOCK (connection);
4695 ret = g_dbus_connection_list_registered_unlocked (connection, path);
4696 CONNECTION_UNLOCK (connection);
4700 /* called in GDBusWorker thread with connection's lock held */
4702 handle_introspect (GDBusConnection *connection,
4704 GDBusMessage *message)
4708 GDBusMessage *reply;
4709 GHashTableIter hash_iter;
4710 ExportedInterface *ei;
4713 /* first the header with the standard interfaces */
4714 s = g_string_sized_new (sizeof (introspect_header) +
4715 sizeof (introspect_properties_interface) +
4716 sizeof (introspect_introspectable_interface) +
4717 sizeof (introspect_tail));
4718 introspect_append_header (s);
4719 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4720 "org.freedesktop.DBus.Properties"))
4721 g_string_append (s, introspect_properties_interface);
4723 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4724 "org.freedesktop.DBus.Introspectable"))
4725 g_string_append (s, introspect_introspectable_interface);
4727 /* then include the registered interfaces */
4728 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
4729 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
4730 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
4732 /* finally include nodes registered below us */
4733 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
4734 for (n = 0; registered != NULL && registered[n] != NULL; n++)
4735 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
4736 g_strfreev (registered);
4737 g_string_append (s, introspect_tail);
4739 reply = g_dbus_message_new_method_reply (message);
4740 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4741 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4742 g_object_unref (reply);
4743 g_string_free (s, TRUE);
4748 /* called in thread where object was registered - no locks held */
4750 call_in_idle_cb (gpointer user_data)
4752 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
4753 GDBusInterfaceVTable *vtable;
4754 guint registration_id;
4755 guint subtree_registration_id;
4757 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
4758 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
4760 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
4762 subtree_registration_id))
4764 GDBusMessage *reply;
4765 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
4766 "org.freedesktop.DBus.Error.UnknownMethod",
4767 _("No such interface '%s' on object at path %s"),
4768 g_dbus_method_invocation_get_interface_name (invocation),
4769 g_dbus_method_invocation_get_object_path (invocation));
4770 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4771 g_object_unref (reply);
4775 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
4776 g_assert (vtable != NULL && vtable->method_call != NULL);
4778 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
4779 g_dbus_method_invocation_get_sender (invocation),
4780 g_dbus_method_invocation_get_object_path (invocation),
4781 g_dbus_method_invocation_get_interface_name (invocation),
4782 g_dbus_method_invocation_get_method_name (invocation),
4783 g_dbus_method_invocation_get_parameters (invocation),
4784 g_object_ref (invocation),
4785 g_dbus_method_invocation_get_user_data (invocation));
4791 /* called in GDBusWorker thread with connection's lock held */
4793 schedule_method_call (GDBusConnection *connection,
4794 GDBusMessage *message,
4795 guint registration_id,
4796 guint subtree_registration_id,
4797 const GDBusInterfaceInfo *interface_info,
4798 const GDBusMethodInfo *method_info,
4799 const GDBusPropertyInfo *property_info,
4800 GVariant *parameters,
4801 const GDBusInterfaceVTable *vtable,
4802 GMainContext *main_context,
4805 GDBusMethodInvocation *invocation;
4806 GSource *idle_source;
4808 invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
4809 g_dbus_message_get_path (message),
4810 g_dbus_message_get_interface (message),
4811 g_dbus_message_get_member (message),
4819 /* TODO: would be nicer with a real MethodData like we already
4820 * have PropertyData and PropertyGetAllData... */
4821 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
4822 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
4823 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
4825 idle_source = g_idle_source_new ();
4826 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4827 g_source_set_callback (idle_source,
4831 g_source_set_name (idle_source, "[gio] call_in_idle_cb");
4832 g_source_attach (idle_source, main_context);
4833 g_source_unref (idle_source);
4836 /* called in GDBusWorker thread with connection's lock held */
4838 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
4839 GDBusMessage *message,
4840 guint registration_id,
4841 guint subtree_registration_id,
4842 GDBusInterfaceInfo *interface_info,
4843 const GDBusInterfaceVTable *vtable,
4844 GMainContext *main_context,
4847 GDBusMethodInfo *method_info;
4848 GDBusMessage *reply;
4849 GVariant *parameters;
4851 GVariantType *in_type;
4855 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4856 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
4858 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
4859 * error to the caller
4861 if (method_info == NULL)
4863 reply = g_dbus_message_new_method_error (message,
4864 "org.freedesktop.DBus.Error.UnknownMethod",
4865 _("No such method '%s'"),
4866 g_dbus_message_get_member (message));
4867 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4868 g_object_unref (reply);
4873 parameters = g_dbus_message_get_body (message);
4874 if (parameters == NULL)
4876 parameters = g_variant_new ("()");
4877 g_variant_ref_sink (parameters);
4881 g_variant_ref (parameters);
4884 /* Check that the incoming args are of the right type - if they are not, return
4885 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
4887 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
4888 if (!g_variant_is_of_type (parameters, in_type))
4892 type_string = g_variant_type_dup_string (in_type);
4894 reply = g_dbus_message_new_method_error (message,
4895 "org.freedesktop.DBus.Error.InvalidArgs",
4896 _("Type of message, '%s', does not match expected type '%s'"),
4897 g_variant_get_type_string (parameters),
4899 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4900 g_variant_type_free (in_type);
4901 g_variant_unref (parameters);
4902 g_object_unref (reply);
4903 g_free (type_string);
4907 g_variant_type_free (in_type);
4909 /* schedule the call in idle */
4910 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4911 interface_info, method_info, NULL, parameters,
4912 vtable, main_context, user_data);
4913 g_variant_unref (parameters);
4920 /* ---------------------------------------------------------------------------------------------------- */
4922 /* called in GDBusWorker thread with connection's lock held */
4924 obj_message_func (GDBusConnection *connection,
4926 GDBusMessage *message)
4928 const gchar *interface_name;
4929 const gchar *member;
4930 const gchar *signature;
4935 interface_name = g_dbus_message_get_interface (message);
4936 member = g_dbus_message_get_member (message);
4937 signature = g_dbus_message_get_signature (message);
4939 /* see if we have an interface for handling this call */
4940 if (interface_name != NULL)
4942 ExportedInterface *ei;
4943 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4946 /* we do - invoke the handler in idle in the right thread */
4948 /* handle no vtable or handler being present */
4949 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
4952 handled = validate_and_maybe_schedule_method_call (connection,
4964 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
4965 g_strcmp0 (member, "Introspect") == 0 &&
4966 g_strcmp0 (signature, "") == 0)
4968 handled = handle_introspect (connection, eo, message);
4971 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4972 g_strcmp0 (member, "Get") == 0 &&
4973 g_strcmp0 (signature, "ss") == 0)
4975 handled = handle_getset_property (connection, eo, message, TRUE);
4978 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4979 g_strcmp0 (member, "Set") == 0 &&
4980 g_strcmp0 (signature, "ssv") == 0)
4982 handled = handle_getset_property (connection, eo, message, FALSE);
4985 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4986 g_strcmp0 (member, "GetAll") == 0 &&
4987 g_strcmp0 (signature, "s") == 0)
4989 handled = handle_get_all_properties (connection, eo, message);
4998 * g_dbus_connection_register_object:
4999 * @connection: a #GDBusConnection
5000 * @object_path: the object path to register at
5001 * @interface_info: introspection data for the interface
5002 * @vtable: (allow-none): a #GDBusInterfaceVTable to call into or %NULL
5003 * @user_data: (allow-none): data to pass to functions in @vtable
5004 * @user_data_free_func: function to call when the object path is unregistered
5005 * @error: return location for error or %NULL
5007 * Registers callbacks for exported objects at @object_path with the
5008 * D-Bus interface that is described in @interface_info.
5010 * Calls to functions in @vtable (and @user_data_free_func) will happen
5012 * [thread-default main context][g-main-context-push-thread-default]
5013 * of the thread you are calling this method from.
5015 * Note that all #GVariant values passed to functions in @vtable will match
5016 * the signature given in @interface_info - if a remote caller passes
5017 * incorrect values, the `org.freedesktop.DBus.Error.InvalidArgs`
5018 * is returned to the remote caller.
5020 * Additionally, if the remote caller attempts to invoke methods or
5021 * access properties not mentioned in @interface_info the
5022 * `org.freedesktop.DBus.Error.UnknownMethod` resp.
5023 * `org.freedesktop.DBus.Error.InvalidArgs` errors
5024 * are returned to the caller.
5026 * It is considered a programming error if the
5027 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
5028 * #GVariant of incorrect type.
5030 * If an existing callback is already registered at @object_path and
5031 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
5033 * GDBus automatically implements the standard D-Bus interfaces
5034 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
5035 * and org.freedesktop.Peer, so you don't have to implement those for the
5036 * objects you export. You can implement org.freedesktop.DBus.Properties
5037 * yourself, e.g. to handle getting and setting of properties asynchronously.
5039 * Note that the reference count on @interface_info will be
5040 * incremented by 1 (unless allocated statically, e.g. if the
5041 * reference count is -1, see g_dbus_interface_info_ref()) for as long
5042 * as the object is exported. Also note that @vtable will be copied.
5044 * See this [server][gdbus-server] for an example of how to use this method.
5046 * Returns: 0 if @error is set, otherwise a registration id (never 0)
5047 * that can be used with g_dbus_connection_unregister_object()
5052 g_dbus_connection_register_object (GDBusConnection *connection,
5053 const gchar *object_path,
5054 GDBusInterfaceInfo *interface_info,
5055 const GDBusInterfaceVTable *vtable,
5057 GDestroyNotify user_data_free_func,
5061 ExportedInterface *ei;
5064 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
5065 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
5066 g_return_val_if_fail (interface_info != NULL, 0);
5067 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
5068 g_return_val_if_fail (error == NULL || *error == NULL, 0);
5069 g_return_val_if_fail (check_initialized (connection), 0);
5073 CONNECTION_LOCK (connection);
5075 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
5078 eo = g_new0 (ExportedObject, 1);
5079 eo->object_path = g_strdup (object_path);
5080 eo->connection = connection;
5081 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
5084 (GDestroyNotify) exported_interface_free);
5085 g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
5088 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
5094 _("An object is already exported for the interface %s at %s"),
5095 interface_info->name,
5100 ei = g_new0 (ExportedInterface, 1);
5101 ei->id = _global_registration_id++; /* TODO: overflow etc. */
5103 ei->user_data = user_data;
5104 ei->user_data_free_func = user_data_free_func;
5105 ei->vtable = _g_dbus_interface_vtable_copy (vtable);
5106 ei->interface_info = g_dbus_interface_info_ref (interface_info);
5107 g_dbus_interface_info_cache_build (ei->interface_info);
5108 ei->interface_name = g_strdup (interface_info->name);
5109 ei->context = g_main_context_ref_thread_default ();
5111 g_hash_table_insert (eo->map_if_name_to_ei,
5112 (gpointer) ei->interface_name,
5114 g_hash_table_insert (connection->map_id_to_ei,
5115 GUINT_TO_POINTER (ei->id),
5121 CONNECTION_UNLOCK (connection);
5127 * g_dbus_connection_unregister_object:
5128 * @connection: a #GDBusConnection
5129 * @registration_id: a registration id obtained from
5130 * g_dbus_connection_register_object()
5132 * Unregisters an object.
5134 * Returns: %TRUE if the object was unregistered, %FALSE otherwise
5139 g_dbus_connection_unregister_object (GDBusConnection *connection,
5140 guint registration_id)
5142 ExportedInterface *ei;
5146 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5147 g_return_val_if_fail (check_initialized (connection), FALSE);
5151 CONNECTION_LOCK (connection);
5153 ei = g_hash_table_lookup (connection->map_id_to_ei,
5154 GUINT_TO_POINTER (registration_id));
5160 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
5161 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
5162 /* unregister object path if we have no more exported interfaces */
5163 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
5164 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
5170 CONNECTION_UNLOCK (connection);
5175 /* ---------------------------------------------------------------------------------------------------- */
5178 * g_dbus_connection_emit_signal:
5179 * @connection: a #GDBusConnection
5180 * @destination_bus_name: (allow-none): the unique bus name for the destination
5181 * for the signal or %NULL to emit to all listeners
5182 * @object_path: path of remote object
5183 * @interface_name: D-Bus interface to emit a signal on
5184 * @signal_name: the name of the signal to emit
5185 * @parameters: (allow-none): a #GVariant tuple with parameters for the signal
5186 * or %NULL if not passing parameters
5187 * @error: Return location for error or %NULL
5191 * If the parameters GVariant is floating, it is consumed.
5193 * This can only fail if @parameters is not compatible with the D-Bus protocol.
5195 * Returns: %TRUE unless @error is set
5200 g_dbus_connection_emit_signal (GDBusConnection *connection,
5201 const gchar *destination_bus_name,
5202 const gchar *object_path,
5203 const gchar *interface_name,
5204 const gchar *signal_name,
5205 GVariant *parameters,
5208 GDBusMessage *message;
5214 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5215 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
5216 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
5217 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
5218 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
5219 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
5220 g_return_val_if_fail (check_initialized (connection), FALSE);
5222 if (G_UNLIKELY (_g_dbus_debug_emission ()))
5224 _g_dbus_debug_print_lock ();
5225 g_print ("========================================================================\n"
5226 "GDBus-debug:Emission:\n"
5227 " >>>> SIGNAL EMISSION %s.%s()\n"
5229 " destination %s\n",
5230 interface_name, signal_name,
5232 destination_bus_name != NULL ? destination_bus_name : "(none)");
5233 _g_dbus_debug_print_unlock ();
5236 message = g_dbus_message_new_signal (object_path,
5240 if (destination_bus_name != NULL)
5241 g_dbus_message_set_header (message,
5242 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
5243 g_variant_new_string (destination_bus_name));
5245 if (parameters != NULL)
5246 g_dbus_message_set_body (message, parameters);
5248 ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
5249 g_object_unref (message);
5255 add_call_flags (GDBusMessage *message,
5256 GDBusCallFlags flags)
5258 GDBusMessageFlags msg_flags = 0;
5260 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
5261 msg_flags |= G_DBUS_MESSAGE_FLAGS_NO_AUTO_START;
5262 if (flags & G_DBUS_CALL_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION)
5263 msg_flags |= G_DBUS_MESSAGE_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION;
5265 g_dbus_message_set_flags (message, msg_flags);
5269 decode_method_reply (GDBusMessage *reply,
5270 const gchar *method_name,
5271 const GVariantType *reply_type,
5272 GUnixFDList **out_fd_list,
5278 switch (g_dbus_message_get_message_type (reply))
5280 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
5281 result = g_dbus_message_get_body (reply);
5284 result = g_variant_new ("()");
5285 g_variant_ref_sink (result);
5289 g_variant_ref (result);
5292 if (!g_variant_is_of_type (result, reply_type))
5294 gchar *type_string = g_variant_type_dup_string (reply_type);
5298 G_IO_ERROR_INVALID_ARGUMENT,
5299 _("Method '%s' returned type '%s', but expected '%s'"),
5300 method_name, g_variant_get_type_string (result), type_string);
5302 g_variant_unref (result);
5303 g_free (type_string);
5310 if (out_fd_list != NULL)
5312 *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
5313 if (*out_fd_list != NULL)
5314 g_object_ref (*out_fd_list);
5320 case G_DBUS_MESSAGE_TYPE_ERROR:
5321 g_dbus_message_to_gerror (reply, error);
5325 g_assert_not_reached ();
5335 GVariantType *reply_type;
5336 gchar *method_name; /* for error message */
5339 GUnixFDList *fd_list;
5343 call_state_free (CallState *state)
5345 g_variant_type_free (state->reply_type);
5346 g_free (state->method_name);
5348 if (state->fd_list != NULL)
5349 g_object_unref (state->fd_list);
5350 g_slice_free (CallState, state);
5353 /* called in any thread, with the connection's lock not held */
5355 g_dbus_connection_call_done (GObject *source,
5356 GAsyncResult *result,
5359 GDBusConnection *connection = G_DBUS_CONNECTION (source);
5360 GTask *task = user_data;
5361 CallState *state = g_task_get_task_data (task);
5362 GError *error = NULL;
5363 GDBusMessage *reply;
5364 GVariant *value = NULL;
5366 reply = g_dbus_connection_send_message_with_reply_finish (connection,
5370 if (G_UNLIKELY (_g_dbus_debug_call ()))
5372 _g_dbus_debug_print_lock ();
5373 g_print ("========================================================================\n"
5374 "GDBus-debug:Call:\n"
5375 " <<<< ASYNC COMPLETE %s() (serial %d)\n"
5381 g_print ("SUCCESS\n");
5385 g_print ("FAILED: %s\n",
5388 _g_dbus_debug_print_unlock ();
5392 value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
5395 g_task_return_error (task, error);
5397 g_task_return_pointer (task, value, (GDestroyNotify) g_variant_unref);
5399 g_clear_object (&reply);
5400 g_object_unref (task);
5403 /* called in any thread, with the connection's lock not held */
5405 g_dbus_connection_call_internal (GDBusConnection *connection,
5406 const gchar *bus_name,
5407 const gchar *object_path,
5408 const gchar *interface_name,
5409 const gchar *method_name,
5410 GVariant *parameters,
5411 const GVariantType *reply_type,
5412 GDBusCallFlags flags,
5414 GUnixFDList *fd_list,
5415 GCancellable *cancellable,
5416 GAsyncReadyCallback callback,
5419 GDBusMessage *message;
5422 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
5423 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
5424 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
5425 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
5426 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
5427 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
5428 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
5429 g_return_if_fail (check_initialized (connection));
5431 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
5433 g_return_if_fail (fd_list == NULL);
5436 message = g_dbus_message_new_method_call (bus_name,
5440 add_call_flags (message, flags);
5441 if (parameters != NULL)
5442 g_dbus_message_set_body (message, parameters);
5445 if (fd_list != NULL)
5446 g_dbus_message_set_unix_fd_list (message, fd_list);
5449 /* If the user has no callback then we can just send the message with
5450 * the G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set and skip all
5451 * the logic for processing the reply. If the service sends the reply
5452 * anyway then it will just be ignored.
5454 if (callback != NULL)
5459 state = g_slice_new0 (CallState);
5460 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
5462 if (reply_type == NULL)
5463 reply_type = G_VARIANT_TYPE_ANY;
5465 state->reply_type = g_variant_type_copy (reply_type);
5467 task = g_task_new (connection, cancellable, callback, user_data);
5468 g_task_set_task_data (task, state, (GDestroyNotify) call_state_free);
5470 g_dbus_connection_send_message_with_reply (connection,
5472 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5476 g_dbus_connection_call_done,
5478 serial = state->serial;
5482 GDBusMessageFlags flags;
5484 flags = g_dbus_message_get_flags (message);
5485 flags |= G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
5486 g_dbus_message_set_flags (message, flags);
5488 g_dbus_connection_send_message (connection,
5490 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5494 if (G_UNLIKELY (_g_dbus_debug_call ()))
5496 _g_dbus_debug_print_lock ();
5497 g_print ("========================================================================\n"
5498 "GDBus-debug:Call:\n"
5499 " >>>> ASYNC %s.%s()\n"
5501 " owned by name %s (serial %d)\n",
5505 bus_name != NULL ? bus_name : "(none)",
5507 _g_dbus_debug_print_unlock ();
5510 if (message != NULL)
5511 g_object_unref (message);
5514 /* called in any thread, with the connection's lock not held */
5516 g_dbus_connection_call_finish_internal (GDBusConnection *connection,
5517 GUnixFDList **out_fd_list,
5525 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5526 g_return_val_if_fail (g_task_is_valid (res, connection), NULL);
5527 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5529 task = G_TASK (res);
5530 state = g_task_get_task_data (task);
5532 ret = g_task_propagate_pointer (task, error);
5536 if (out_fd_list != NULL)
5537 *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
5541 /* called in any user thread, with the connection's lock not held */
5543 g_dbus_connection_call_sync_internal (GDBusConnection *connection,
5544 const gchar *bus_name,
5545 const gchar *object_path,
5546 const gchar *interface_name,
5547 const gchar *method_name,
5548 GVariant *parameters,
5549 const GVariantType *reply_type,
5550 GDBusCallFlags flags,
5552 GUnixFDList *fd_list,
5553 GUnixFDList **out_fd_list,
5554 GCancellable *cancellable,
5557 GDBusMessage *message;
5558 GDBusMessage *reply;
5560 GError *local_error;
5561 GDBusSendMessageFlags send_flags;
5567 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5568 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
5569 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
5570 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
5571 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
5572 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
5573 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
5575 g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
5577 g_return_val_if_fail (fd_list == NULL, NULL);
5579 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5581 if (!(flags & CALL_FLAGS_INITIALIZING))
5582 g_return_val_if_fail (check_initialized (connection), FALSE);
5584 if (reply_type == NULL)
5585 reply_type = G_VARIANT_TYPE_ANY;
5587 message = g_dbus_message_new_method_call (bus_name,
5591 add_call_flags (message, flags);
5592 if (parameters != NULL)
5593 g_dbus_message_set_body (message, parameters);
5596 if (fd_list != NULL)
5597 g_dbus_message_set_unix_fd_list (message, fd_list);
5600 if (G_UNLIKELY (_g_dbus_debug_call ()))
5602 _g_dbus_debug_print_lock ();
5603 g_print ("========================================================================\n"
5604 "GDBus-debug:Call:\n"
5605 " >>>> SYNC %s.%s()\n"
5607 " owned by name %s\n",
5611 bus_name != NULL ? bus_name : "(none)");
5612 _g_dbus_debug_print_unlock ();
5617 send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
5619 /* translate from one flavour of flags to another... */
5620 if (flags & CALL_FLAGS_INITIALIZING)
5621 send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
5623 reply = g_dbus_connection_send_message_with_reply_sync (connection,
5627 NULL, /* volatile guint32 *out_serial */
5631 if (G_UNLIKELY (_g_dbus_debug_call ()))
5633 _g_dbus_debug_print_lock ();
5634 g_print ("========================================================================\n"
5635 "GDBus-debug:Call:\n"
5636 " <<<< SYNC COMPLETE %s.%s()\n"
5642 g_print ("SUCCESS\n");
5646 g_print ("FAILED: %s\n",
5647 local_error->message);
5649 _g_dbus_debug_print_unlock ();
5655 *error = local_error;
5657 g_error_free (local_error);
5661 result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
5664 if (message != NULL)
5665 g_object_unref (message);
5667 g_object_unref (reply);
5672 /* ---------------------------------------------------------------------------------------------------- */
5675 * g_dbus_connection_call:
5676 * @connection: a #GDBusConnection
5677 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
5678 * @connection is not a message bus connection
5679 * @object_path: path of remote object
5680 * @interface_name: D-Bus interface to invoke method on
5681 * @method_name: the name of the method to invoke
5682 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
5683 * or %NULL if not passing parameters
5684 * @reply_type: (allow-none): the expected type of the reply, or %NULL
5685 * @flags: flags from the #GDBusCallFlags enumeration
5686 * @timeout_msec: the timeout in milliseconds, -1 to use the default
5687 * timeout or %G_MAXINT for no timeout
5688 * @cancellable: (allow-none): a #GCancellable or %NULL
5689 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
5690 * is satisfied or %NULL if you don't care about the result of the
5692 * @user_data: the data to pass to @callback
5694 * Asynchronously invokes the @method_name method on the
5695 * @interface_name D-Bus interface on the remote object at
5696 * @object_path owned by @bus_name.
5698 * If @connection is closed then the operation will fail with
5699 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
5700 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
5701 * not compatible with the D-Bus protocol, the operation fails with
5702 * %G_IO_ERROR_INVALID_ARGUMENT.
5704 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
5705 * error will be raised if it does not match. Said another way, if you give a @reply_type
5706 * then any non-%NULL return value will be of this type.
5708 * If the @parameters #GVariant is floating, it is consumed. This allows
5709 * convenient 'inline' use of g_variant_new(), e.g.:
5710 * |[<!-- language="C" -->
5711 * g_dbus_connection_call (connection,
5712 * "org.freedesktop.StringThings",
5713 * "/org/freedesktop/StringThings",
5714 * "org.freedesktop.StringThings",
5716 * g_variant_new ("(ss)",
5720 * G_DBUS_CALL_FLAGS_NONE,
5723 * (GAsyncReadyCallback) two_strings_done,
5727 * This is an asynchronous method. When the operation is finished,
5728 * @callback will be invoked in the
5729 * [thread-default main context][g-main-context-push-thread-default]
5730 * of the thread you are calling this method from. You can then call
5731 * g_dbus_connection_call_finish() to get the result of the operation.
5732 * See g_dbus_connection_call_sync() for the synchronous version of this
5735 * If @callback is %NULL then the D-Bus method call message will be sent with
5736 * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
5741 g_dbus_connection_call (GDBusConnection *connection,
5742 const gchar *bus_name,
5743 const gchar *object_path,
5744 const gchar *interface_name,
5745 const gchar *method_name,
5746 GVariant *parameters,
5747 const GVariantType *reply_type,
5748 GDBusCallFlags flags,
5750 GCancellable *cancellable,
5751 GAsyncReadyCallback callback,
5754 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);
5758 * g_dbus_connection_call_finish:
5759 * @connection: a #GDBusConnection
5760 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call()
5761 * @error: return location for error or %NULL
5763 * Finishes an operation started with g_dbus_connection_call().
5765 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5766 * return values. Free with g_variant_unref().
5771 g_dbus_connection_call_finish (GDBusConnection *connection,
5775 return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
5779 * g_dbus_connection_call_sync:
5780 * @connection: a #GDBusConnection
5781 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
5782 * @connection is not a message bus connection
5783 * @object_path: path of remote object
5784 * @interface_name: D-Bus interface to invoke method on
5785 * @method_name: the name of the method to invoke
5786 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
5787 * or %NULL if not passing parameters
5788 * @reply_type: (allow-none): the expected type of the reply, or %NULL
5789 * @flags: flags from the #GDBusCallFlags enumeration
5790 * @timeout_msec: the timeout in milliseconds, -1 to use the default
5791 * timeout or %G_MAXINT for no timeout
5792 * @cancellable: (allow-none): a #GCancellable or %NULL
5793 * @error: return location for error or %NULL
5795 * Synchronously invokes the @method_name method on the
5796 * @interface_name D-Bus interface on the remote object at
5797 * @object_path owned by @bus_name.
5799 * If @connection is closed then the operation will fail with
5800 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
5801 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
5802 * contains a value not compatible with the D-Bus protocol, the operation
5803 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
5805 * If @reply_type is non-%NULL then the reply will be checked for having
5806 * this type and an error will be raised if it does not match. Said
5807 * another way, if you give a @reply_type then any non-%NULL return
5808 * value will be of this type.
5810 * If the @parameters #GVariant is floating, it is consumed.
5811 * This allows convenient 'inline' use of g_variant_new(), e.g.:
5812 * |[<!-- language="C" -->
5813 * g_dbus_connection_call_sync (connection,
5814 * "org.freedesktop.StringThings",
5815 * "/org/freedesktop/StringThings",
5816 * "org.freedesktop.StringThings",
5818 * g_variant_new ("(ss)",
5822 * G_DBUS_CALL_FLAGS_NONE,
5828 * The calling thread is blocked until a reply is received. See
5829 * g_dbus_connection_call() for the asynchronous version of
5832 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5833 * return values. Free with g_variant_unref().
5838 g_dbus_connection_call_sync (GDBusConnection *connection,
5839 const gchar *bus_name,
5840 const gchar *object_path,
5841 const gchar *interface_name,
5842 const gchar *method_name,
5843 GVariant *parameters,
5844 const GVariantType *reply_type,
5845 GDBusCallFlags flags,
5847 GCancellable *cancellable,
5850 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);
5853 /* ---------------------------------------------------------------------------------------------------- */
5858 * g_dbus_connection_call_with_unix_fd_list:
5859 * @connection: a #GDBusConnection
5860 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
5861 * @connection is not a message bus connection
5862 * @object_path: path of remote object
5863 * @interface_name: D-Bus interface to invoke method on
5864 * @method_name: the name of the method to invoke
5865 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
5866 * or %NULL if not passing parameters
5867 * @reply_type: (allow-none): the expected type of the reply, or %NULL
5868 * @flags: flags from the #GDBusCallFlags enumeration
5869 * @timeout_msec: the timeout in milliseconds, -1 to use the default
5870 * timeout or %G_MAXINT for no timeout
5871 * @fd_list: (allow-none): a #GUnixFDList or %NULL
5872 * @cancellable: (allow-none): a #GCancellable or %NULL
5873 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
5874 * satisfied or %NULL if you don't * care about the result of the
5876 * @user_data: The data to pass to @callback.
5878 * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
5880 * This method is only available on UNIX.
5885 g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
5886 const gchar *bus_name,
5887 const gchar *object_path,
5888 const gchar *interface_name,
5889 const gchar *method_name,
5890 GVariant *parameters,
5891 const GVariantType *reply_type,
5892 GDBusCallFlags flags,
5894 GUnixFDList *fd_list,
5895 GCancellable *cancellable,
5896 GAsyncReadyCallback callback,
5899 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);
5903 * g_dbus_connection_call_with_unix_fd_list_finish:
5904 * @connection: a #GDBusConnection
5905 * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
5906 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
5907 * g_dbus_connection_call_with_unix_fd_list()
5908 * @error: return location for error or %NULL
5910 * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
5912 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5913 * return values. Free with g_variant_unref().
5918 g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
5919 GUnixFDList **out_fd_list,
5923 return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
5927 * g_dbus_connection_call_with_unix_fd_list_sync:
5928 * @connection: a #GDBusConnection
5929 * @bus_name: (allow-none): a unique or well-known bus name or %NULL
5930 * if @connection is not a message bus connection
5931 * @object_path: path of remote object
5932 * @interface_name: D-Bus interface to invoke method on
5933 * @method_name: the name of the method to invoke
5934 * @parameters: (allow-none): a #GVariant tuple with parameters for
5935 * the method or %NULL if not passing parameters
5936 * @reply_type: (allow-none): the expected type of the reply, or %NULL
5937 * @flags: flags from the #GDBusCallFlags enumeration
5938 * @timeout_msec: the timeout in milliseconds, -1 to use the default
5939 * timeout or %G_MAXINT for no timeout
5940 * @fd_list: (allow-none): a #GUnixFDList or %NULL
5941 * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
5942 * @cancellable: (allow-none): a #GCancellable or %NULL
5943 * @error: return location for error or %NULL
5945 * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
5947 * This method is only available on UNIX.
5949 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5950 * return values. Free with g_variant_unref().
5955 g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
5956 const gchar *bus_name,
5957 const gchar *object_path,
5958 const gchar *interface_name,
5959 const gchar *method_name,
5960 GVariant *parameters,
5961 const GVariantType *reply_type,
5962 GDBusCallFlags flags,
5964 GUnixFDList *fd_list,
5965 GUnixFDList **out_fd_list,
5966 GCancellable *cancellable,
5969 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);
5972 #endif /* G_OS_UNIX */
5974 /* ---------------------------------------------------------------------------------------------------- */
5976 struct ExportedSubtree
5980 GDBusConnection *connection;
5981 GDBusSubtreeVTable *vtable;
5982 GDBusSubtreeFlags flags;
5984 GMainContext *context;
5986 GDestroyNotify user_data_free_func;
5990 exported_subtree_free (ExportedSubtree *es)
5992 call_destroy_notify (es->context,
5993 es->user_data_free_func,
5996 g_main_context_unref (es->context);
5998 _g_dbus_subtree_vtable_free (es->vtable);
5999 g_free (es->object_path);
6003 /* called without lock held in the thread where the caller registered
6007 handle_subtree_introspect (GDBusConnection *connection,
6008 ExportedSubtree *es,
6009 GDBusMessage *message)
6013 GDBusMessage *reply;
6016 const gchar *sender;
6017 const gchar *requested_object_path;
6018 const gchar *requested_node;
6019 GDBusInterfaceInfo **interfaces;
6021 gchar **subnode_paths;
6022 gboolean has_properties_interface;
6023 gboolean has_introspectable_interface;
6027 requested_object_path = g_dbus_message_get_path (message);
6028 sender = g_dbus_message_get_sender (message);
6029 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6031 s = g_string_new (NULL);
6032 introspect_append_header (s);
6034 /* Strictly we don't need the children in dynamic mode, but we avoid the
6035 * conditionals to preserve code clarity
6037 children = es->vtable->enumerate (es->connection,
6044 requested_node = strrchr (requested_object_path, '/') + 1;
6046 /* Assert existence of object if we are not dynamic */
6047 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
6048 !_g_strv_has_string ((const gchar * const *) children, requested_node))
6053 requested_node = NULL;
6056 interfaces = es->vtable->introspect (es->connection,
6061 if (interfaces != NULL)
6063 has_properties_interface = FALSE;
6064 has_introspectable_interface = FALSE;
6066 for (n = 0; interfaces[n] != NULL; n++)
6068 if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
6069 has_properties_interface = TRUE;
6070 else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
6071 has_introspectable_interface = TRUE;
6073 if (!has_properties_interface)
6074 g_string_append (s, introspect_properties_interface);
6075 if (!has_introspectable_interface)
6076 g_string_append (s, introspect_introspectable_interface);
6078 for (n = 0; interfaces[n] != NULL; n++)
6080 g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
6081 g_dbus_interface_info_unref (interfaces[n]);
6083 g_free (interfaces);
6086 /* then include <node> entries from the Subtree for the root */
6089 for (n = 0; children != NULL && children[n] != NULL; n++)
6090 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
6093 /* finally include nodes registered below us */
6094 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
6095 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
6096 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
6097 g_strfreev (subnode_paths);
6099 g_string_append (s, "</node>\n");
6101 reply = g_dbus_message_new_method_reply (message);
6102 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6103 g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6104 g_object_unref (reply);
6109 g_string_free (s, TRUE);
6110 g_strfreev (children);
6114 /* called without lock held in the thread where the caller registered
6118 handle_subtree_method_invocation (GDBusConnection *connection,
6119 ExportedSubtree *es,
6120 GDBusMessage *message)
6123 const gchar *sender;
6124 const gchar *interface_name;
6125 const gchar *member;
6126 const gchar *signature;
6127 const gchar *requested_object_path;
6128 const gchar *requested_node;
6130 GDBusInterfaceInfo *interface_info;
6131 const GDBusInterfaceVTable *interface_vtable;
6132 gpointer interface_user_data;
6134 GDBusInterfaceInfo **interfaces;
6135 gboolean is_property_get;
6136 gboolean is_property_set;
6137 gboolean is_property_get_all;
6142 requested_object_path = g_dbus_message_get_path (message);
6143 sender = g_dbus_message_get_sender (message);
6144 interface_name = g_dbus_message_get_interface (message);
6145 member = g_dbus_message_get_member (message);
6146 signature = g_dbus_message_get_signature (message);
6147 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6149 is_property_get = FALSE;
6150 is_property_set = FALSE;
6151 is_property_get_all = FALSE;
6152 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
6154 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
6155 is_property_get = TRUE;
6156 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
6157 is_property_set = TRUE;
6158 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
6159 is_property_get_all = TRUE;
6164 requested_node = strrchr (requested_object_path, '/') + 1;
6166 if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
6168 /* We don't want to dispatch to unenumerated
6169 * nodes, so ensure that the child exists.
6174 children = es->vtable->enumerate (es->connection,
6179 exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
6180 g_strfreev (children);
6188 requested_node = NULL;
6191 /* get introspection data for the node */
6192 interfaces = es->vtable->introspect (es->connection,
6194 requested_object_path,
6198 if (interfaces == NULL)
6201 interface_info = NULL;
6202 for (n = 0; interfaces[n] != NULL; n++)
6204 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6205 interface_info = interfaces[n];
6208 /* dispatch the call if the user wants to handle it */
6209 if (interface_info != NULL)
6211 /* figure out where to dispatch the method call */
6212 interface_user_data = NULL;
6213 interface_vtable = es->vtable->dispatch (es->connection,
6218 &interface_user_data,
6220 if (interface_vtable == NULL)
6223 CONNECTION_LOCK (connection);
6224 handled = validate_and_maybe_schedule_method_call (es->connection,
6231 interface_user_data);
6232 CONNECTION_UNLOCK (connection);
6234 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
6235 else if (is_property_get || is_property_set || is_property_get_all)
6237 if (is_property_get)
6238 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
6239 else if (is_property_set)
6240 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
6241 else if (is_property_get_all)
6242 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
6244 g_assert_not_reached ();
6246 /* see if the object supports this interface at all */
6247 for (n = 0; interfaces[n] != NULL; n++)
6249 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6250 interface_info = interfaces[n];
6253 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
6254 * claims it won't support the interface
6256 if (interface_info == NULL)
6258 GDBusMessage *reply;
6259 reply = g_dbus_message_new_method_error (message,
6260 "org.freedesktop.DBus.Error.InvalidArgs",
6261 _("No such interface '%s'"),
6263 g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6264 g_object_unref (reply);
6269 /* figure out where to dispatch the property get/set/getall calls */
6270 interface_user_data = NULL;
6271 interface_vtable = es->vtable->dispatch (es->connection,
6276 &interface_user_data,
6278 if (interface_vtable == NULL)
6280 g_warning ("The subtree introspection function indicates that '%s' "
6281 "is a valid interface name, but calling the dispatch "
6282 "function on that interface gave us NULL", interface_name);
6286 if (is_property_get || is_property_set)
6288 CONNECTION_LOCK (connection);
6289 handled = validate_and_maybe_schedule_property_getset (es->connection,
6297 interface_user_data);
6298 CONNECTION_UNLOCK (connection);
6300 else if (is_property_get_all)
6302 CONNECTION_LOCK (connection);
6303 handled = validate_and_maybe_schedule_property_get_all (es->connection,
6310 interface_user_data);
6311 CONNECTION_UNLOCK (connection);
6316 if (interfaces != NULL)
6318 for (n = 0; interfaces[n] != NULL; n++)
6319 g_dbus_interface_info_unref (interfaces[n]);
6320 g_free (interfaces);
6328 GDBusMessage *message;
6329 ExportedSubtree *es;
6330 } SubtreeDeferredData;
6333 subtree_deferred_data_free (SubtreeDeferredData *data)
6335 g_object_unref (data->message);
6339 /* called without lock held in the thread where the caller registered the subtree */
6341 process_subtree_vtable_message_in_idle_cb (gpointer _data)
6343 SubtreeDeferredData *data = _data;
6348 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
6349 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
6350 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
6351 handled = handle_subtree_introspect (data->es->connection,
6355 handled = handle_subtree_method_invocation (data->es->connection,
6361 CONNECTION_LOCK (data->es->connection);
6362 handled = handle_generic_unlocked (data->es->connection, data->message);
6363 CONNECTION_UNLOCK (data->es->connection);
6366 /* if we couldn't handle the request, just bail with the UnknownMethod error */
6369 GDBusMessage *reply;
6370 reply = g_dbus_message_new_method_error (data->message,
6371 "org.freedesktop.DBus.Error.UnknownMethod",
6372 _("Method '%s' on interface '%s' with signature '%s' does not exist"),
6373 g_dbus_message_get_member (data->message),
6374 g_dbus_message_get_interface (data->message),
6375 g_dbus_message_get_signature (data->message));
6376 g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6377 g_object_unref (reply);
6383 /* called in GDBusWorker thread with connection's lock held */
6385 subtree_message_func (GDBusConnection *connection,
6386 ExportedSubtree *es,
6387 GDBusMessage *message)
6389 GSource *idle_source;
6390 SubtreeDeferredData *data;
6392 data = g_new0 (SubtreeDeferredData, 1);
6393 data->message = g_object_ref (message);
6396 /* defer this call to an idle handler in the right thread */
6397 idle_source = g_idle_source_new ();
6398 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
6399 g_source_set_callback (idle_source,
6400 process_subtree_vtable_message_in_idle_cb,
6402 (GDestroyNotify) subtree_deferred_data_free);
6403 g_source_set_name (idle_source, "[gio] process_subtree_vtable_message_in_idle_cb");
6404 g_source_attach (idle_source, es->context);
6405 g_source_unref (idle_source);
6407 /* since we own the entire subtree, handlers for objects not in the subtree have been
6408 * tried already by libdbus-1 - so we just need to ensure that we're always going
6409 * to reply to the message
6415 * g_dbus_connection_register_subtree:
6416 * @connection: a #GDBusConnection
6417 * @object_path: the object path to register the subtree at
6418 * @vtable: a #GDBusSubtreeVTable to enumerate, introspect and
6419 * dispatch nodes in the subtree
6420 * @flags: flags used to fine tune the behavior of the subtree
6421 * @user_data: data to pass to functions in @vtable
6422 * @user_data_free_func: function to call when the subtree is unregistered
6423 * @error: return location for error or %NULL
6425 * Registers a whole subtree of dynamic objects.
6427 * The @enumerate and @introspection functions in @vtable are used to
6428 * convey, to remote callers, what nodes exist in the subtree rooted
6431 * When handling remote calls into any node in the subtree, first the
6432 * @enumerate function is used to check if the node exists. If the node exists
6433 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
6434 * the @introspection function is used to check if the node supports the
6435 * requested method. If so, the @dispatch function is used to determine
6436 * where to dispatch the call. The collected #GDBusInterfaceVTable and
6437 * #gpointer will be used to call into the interface vtable for processing
6440 * All calls into user-provided code will be invoked in the
6441 * [thread-default main context][g-main-context-push-thread-default]
6442 * of the thread you are calling this method from.
6444 * If an existing subtree is already registered at @object_path or
6445 * then @error is set to #G_IO_ERROR_EXISTS.
6447 * Note that it is valid to register regular objects (using
6448 * g_dbus_connection_register_object()) in a subtree registered with
6449 * g_dbus_connection_register_subtree() - if so, the subtree handler
6450 * is tried as the last resort. One way to think about a subtree
6451 * handler is to consider it a fallback handler for object paths not
6452 * registered via g_dbus_connection_register_object() or other bindings.
6454 * Note that @vtable will be copied so you cannot change it after
6457 * See this [server][gdbus-subtree-server] for an example of how to use
6460 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
6461 * that can be used with g_dbus_connection_unregister_subtree() .
6466 g_dbus_connection_register_subtree (GDBusConnection *connection,
6467 const gchar *object_path,
6468 const GDBusSubtreeVTable *vtable,
6469 GDBusSubtreeFlags flags,
6471 GDestroyNotify user_data_free_func,
6475 ExportedSubtree *es;
6477 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
6478 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
6479 g_return_val_if_fail (vtable != NULL, 0);
6480 g_return_val_if_fail (error == NULL || *error == NULL, 0);
6481 g_return_val_if_fail (check_initialized (connection), 0);
6485 CONNECTION_LOCK (connection);
6487 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6493 _("A subtree is already exported for %s"),
6498 es = g_new0 (ExportedSubtree, 1);
6499 es->object_path = g_strdup (object_path);
6500 es->connection = connection;
6502 es->vtable = _g_dbus_subtree_vtable_copy (vtable);
6504 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
6505 es->user_data = user_data;
6506 es->user_data_free_func = user_data_free_func;
6507 es->context = g_main_context_ref_thread_default ();
6509 g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
6510 g_hash_table_insert (connection->map_id_to_es,
6511 GUINT_TO_POINTER (es->id),
6517 CONNECTION_UNLOCK (connection);
6522 /* ---------------------------------------------------------------------------------------------------- */
6525 * g_dbus_connection_unregister_subtree:
6526 * @connection: a #GDBusConnection
6527 * @registration_id: a subtree registration id obtained from
6528 * g_dbus_connection_register_subtree()
6530 * Unregisters a subtree.
6532 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise
6537 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
6538 guint registration_id)
6540 ExportedSubtree *es;
6543 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
6544 g_return_val_if_fail (check_initialized (connection), FALSE);
6548 CONNECTION_LOCK (connection);
6550 es = g_hash_table_lookup (connection->map_id_to_es,
6551 GUINT_TO_POINTER (registration_id));
6555 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
6556 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
6561 CONNECTION_UNLOCK (connection);
6566 /* ---------------------------------------------------------------------------------------------------- */
6568 /* may be called in any thread, with connection's lock held */
6570 handle_generic_ping_unlocked (GDBusConnection *connection,
6571 const gchar *object_path,
6572 GDBusMessage *message)
6574 GDBusMessage *reply;
6575 reply = g_dbus_message_new_method_reply (message);
6576 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6577 g_object_unref (reply);
6580 /* may be called in any thread, with connection's lock held */
6582 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
6583 const gchar *object_path,
6584 GDBusMessage *message)
6586 GDBusMessage *reply;
6589 if (connection->machine_id == NULL)
6594 connection->machine_id = _g_dbus_get_machine_id (&error);
6595 if (connection->machine_id == NULL)
6597 reply = g_dbus_message_new_method_error_literal (message,
6598 "org.freedesktop.DBus.Error.Failed",
6600 g_error_free (error);
6606 reply = g_dbus_message_new_method_reply (message);
6607 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
6609 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6610 g_object_unref (reply);
6613 /* may be called in any thread, with connection's lock held */
6615 handle_generic_introspect_unlocked (GDBusConnection *connection,
6616 const gchar *object_path,
6617 GDBusMessage *message)
6622 GDBusMessage *reply;
6624 /* first the header */
6625 s = g_string_new (NULL);
6626 introspect_append_header (s);
6628 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
6629 for (n = 0; registered != NULL && registered[n] != NULL; n++)
6630 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
6631 g_strfreev (registered);
6632 g_string_append (s, "</node>\n");
6634 reply = g_dbus_message_new_method_reply (message);
6635 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6636 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6637 g_object_unref (reply);
6638 g_string_free (s, TRUE);
6641 /* may be called in any thread, with connection's lock held */
6643 handle_generic_unlocked (GDBusConnection *connection,
6644 GDBusMessage *message)
6647 const gchar *interface_name;
6648 const gchar *member;
6649 const gchar *signature;
6652 CONNECTION_ENSURE_LOCK (connection);
6656 interface_name = g_dbus_message_get_interface (message);
6657 member = g_dbus_message_get_member (message);
6658 signature = g_dbus_message_get_signature (message);
6659 path = g_dbus_message_get_path (message);
6661 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
6662 g_strcmp0 (member, "Introspect") == 0 &&
6663 g_strcmp0 (signature, "") == 0)
6665 handle_generic_introspect_unlocked (connection, path, message);
6668 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6669 g_strcmp0 (member, "Ping") == 0 &&
6670 g_strcmp0 (signature, "") == 0)
6672 handle_generic_ping_unlocked (connection, path, message);
6675 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6676 g_strcmp0 (member, "GetMachineId") == 0 &&
6677 g_strcmp0 (signature, "") == 0)
6679 handle_generic_get_machine_id_unlocked (connection, path, message);
6686 /* ---------------------------------------------------------------------------------------------------- */
6688 /* called in GDBusWorker thread with connection's lock held */
6690 distribute_method_call (GDBusConnection *connection,
6691 GDBusMessage *message)
6693 GDBusMessage *reply;
6695 ExportedSubtree *es;
6696 const gchar *object_path;
6697 const gchar *interface_name;
6698 const gchar *member;
6700 gchar *subtree_path;
6703 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
6705 interface_name = g_dbus_message_get_interface (message);
6706 member = g_dbus_message_get_member (message);
6707 path = g_dbus_message_get_path (message);
6708 subtree_path = g_strdup (path);
6709 needle = strrchr (subtree_path, '/');
6710 if (needle != NULL && needle != subtree_path)
6716 g_free (subtree_path);
6717 subtree_path = NULL;
6721 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
6723 _g_dbus_debug_print_lock ();
6724 g_print ("========================================================================\n"
6725 "GDBus-debug:Incoming:\n"
6726 " <<<< METHOD INVOCATION %s.%s()\n"
6728 " invoked by name %s\n"
6730 interface_name, member,
6732 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
6733 g_dbus_message_get_serial (message));
6734 _g_dbus_debug_print_unlock ();
6737 object_path = g_dbus_message_get_path (message);
6738 g_assert (object_path != NULL);
6740 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
6743 if (obj_message_func (connection, eo, message))
6747 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6750 if (subtree_message_func (connection, es, message))
6754 if (subtree_path != NULL)
6756 es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
6759 if (subtree_message_func (connection, es, message))
6764 if (handle_generic_unlocked (connection, message))
6767 /* if we end up here, the message has not been not handled - so return an error saying this */
6768 reply = g_dbus_message_new_method_error (message,
6769 "org.freedesktop.DBus.Error.UnknownMethod",
6770 _("No such interface '%s' on object at path %s"),
6773 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6774 g_object_unref (reply);
6777 g_free (subtree_path);
6780 /* ---------------------------------------------------------------------------------------------------- */
6782 /* Called in any user thread, with the message_bus_lock held. */
6784 message_bus_get_singleton (GBusType bus_type,
6788 const gchar *starter_bus;
6794 case G_BUS_TYPE_SESSION:
6795 ret = &the_session_bus;
6798 case G_BUS_TYPE_SYSTEM:
6799 ret = &the_system_bus;
6802 case G_BUS_TYPE_STARTER:
6803 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
6804 if (g_strcmp0 (starter_bus, "session") == 0)
6806 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
6809 else if (g_strcmp0 (starter_bus, "system") == 0)
6811 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
6816 if (starter_bus != NULL)
6820 G_IO_ERROR_INVALID_ARGUMENT,
6821 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
6822 " - unknown value '%s'"),
6827 g_set_error_literal (error,
6829 G_IO_ERROR_INVALID_ARGUMENT,
6830 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
6831 "variable is not set"));
6837 g_assert_not_reached ();
6845 /* Called in any user thread, without holding locks. */
6846 static GDBusConnection *
6847 get_uninitialized_connection (GBusType bus_type,
6848 GCancellable *cancellable,
6851 GWeakRef *singleton;
6852 GDBusConnection *ret;
6856 G_LOCK (message_bus_lock);
6857 singleton = message_bus_get_singleton (bus_type, error);
6858 if (singleton == NULL)
6861 ret = g_weak_ref_get (singleton);
6866 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
6867 if (address == NULL)
6869 ret = g_object_new (G_TYPE_DBUS_CONNECTION,
6871 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
6872 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
6873 "exit-on-close", TRUE,
6876 g_weak_ref_set (singleton, ret);
6880 g_assert (ret != NULL);
6883 G_UNLOCK (message_bus_lock);
6887 /* May be called from any thread. Must not hold message_bus_lock. */
6889 _g_bus_get_singleton_if_exists (GBusType bus_type)
6891 GWeakRef *singleton;
6892 GDBusConnection *ret = NULL;
6894 G_LOCK (message_bus_lock);
6895 singleton = message_bus_get_singleton (bus_type, NULL);
6896 if (singleton == NULL)
6899 ret = g_weak_ref_get (singleton);
6902 G_UNLOCK (message_bus_lock);
6908 * @bus_type: a #GBusType
6909 * @cancellable: (allow-none): a #GCancellable or %NULL
6910 * @error: return location for error or %NULL
6912 * Synchronously connects to the message bus specified by @bus_type.
6913 * Note that the returned object may shared with other callers,
6914 * e.g. if two separate parts of a process calls this function with
6915 * the same @bus_type, they will share the same object.
6917 * This is a synchronous failable function. See g_bus_get() and
6918 * g_bus_get_finish() for the asynchronous version.
6920 * The returned object is a singleton, that is, shared with other
6921 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6922 * event that you need a private message bus connection, use
6923 * g_dbus_address_get_for_bus_sync() and
6924 * g_dbus_connection_new_for_address().
6926 * Note that the returned #GDBusConnection object will (usually) have
6927 * the #GDBusConnection:exit-on-close property set to %TRUE.
6929 * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
6930 * Free with g_object_unref().
6935 g_bus_get_sync (GBusType bus_type,
6936 GCancellable *cancellable,
6939 GDBusConnection *connection;
6941 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6943 connection = get_uninitialized_connection (bus_type, cancellable, error);
6944 if (connection == NULL)
6947 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
6949 g_object_unref (connection);
6958 bus_get_async_initable_cb (GObject *source_object,
6962 GTask *task = user_data;
6963 GError *error = NULL;
6965 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
6969 g_assert (error != NULL);
6970 g_task_return_error (task, error);
6971 g_object_unref (source_object);
6975 g_task_return_pointer (task, source_object, g_object_unref);
6977 g_object_unref (task);
6982 * @bus_type: a #GBusType
6983 * @cancellable: (allow-none): a #GCancellable or %NULL
6984 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6985 * @user_data: the data to pass to @callback
6987 * Asynchronously connects to the message bus specified by @bus_type.
6989 * When the operation is finished, @callback will be invoked. You can
6990 * then call g_bus_get_finish() to get the result of the operation.
6992 * This is a asynchronous failable function. See g_bus_get_sync() for
6993 * the synchronous version.
6998 g_bus_get (GBusType bus_type,
6999 GCancellable *cancellable,
7000 GAsyncReadyCallback callback,
7003 GDBusConnection *connection;
7005 GError *error = NULL;
7007 task = g_task_new (NULL, cancellable, callback, user_data);
7009 connection = get_uninitialized_connection (bus_type, cancellable, &error);
7010 if (connection == NULL)
7012 g_assert (error != NULL);
7013 g_task_return_error (task, error);
7014 g_object_unref (task);
7018 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
7021 bus_get_async_initable_cb,
7028 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
7030 * @error: return location for error or %NULL
7032 * Finishes an operation started with g_bus_get().
7034 * The returned object is a singleton, that is, shared with other
7035 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7036 * event that you need a private message bus connection, use
7037 * g_dbus_address_get_for_bus_sync() and
7038 * g_dbus_connection_new_for_address().
7040 * Note that the returned #GDBusConnection object will (usually) have
7041 * the #GDBusConnection:exit-on-close property set to %TRUE.
7043 * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
7044 * Free with g_object_unref().
7049 g_bus_get_finish (GAsyncResult *res,
7052 g_return_val_if_fail (g_task_is_valid (res, NULL), NULL);
7053 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7055 return g_task_propagate_pointer (G_TASK (res), error);
7058 /* ---------------------------------------------------------------------------------------------------- */