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"
122 #include "gsimpleasyncresult.h"
126 #include "gunixconnection.h"
127 #include "gunixfdmessage.h"
130 #include "glibintl.h"
133 * SECTION:gdbusconnection
134 * @short_description: D-Bus Connections
135 * @include: gio/gio.h
137 * The #GDBusConnection type is used for D-Bus connections to remote
138 * peers such as a message buses. It is a low-level API that offers a
139 * lot of flexibility. For instance, it lets you establish a connection
140 * over any transport that can by represented as an #GIOStream.
142 * This class is rarely used directly in D-Bus clients. If you are writing
143 * a D-Bus client, it is often easier to use the g_bus_own_name(),
144 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
146 * As an exception to the usual GLib rule that a particular object must not
147 * be used by two threads at the same time, #GDBusConnection's methods may be
148 * called from any thread. This is so that g_bus_get() and g_bus_get_sync()
149 * can safely return the same #GDBusConnection when called from any thread.
151 * Most of the ways to obtain a #GDBusConnection automatically initialize it
152 * (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
153 * g_bus_get(), and the synchronous versions of those methods, give you an
154 * initialized connection. Language bindings for GIO should use
155 * g_initable_new() or g_async_initable_new_async(), which also initialize the
158 * If you construct an uninitialized #GDBusConnection, such as via
159 * g_object_new(), you must initialize it via g_initable_init() or
160 * g_async_initable_init_async() before using its methods or properties.
161 * Calling methods or accessing properties on a #GDBusConnection that has not
162 * completed initialization successfully is considered to be invalid, and leads
163 * to undefined behaviour. In particular, if initialization fails with a
164 * #GError, the only valid thing you can do with that #GDBusConnection is to
165 * free it with g_object_unref().
167 * ## An example D-Bus server # {#gdbus-server}
169 * Here is an example for a D-Bus server:
170 * [gdbus-example-server.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-server.c)
172 * ## An example for exporting a subtree # {#gdbus-subtree-server}
174 * Here is an example for exporting a subtree:
175 * [gdbus-example-subtree.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-subtree.c)
177 * ## An example for file descriptor passing # {#gdbus-unix-fd-client}
179 * Here is an example for passing UNIX file descriptors:
180 * [gdbus-unix-fd-client.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-unix-fd-client.c)
182 * ## An example for exporting a GObject # {#gdbus-export}
184 * Here is an example for exporting a #GObject:
185 * [gdbus-example-export.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-export.c)
188 /* ---------------------------------------------------------------------------------------------------- */
190 typedef struct _GDBusConnectionClass GDBusConnectionClass;
193 * GDBusConnectionClass:
194 * @closed: Signal class handler for the #GDBusConnection::closed signal.
196 * Class structure for #GDBusConnection.
200 struct _GDBusConnectionClass
203 GObjectClass parent_class;
207 void (*closed) (GDBusConnection *connection,
208 gboolean remote_peer_vanished,
212 G_LOCK_DEFINE_STATIC (message_bus_lock);
214 static GWeakRef the_session_bus;
215 static GWeakRef the_system_bus;
216 static GWeakRef the_user_bus;
217 static GWeakRef the_machine_bus;
219 /* Extra pseudo-member of GDBusSendMessageFlags.
220 * Set by initable_init() to indicate that despite not being initialized yet,
221 * enough of the only-valid-after-init members are set that we can send a
222 * message, and we're being called from its thread, so no memory barrier is
223 * required before accessing them.
225 #define SEND_MESSAGE_FLAGS_INITIALIZING (1<<31)
227 /* Same as SEND_MESSAGE_FLAGS_INITIALIZING, but in GDBusCallFlags */
228 #define CALL_FLAGS_INITIALIZING (1<<31)
230 /* ---------------------------------------------------------------------------------------------------- */
234 GDestroyNotify callback;
236 GMainContext *context;
237 } CallDestroyNotifyData;
240 call_destroy_notify_data_in_idle (gpointer user_data)
242 CallDestroyNotifyData *data = user_data;
243 data->callback (data->user_data);
248 call_destroy_notify_data_free (CallDestroyNotifyData *data)
250 if (data->context != NULL)
251 g_main_context_unref (data->context);
256 * call_destroy_notify: <internal>
257 * @context: (allow-none): A #GMainContext or %NULL.
258 * @callback: (allow-none): A #GDestroyNotify or %NULL.
259 * @user_data: Data to pass to @callback.
261 * Schedules @callback to run in @context.
264 call_destroy_notify (GMainContext *context,
265 GDestroyNotify callback,
268 GSource *idle_source;
269 CallDestroyNotifyData *data;
271 if (callback == NULL)
274 data = g_new0 (CallDestroyNotifyData, 1);
275 data->callback = callback;
276 data->user_data = user_data;
277 data->context = context;
278 if (data->context != NULL)
279 g_main_context_ref (data->context);
281 idle_source = g_idle_source_new ();
282 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
283 g_source_set_callback (idle_source,
284 call_destroy_notify_data_in_idle,
286 (GDestroyNotify) call_destroy_notify_data_free);
287 g_source_set_name (idle_source, "[gio] call_destroy_notify_data_in_idle");
288 g_source_attach (idle_source, data->context);
289 g_source_unref (idle_source);
295 /* ---------------------------------------------------------------------------------------------------- */
298 _g_strv_has_string (const gchar* const *haystack,
303 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
305 if (g_strcmp0 (haystack[n], needle) == 0)
311 /* ---------------------------------------------------------------------------------------------------- */
314 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
316 // TODO: for some reason this doesn't work on Windows
317 #define CONNECTION_ENSURE_LOCK(obj) do { \
318 if (G_UNLIKELY (g_mutex_trylock(&(obj)->lock))) \
320 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
321 "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
326 #define CONNECTION_LOCK(obj) do { \
327 g_mutex_lock (&(obj)->lock); \
330 #define CONNECTION_UNLOCK(obj) do { \
331 g_mutex_unlock (&(obj)->lock); \
334 /* Flags in connection->atomic_flags */
336 FLAG_INITIALIZED = 1 << 0,
337 FLAG_EXIT_ON_CLOSE = 1 << 1,
344 * The #GDBusConnection structure contains only private data and
345 * should only be accessed using the provided API.
349 struct _GDBusConnection
352 GObject parent_instance;
354 /* ------------------------------------------------------------------------ */
355 /* -- General object state ------------------------------------------------ */
356 /* ------------------------------------------------------------------------ */
358 /* General-purpose lock for most fields */
361 /* A lock used in the init() method of the GInitable interface - see comments
362 * in initable_init() for why a separate lock is needed.
364 * If you need both @lock and @init_lock, you must take @init_lock first.
368 /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
369 * someone calls org.freedesktop.DBus.Peer.GetMachineId(). Protected by @lock.
373 /* The underlying stream used for communication
374 * Read-only after initable_init(), so it may be read if you either
375 * hold @init_lock or check for initialization first.
379 /* The object used for authentication (if any).
380 * Read-only after initable_init(), so it may be read if you either
381 * hold @init_lock or check for initialization first.
385 /* Last serial used. Protected by @lock. */
388 /* The object used to send/receive messages.
389 * Read-only after initable_init(), so it may be read if you either
390 * hold @init_lock or check for initialization first.
393 GKDBusWorker *kdbus_worker;
395 /* If connected to a message bus, this contains the unique name assigned to
396 * us by the bus (e.g. ":1.42").
397 * Read-only after initable_init(), so it may be read if you either
398 * hold @init_lock or check for initialization first.
400 gchar *bus_unique_name;
402 /* The GUID returned by the other side if we authenticed as a client or
403 * the GUID to use if authenticating as a server.
404 * Read-only after initable_init(), so it may be read if you either
405 * hold @init_lock or check for initialization first.
409 /* FLAG_INITIALIZED is set exactly when initable_init() has finished running.
410 * Inspect @initialization_error to see whether it succeeded or failed.
412 * FLAG_EXIT_ON_CLOSE is the exit-on-close property.
414 * FLAG_CLOSED is the closed property. It may be read at any time, but
415 * may only be written while holding @lock.
417 volatile gint atomic_flags;
419 /* If the connection could not be established during initable_init(),
420 * this GError will be set.
421 * Read-only after initable_init(), so it may be read if you either
422 * hold @init_lock or check for initialization first.
424 GError *initialization_error;
426 /* The result of g_main_context_ref_thread_default() when the object
427 * was created (the GObject _init() function) - this is used for delivery
428 * of the :closed GObject signal.
430 * Only set in the GObject init function, so no locks are needed.
432 GMainContext *main_context_at_construction;
434 /* Read-only construct properties, no locks needed */
436 GDBusConnectionFlags flags;
438 /* Map used for managing method replies, protected by @lock */
439 GHashTable *map_method_serial_to_send_message_data; /* guint32 -> SendMessageData* */
441 /* Maps used for managing signal subscription, protected by @lock */
442 GHashTable *map_rule_to_signal_data; /* match rule (gchar*) -> SignalData */
443 GHashTable *map_id_to_signal_data; /* id (guint) -> SignalData */
444 GHashTable *map_sender_unique_name_to_signal_data_array; /* unique sender (gchar*) -> GPtrArray* of SignalData */
446 /* Maps used for managing exported objects and subtrees,
449 GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
450 GHashTable *map_id_to_ei; /* guint -> ExportedInterface* */
451 GHashTable *map_object_path_to_es; /* gchar* -> ExportedSubtree* */
452 GHashTable *map_id_to_es; /* guint -> ExportedSubtree* */
454 /* Map used for storing last used serials for each thread, protected by @lock */
455 GHashTable *map_thread_to_last_serial;
457 /* Structure used for message filters, protected by @lock */
460 /* Capabilities negotiated during authentication
461 * Read-only after initable_init(), so it may be read without holding a
462 * lock, if you check for initialization first.
464 GDBusCapabilityFlags capabilities;
466 /* Protected by @init_lock */
467 GDBusAuthObserver *authentication_observer;
469 /* Read-only after initable_init(), so it may be read if you either
470 * hold @init_lock or check for initialization first.
472 GCredentials *credentials;
474 /* set to TRUE when finalizing */
478 typedef struct ExportedObject ExportedObject;
479 static void exported_object_free (ExportedObject *eo);
481 typedef struct ExportedSubtree ExportedSubtree;
482 static void exported_subtree_free (ExportedSubtree *es);
500 PROP_CAPABILITY_FLAGS,
501 PROP_AUTHENTICATION_OBSERVER,
504 static void distribute_signals (GDBusConnection *connection,
505 GDBusMessage *message);
507 static void distribute_method_call (GDBusConnection *connection,
508 GDBusMessage *message);
510 static gboolean handle_generic_unlocked (GDBusConnection *connection,
511 GDBusMessage *message);
514 static void purge_all_signal_subscriptions (GDBusConnection *connection);
515 static void purge_all_filters (GDBusConnection *connection);
517 static void schedule_method_call (GDBusConnection *connection,
518 GDBusMessage *message,
519 guint registration_id,
520 guint subtree_registration_id,
521 const GDBusInterfaceInfo *interface_info,
522 const GDBusMethodInfo *method_info,
523 const GDBusPropertyInfo *property_info,
524 GVariant *parameters,
525 const GDBusInterfaceVTable *vtable,
526 GMainContext *main_context,
529 #define _G_ENSURE_LOCK(name) do { \
530 if (G_UNLIKELY (G_TRYLOCK(name))) \
532 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
533 "_G_ENSURE_LOCK: Lock '" #name "' is not locked"); \
537 static guint signals[LAST_SIGNAL] = { 0 };
539 static void initable_iface_init (GInitableIface *initable_iface);
540 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
542 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
543 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
544 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
548 * Check that all members of @connection that can only be accessed after
549 * the connection is initialized can safely be accessed. If not,
550 * log a critical warning. This function is a memory barrier.
552 * Returns: %TRUE if initialized
555 check_initialized (GDBusConnection *connection)
557 /* The access to @atomic_flags isn't conditional, so that this function
558 * provides a memory barrier for thread-safety even if checks are disabled.
559 * (If you don't want this stricter guarantee, you can call
560 * g_return_if_fail (check_initialized (c)).)
562 * This isn't strictly necessary now that we've decided use of an
563 * uninitialized GDBusConnection is undefined behaviour, but it seems
564 * better to be as deterministic as is feasible.
566 * (Anything that could suffer a crash from seeing undefined values
567 * must have a race condition - thread A initializes the connection while
568 * thread B calls a method without initialization, hoping that thread A will
569 * win the race - so its behaviour is undefined anyway.)
571 gint flags = g_atomic_int_get (&connection->atomic_flags);
573 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
575 /* We can safely access this, due to the memory barrier above */
576 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
582 MAY_BE_UNINITIALIZED = (1<<1)
583 } CheckUnclosedFlags;
586 * Check the same thing as check_initialized(), and also that the
587 * connection is not closed. If the connection is uninitialized,
588 * raise a critical warning (it's programmer error); if it's closed,
589 * raise a recoverable GError (it's a runtime error).
591 * This function is a memory barrier.
593 * Returns: %TRUE if initialized and not closed
596 check_unclosed (GDBusConnection *connection,
597 CheckUnclosedFlags check,
600 /* check_initialized() is effectively inlined, so we don't waste time
601 * doing two memory barriers
603 gint flags = g_atomic_int_get (&connection->atomic_flags);
605 if (!(check & MAY_BE_UNINITIALIZED))
607 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
608 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
611 if (flags & FLAG_CLOSED)
613 g_set_error_literal (error,
616 _("The connection is closed"));
623 static GHashTable *alive_connections = NULL;
626 g_dbus_connection_dispose (GObject *object)
628 GDBusConnection *connection = G_DBUS_CONNECTION (object);
630 G_LOCK (message_bus_lock);
631 CONNECTION_LOCK (connection);
632 if (connection->worker != NULL)
634 _g_dbus_worker_stop (connection->worker);
635 connection->worker = NULL;
636 if (alive_connections != NULL)
637 g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
641 if (alive_connections != NULL)
642 g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
644 CONNECTION_UNLOCK (connection);
645 G_UNLOCK (message_bus_lock);
647 if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
648 G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
652 g_dbus_connection_finalize (GObject *object)
654 GDBusConnection *connection = G_DBUS_CONNECTION (object);
656 connection->finalizing = TRUE;
658 purge_all_signal_subscriptions (connection);
660 purge_all_filters (connection);
661 g_ptr_array_unref (connection->filters);
663 if (connection->authentication_observer != NULL)
664 g_object_unref (connection->authentication_observer);
666 if (connection->auth != NULL)
667 g_object_unref (connection->auth);
669 if (connection->credentials)
670 g_object_unref (connection->credentials);
672 if (connection->stream != NULL)
674 g_object_unref (connection->stream);
675 connection->stream = NULL;
678 g_free (connection->address);
680 g_free (connection->guid);
681 g_free (connection->bus_unique_name);
683 if (connection->initialization_error != NULL)
684 g_error_free (connection->initialization_error);
686 g_hash_table_unref (connection->map_method_serial_to_send_message_data);
688 g_hash_table_unref (connection->map_rule_to_signal_data);
689 g_hash_table_unref (connection->map_id_to_signal_data);
690 g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
692 g_hash_table_unref (connection->map_id_to_ei);
693 g_hash_table_unref (connection->map_object_path_to_eo);
694 g_hash_table_unref (connection->map_id_to_es);
695 g_hash_table_unref (connection->map_object_path_to_es);
697 g_hash_table_unref (connection->map_thread_to_last_serial);
699 g_main_context_unref (connection->main_context_at_construction);
701 g_free (connection->machine_id);
703 g_mutex_clear (&connection->init_lock);
704 g_mutex_clear (&connection->lock);
706 G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
709 /* called in any user thread, with the connection's lock not held */
711 g_dbus_connection_get_property (GObject *object,
716 GDBusConnection *connection = G_DBUS_CONNECTION (object);
721 g_value_set_object (value, g_dbus_connection_get_stream (connection));
725 g_value_set_string (value, g_dbus_connection_get_guid (connection));
728 case PROP_UNIQUE_NAME:
729 g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
733 g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
736 case PROP_EXIT_ON_CLOSE:
737 g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
740 case PROP_CAPABILITY_FLAGS:
741 g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
745 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
750 /* called in any user thread, with the connection's lock not held */
752 g_dbus_connection_set_property (GObject *object,
757 GDBusConnection *connection = G_DBUS_CONNECTION (object);
762 connection->stream = g_value_dup_object (value);
766 connection->guid = g_value_dup_string (value);
770 connection->address = g_value_dup_string (value);
774 connection->flags = g_value_get_flags (value);
777 case PROP_EXIT_ON_CLOSE:
778 g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
781 case PROP_AUTHENTICATION_OBSERVER:
782 connection->authentication_observer = g_value_dup_object (value);
786 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
791 /* Base-class implementation of GDBusConnection::closed.
793 * Called in a user thread, by the main context that was thread-default when
794 * the object was constructed.
797 g_dbus_connection_real_closed (GDBusConnection *connection,
798 gboolean remote_peer_vanished,
801 gint flags = g_atomic_int_get (&connection->atomic_flags);
803 /* Because atomic int access is a memory barrier, we can safely read
804 * initialization_error without a lock, as long as we do it afterwards.
806 if (remote_peer_vanished &&
807 (flags & FLAG_EXIT_ON_CLOSE) != 0 &&
808 (flags & FLAG_INITIALIZED) != 0 &&
809 connection->initialization_error == NULL)
813 g_printerr ("%s: Remote peer vanished with error: %s (%s, %d). Exiting.\n",
816 g_quark_to_string (error->domain), error->code);
820 g_printerr ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
827 g_dbus_connection_class_init (GDBusConnectionClass *klass)
829 GObjectClass *gobject_class;
831 gobject_class = G_OBJECT_CLASS (klass);
833 gobject_class->finalize = g_dbus_connection_finalize;
834 gobject_class->dispose = g_dbus_connection_dispose;
835 gobject_class->set_property = g_dbus_connection_set_property;
836 gobject_class->get_property = g_dbus_connection_get_property;
838 klass->closed = g_dbus_connection_real_closed;
841 * GDBusConnection:stream:
843 * The underlying #GIOStream used for I/O.
845 * If this is passed on construction and is a #GSocketConnection,
846 * then the corresponding #GSocket will be put into non-blocking mode.
848 * While the #GDBusConnection is active, it will interact with this
849 * stream from a worker thread, so it is not safe to interact with
850 * the stream directly.
854 g_object_class_install_property (gobject_class,
856 g_param_spec_object ("stream",
858 P_("The underlying streams used for I/O"),
862 G_PARAM_CONSTRUCT_ONLY |
863 G_PARAM_STATIC_NAME |
864 G_PARAM_STATIC_BLURB |
865 G_PARAM_STATIC_NICK));
868 * GDBusConnection:address:
870 * A D-Bus address specifying potential endpoints that can be used
871 * when establishing the connection.
875 g_object_class_install_property (gobject_class,
877 g_param_spec_string ("address",
879 P_("D-Bus address specifying potential socket endpoints"),
882 G_PARAM_CONSTRUCT_ONLY |
883 G_PARAM_STATIC_NAME |
884 G_PARAM_STATIC_BLURB |
885 G_PARAM_STATIC_NICK));
888 * GDBusConnection:flags:
890 * Flags from the #GDBusConnectionFlags enumeration.
894 g_object_class_install_property (gobject_class,
896 g_param_spec_flags ("flags",
899 G_TYPE_DBUS_CONNECTION_FLAGS,
900 G_DBUS_CONNECTION_FLAGS_NONE,
902 G_PARAM_CONSTRUCT_ONLY |
903 G_PARAM_STATIC_NAME |
904 G_PARAM_STATIC_BLURB |
905 G_PARAM_STATIC_NICK));
908 * GDBusConnection:guid:
910 * The GUID of the peer performing the role of server when
913 * If you are constructing a #GDBusConnection and pass
914 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
915 * #GDBusConnection:flags property then you MUST also set this
916 * property to a valid guid.
918 * If you are constructing a #GDBusConnection and pass
919 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
920 * #GDBusConnection:flags property you will be able to read the GUID
921 * of the other peer here after the connection has been successfully
926 g_object_class_install_property (gobject_class,
928 g_param_spec_string ("guid",
930 P_("GUID of the server peer"),
934 G_PARAM_CONSTRUCT_ONLY |
935 G_PARAM_STATIC_NAME |
936 G_PARAM_STATIC_BLURB |
937 G_PARAM_STATIC_NICK));
940 * GDBusConnection:unique-name:
942 * The unique name as assigned by the message bus or %NULL if the
943 * connection is not open or not a message bus connection.
947 g_object_class_install_property (gobject_class,
949 g_param_spec_string ("unique-name",
951 P_("Unique name of bus connection"),
954 G_PARAM_STATIC_NAME |
955 G_PARAM_STATIC_BLURB |
956 G_PARAM_STATIC_NICK));
959 * GDBusConnection:closed:
961 * A boolean specifying whether the connection has been closed.
965 g_object_class_install_property (gobject_class,
967 g_param_spec_boolean ("closed",
969 P_("Whether the connection is closed"),
972 G_PARAM_STATIC_NAME |
973 G_PARAM_STATIC_BLURB |
974 G_PARAM_STATIC_NICK));
977 * GDBusConnection:exit-on-close:
979 * A boolean specifying whether the process will be terminated (by
980 * calling `raise(SIGTERM)`) if the connection is closed by the
983 * Note that #GDBusConnection objects returned by g_bus_get_finish()
984 * and g_bus_get_sync() will (usually) have this property set to %TRUE.
988 g_object_class_install_property (gobject_class,
990 g_param_spec_boolean ("exit-on-close",
992 P_("Whether the process is terminated when the connection is closed"),
996 G_PARAM_STATIC_NAME |
997 G_PARAM_STATIC_BLURB |
998 G_PARAM_STATIC_NICK));
1001 * GDBusConnection:capabilities:
1003 * Flags from the #GDBusCapabilityFlags enumeration
1004 * representing connection features negotiated with the other peer.
1008 g_object_class_install_property (gobject_class,
1009 PROP_CAPABILITY_FLAGS,
1010 g_param_spec_flags ("capabilities",
1013 G_TYPE_DBUS_CAPABILITY_FLAGS,
1014 G_DBUS_CAPABILITY_FLAGS_NONE,
1016 G_PARAM_STATIC_NAME |
1017 G_PARAM_STATIC_BLURB |
1018 G_PARAM_STATIC_NICK));
1021 * GDBusConnection:authentication-observer:
1023 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
1027 g_object_class_install_property (gobject_class,
1028 PROP_AUTHENTICATION_OBSERVER,
1029 g_param_spec_object ("authentication-observer",
1030 P_("Authentication Observer"),
1031 P_("Object used to assist in the authentication process"),
1032 G_TYPE_DBUS_AUTH_OBSERVER,
1034 G_PARAM_CONSTRUCT_ONLY |
1035 G_PARAM_STATIC_NAME |
1036 G_PARAM_STATIC_BLURB |
1037 G_PARAM_STATIC_NICK));
1040 * GDBusConnection::closed:
1041 * @connection: the #GDBusConnection emitting the signal
1042 * @remote_peer_vanished: %TRUE if @connection is closed because the
1043 * remote peer closed its end of the connection
1044 * @error: (allow-none): a #GError with more details about the event or %NULL
1046 * Emitted when the connection is closed.
1048 * The cause of this event can be
1050 * - If g_dbus_connection_close() is called. In this case
1051 * @remote_peer_vanished is set to %FALSE and @error is %NULL.
1053 * - If the remote peer closes the connection. In this case
1054 * @remote_peer_vanished is set to %TRUE and @error is set.
1056 * - If the remote peer sends invalid or malformed data. In this
1057 * case @remote_peer_vanished is set to %FALSE and @error is set.
1059 * Upon receiving this signal, you should give up your reference to
1060 * @connection. You are guaranteed that this signal is emitted only
1065 signals[CLOSED_SIGNAL] = g_signal_new ("closed",
1066 G_TYPE_DBUS_CONNECTION,
1068 G_STRUCT_OFFSET (GDBusConnectionClass, closed),
1079 g_dbus_connection_init (GDBusConnection *connection)
1081 g_mutex_init (&connection->lock);
1082 g_mutex_init (&connection->init_lock);
1084 connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
1086 connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
1088 connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
1090 connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
1093 (GDestroyNotify) g_ptr_array_unref);
1095 connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
1098 (GDestroyNotify) exported_object_free);
1100 connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
1103 connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
1106 (GDestroyNotify) exported_subtree_free);
1108 connection->map_id_to_es = g_hash_table_new (g_direct_hash,
1111 connection->map_thread_to_last_serial = g_hash_table_new (g_direct_hash,
1114 connection->main_context_at_construction = g_main_context_ref_thread_default ();
1116 connection->filters = g_ptr_array_new ();
1120 * g_dbus_connection_get_stream:
1121 * @connection: a #GDBusConnection
1123 * Gets the underlying stream used for IO.
1125 * While the #GDBusConnection is active, it will interact with this
1126 * stream from a worker thread, so it is not safe to interact with
1127 * the stream directly.
1129 * Returns: (transfer none): the stream used for IO
1134 g_dbus_connection_get_stream (GDBusConnection *connection)
1136 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1138 /* do not use g_return_val_if_fail(), we want the memory barrier */
1139 if (!check_initialized (connection))
1142 return connection->stream;
1146 * g_dbus_connection_start_message_processing:
1147 * @connection: a #GDBusConnection
1149 * If @connection was created with
1150 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
1151 * starts processing messages. Does nothing on if @connection wasn't
1152 * created with this flag or if the method has already been called.
1157 g_dbus_connection_start_message_processing (GDBusConnection *connection)
1159 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1161 /* do not use g_return_val_if_fail(), we want the memory barrier */
1162 if (!check_initialized (connection))
1165 g_assert (connection->worker || connection->kdbus_worker);
1167 if (connection->kdbus_worker)
1168 g_kdbus_worker_unfreeze (connection->kdbus_worker);
1170 _g_dbus_worker_unfreeze (connection->worker);
1174 * g_dbus_connection_is_closed:
1175 * @connection: a #GDBusConnection
1177 * Gets whether @connection is closed.
1179 * Returns: %TRUE if the connection is closed, %FALSE otherwise
1184 g_dbus_connection_is_closed (GDBusConnection *connection)
1188 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1190 flags = g_atomic_int_get (&connection->atomic_flags);
1192 return (flags & FLAG_CLOSED) ? TRUE : FALSE;
1196 * g_dbus_connection_get_capabilities:
1197 * @connection: a #GDBusConnection
1199 * Gets the capabilities negotiated with the remote peer
1201 * Returns: zero or more flags from the #GDBusCapabilityFlags enumeration
1205 GDBusCapabilityFlags
1206 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1208 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1210 /* do not use g_return_val_if_fail(), we want the memory barrier */
1211 if (!check_initialized (connection))
1212 return G_DBUS_CAPABILITY_FLAGS_NONE;
1214 return connection->capabilities;
1217 /* ---------------------------------------------------------------------------------------------------- */
1219 /* Called in a temporary thread without holding locks. */
1221 flush_in_thread_func (GSimpleAsyncResult *res,
1223 GCancellable *cancellable)
1228 if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
1231 g_simple_async_result_take_error (res, error);
1235 * g_dbus_connection_flush:
1236 * @connection: a #GDBusConnection
1237 * @cancellable: (allow-none): a #GCancellable or %NULL
1238 * @callback: (allow-none): a #GAsyncReadyCallback to call when the
1239 * request is satisfied or %NULL if you don't care about the result
1240 * @user_data: The data to pass to @callback
1242 * Asynchronously flushes @connection, that is, writes all queued
1243 * outgoing message to the transport and then flushes the transport
1244 * (using g_output_stream_flush_async()). This is useful in programs
1245 * that wants to emit a D-Bus signal and then exit immediately. Without
1246 * flushing the connection, there is no guaranteed that the message has
1247 * been sent to the networking buffers in the OS kernel.
1249 * This is an asynchronous method. When the operation is finished,
1250 * @callback will be invoked in the
1251 * [thread-default main context][g-main-context-push-thread-default]
1252 * of the thread you are calling this method from. You can
1253 * then call g_dbus_connection_flush_finish() to get the result of the
1254 * operation. See g_dbus_connection_flush_sync() for the synchronous
1260 g_dbus_connection_flush (GDBusConnection *connection,
1261 GCancellable *cancellable,
1262 GAsyncReadyCallback callback,
1265 GSimpleAsyncResult *simple;
1267 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1269 simple = g_simple_async_result_new (G_OBJECT (connection),
1272 g_dbus_connection_flush);
1273 g_simple_async_result_set_check_cancellable (simple, cancellable);
1274 g_simple_async_result_run_in_thread (simple,
1275 flush_in_thread_func,
1278 g_object_unref (simple);
1282 * g_dbus_connection_flush_finish:
1283 * @connection: a #GDBusConnection
1284 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1285 * to g_dbus_connection_flush()
1286 * @error: return location for error or %NULL
1288 * Finishes an operation started with g_dbus_connection_flush().
1290 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1295 g_dbus_connection_flush_finish (GDBusConnection *connection,
1299 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1304 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1305 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1306 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1308 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
1310 if (g_simple_async_result_propagate_error (simple, error))
1320 * g_dbus_connection_flush_sync:
1321 * @connection: a #GDBusConnection
1322 * @cancellable: (allow-none): a #GCancellable or %NULL
1323 * @error: return location for error or %NULL
1325 * Synchronously flushes @connection. The calling thread is blocked
1326 * until this is done. See g_dbus_connection_flush() for the
1327 * asynchronous version of this method and more details about what it
1330 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1335 g_dbus_connection_flush_sync (GDBusConnection *connection,
1336 GCancellable *cancellable,
1341 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1342 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1346 /* This is only a best-effort attempt to see whether the connection is
1347 * closed, so it doesn't need the lock. If the connection closes just
1348 * after this check, but before scheduling the flush operation, the
1349 * result will be more or less the same as if the connection closed while
1350 * the flush operation was pending - it'll fail with either CLOSED or
1353 if (!check_unclosed (connection, 0, error))
1356 if (connection->kdbus_worker)
1362 g_assert (connection->worker != NULL);
1364 ret = _g_dbus_worker_flush_sync (connection->worker,
1372 /* ---------------------------------------------------------------------------------------------------- */
1376 GDBusConnection *connection;
1378 gboolean remote_peer_vanished;
1382 emit_closed_data_free (EmitClosedData *data)
1384 g_object_unref (data->connection);
1385 if (data->error != NULL)
1386 g_error_free (data->error);
1390 /* Called in a user thread that has acquired the main context that was
1391 * thread-default when the object was constructed
1394 emit_closed_in_idle (gpointer user_data)
1396 EmitClosedData *data = user_data;
1399 g_object_notify (G_OBJECT (data->connection), "closed");
1400 g_signal_emit (data->connection,
1401 signals[CLOSED_SIGNAL],
1403 data->remote_peer_vanished,
1409 /* Can be called from any thread, must hold lock.
1410 * FLAG_CLOSED must already have been set.
1413 schedule_closed_unlocked (GDBusConnection *connection,
1414 gboolean remote_peer_vanished,
1417 GSource *idle_source;
1418 EmitClosedData *data;
1420 CONNECTION_ENSURE_LOCK (connection);
1422 data = g_new0 (EmitClosedData, 1);
1423 data->connection = g_object_ref (connection);
1424 data->remote_peer_vanished = remote_peer_vanished;
1425 data->error = error != NULL ? g_error_copy (error) : NULL;
1427 idle_source = g_idle_source_new ();
1428 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1429 g_source_set_callback (idle_source,
1430 emit_closed_in_idle,
1432 (GDestroyNotify) emit_closed_data_free);
1433 g_source_set_name (idle_source, "[gio] emit_closed_in_idle");
1434 g_source_attach (idle_source, connection->main_context_at_construction);
1435 g_source_unref (idle_source);
1438 /* ---------------------------------------------------------------------------------------------------- */
1441 * g_dbus_connection_close:
1442 * @connection: a #GDBusConnection
1443 * @cancellable: (allow-none): a #GCancellable or %NULL
1444 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
1445 * satisfied or %NULL if you don't care about the result
1446 * @user_data: The data to pass to @callback
1448 * Closes @connection. Note that this never causes the process to
1449 * exit (this might only happen if the other end of a shared message
1450 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1452 * Once the connection is closed, operations such as sending a message
1453 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1454 * will not automatically flush the connection so queued messages may
1455 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1457 * If @connection is already closed, this method fails with
1458 * %G_IO_ERROR_CLOSED.
1460 * When @connection has been closed, the #GDBusConnection::closed
1461 * signal is emitted in the
1462 * [thread-default main context][g-main-context-push-thread-default]
1463 * of the thread that @connection was constructed in.
1465 * This is an asynchronous method. When the operation is finished,
1466 * @callback will be invoked in the
1467 * [thread-default main context][g-main-context-push-thread-default]
1468 * of the thread you are calling this method from. You can
1469 * then call g_dbus_connection_close_finish() to get the result of the
1470 * operation. See g_dbus_connection_close_sync() for the synchronous
1476 g_dbus_connection_close (GDBusConnection *connection,
1477 GCancellable *cancellable,
1478 GAsyncReadyCallback callback,
1481 GSimpleAsyncResult *simple;
1483 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1485 /* do not use g_return_val_if_fail(), we want the memory barrier */
1486 if (!check_initialized (connection))
1489 g_assert (connection->worker != NULL);
1491 simple = g_simple_async_result_new (G_OBJECT (connection),
1494 g_dbus_connection_close);
1495 g_simple_async_result_set_check_cancellable (simple, cancellable);
1496 _g_dbus_worker_close (connection->worker, cancellable, simple);
1497 g_object_unref (simple);
1501 * g_dbus_connection_close_finish:
1502 * @connection: a #GDBusConnection
1503 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1504 * to g_dbus_connection_close()
1505 * @error: return location for error or %NULL
1507 * Finishes an operation started with g_dbus_connection_close().
1509 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1514 g_dbus_connection_close_finish (GDBusConnection *connection,
1518 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1523 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1524 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1525 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1527 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
1529 if (g_simple_async_result_propagate_error (simple, error))
1540 GAsyncResult *result;
1543 /* Can be called by any thread, without the connection lock */
1545 sync_close_cb (GObject *source_object,
1549 SyncCloseData *data = user_data;
1551 data->result = g_object_ref (res);
1552 g_main_loop_quit (data->loop);
1556 * g_dbus_connection_close_sync:
1557 * @connection: a #GDBusConnection
1558 * @cancellable: (allow-none): a #GCancellable or %NULL
1559 * @error: return location for error or %NULL
1561 * Synchronously closees @connection. The calling thread is blocked
1562 * until this is done. See g_dbus_connection_close() for the
1563 * asynchronous version of this method and more details about what it
1566 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1571 g_dbus_connection_close_sync (GDBusConnection *connection,
1572 GCancellable *cancellable,
1577 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1578 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1582 if (check_unclosed (connection, 0, error))
1584 GMainContext *context;
1587 context = g_main_context_new ();
1588 g_main_context_push_thread_default (context);
1589 data.loop = g_main_loop_new (context, TRUE);
1592 g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
1593 g_main_loop_run (data.loop);
1594 ret = g_dbus_connection_close_finish (connection, data.result, error);
1596 g_object_unref (data.result);
1597 g_main_loop_unref (data.loop);
1598 g_main_context_pop_thread_default (context);
1599 g_main_context_unref (context);
1605 /* ---------------------------------------------------------------------------------------------------- */
1608 * g_dbus_request_name:
1609 * @connection: a #GDBusConnection
1610 * @name: well-known bus name (name to request)
1611 * @flags: a set of flags from the GBusNameOwnerFlags enumeration
1612 * @error: return location for error or %NULL
1614 * Synchronously acquires name on the bus and returns status code.
1616 * The calling thread is blocked until a reply is received.
1618 * Returns: status code or %G_BUS_REQUEST_NAME_FLAGS_ERROR
1623 GBusRequestNameReplyFlags
1624 g_dbus_request_name (GDBusConnection *connection,
1626 GBusNameOwnerFlags flags,
1630 guint32 request_name_reply;
1632 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1633 g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1634 g_return_val_if_fail (error == NULL || *error == NULL, G_BUS_RELEASE_NAME_FLAGS_ERROR);
1636 if (connection->kdbus_worker)
1637 result = _g_kdbus_RequestName (connection->kdbus_worker, name, flags, error);
1639 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/org/freedesktop/DBus",
1640 "org.freedesktop.DBus", "RequestName",
1641 g_variant_new ("(su)", name, flags), G_VARIANT_TYPE ("(u)"),
1642 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1646 g_variant_get (result, "(u)", &request_name_reply);
1647 g_variant_unref (result);
1650 request_name_reply = G_BUS_REQUEST_NAME_FLAGS_ERROR;
1652 return (GBusRequestNameReplyFlags) request_name_reply;
1656 * g_dbus_release_name:
1657 * @connection: a #GDBusConnection
1658 * @name: well-known bus name (name to release)
1659 * @error: return location for error or %NULL
1661 * Synchronously releases name on the bus and returns status code.
1663 * The calling thread is blocked until a reply is received.
1665 * Returns: status code or %G_BUS_RELEASE_NAME_FLAGS_ERROR
1670 GBusReleaseNameReplyFlags
1671 g_dbus_release_name (GDBusConnection *connection,
1676 guint32 release_name_reply;
1678 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1679 g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), G_BUS_RELEASE_NAME_FLAGS_ERROR);
1680 g_return_val_if_fail (error == NULL || *error == NULL, G_BUS_RELEASE_NAME_FLAGS_ERROR);
1682 if (connection->kdbus_worker)
1683 result = _g_kdbus_ReleaseName (connection->kdbus_worker, name, error);
1685 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/org/freedesktop/DBus",
1686 "org.freedesktop.DBus", "ReleaseName",
1687 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
1688 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1692 g_variant_get (result, "(u)", &release_name_reply);
1693 g_variant_unref (result);
1696 release_name_reply = G_BUS_RELEASE_NAME_FLAGS_ERROR;
1698 return (GBusReleaseNameReplyFlags) release_name_reply;
1702 * g_dbus_get_bus_id:
1703 * @connection: a #GDBusConnection
1704 * @error: return location for error or %NULL
1706 * Synchronously returns the unique ID of the bus.
1708 * The calling thread is blocked until a reply is received.
1710 * Returns: the unique ID of the bus or %NULL if @error is set.
1711 * Free with g_free().
1716 g_dbus_get_bus_id (GDBusConnection *connection,
1722 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1723 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1728 if (connection->kdbus_worker)
1730 result = _g_kdbus_GetBusId (connection->kdbus_worker, error);
1734 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1735 "org.freedesktop.DBus", "GetId",
1736 NULL, G_VARIANT_TYPE ("(s)"),
1737 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1742 g_variant_get (result, "(s)", &bus_id);
1743 g_variant_unref (result);
1752 LIST_ACTIVATABLE_NAMES,
1754 } GDBusListNameType;
1757 _g_dbus_get_list_internal (GDBusConnection *connection,
1759 GDBusListNameType list_name_type,
1771 if (list_name_type == LIST_QUEUED_OWNERS)
1773 if (connection->kdbus_worker)
1774 result = _g_kdbus_GetListQueuedOwners (connection->kdbus_worker, name, error);
1776 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1777 "org.freedesktop.DBus", "ListQueuedOwners",
1778 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(as)"),
1779 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1785 if (list_name_type == LIST_NAMES)
1786 method_name = "ListNames";
1788 method_name = "ListActivatableNames";
1790 if (connection->kdbus_worker)
1791 result = _g_kdbus_GetListNames (connection->kdbus_worker, list_name_type, error);
1793 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1794 "org.freedesktop.DBus", method_name,
1795 NULL, G_VARIANT_TYPE ("(as)"),
1796 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1801 g_variant_get (result, "(as)", &iter);
1802 n = g_variant_iter_n_children (iter);
1803 strv = g_new (gchar *, n + 1);
1806 while (g_variant_iter_loop (iter, "s", &str))
1808 strv[i] = g_strdup (str);
1813 g_variant_iter_free (iter);
1814 g_variant_unref (result);
1821 * g_dbus_get_list_names:
1822 * @connection: a #GDBusConnection
1823 * @error: return location for error or %NULL
1825 * Synchronously returns a list of all currently-owned names on the bus.
1827 * The calling thread is blocked until a reply is received.
1829 * Returns: a list of all currently-owned names on the bus or %NULL if
1830 * @error is set. Free with g_strfreev().
1835 g_dbus_get_list_names (GDBusConnection *connection,
1840 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1841 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1843 strv = _g_dbus_get_list_internal (connection, NULL, LIST_NAMES, error);
1849 * g_dbus_get_list_activatable_names:
1850 * @connection: a #GDBusConnection
1851 * @error: return location for error or %NULL
1853 * Synchronously returns a list of all names that can be activated on the bus.
1855 * The calling thread is blocked until a reply is received.
1857 * Returns: a list of all names that can be activated on the bus or %NULL if
1858 * @error is set. Free with g_strfreev().
1863 g_dbus_get_list_activatable_names (GDBusConnection *connection,
1868 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1869 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1871 strv = _g_dbus_get_list_internal (connection, NULL, LIST_ACTIVATABLE_NAMES, error);
1877 * g_dbus_get_list_queued_names:
1878 * @connection: a #GDBusConnection
1879 * @name: a unique or well-known bus name
1880 * @error: return location for error or %NULL
1882 * Synchronously returns the unique bus names of connections currently queued
1885 * If @name contains a value not compatible with the D-Bus syntax and naming
1886 * conventions for bus names, the operation returns %NULL and @error is set.
1888 * The calling thread is blocked until a reply is received.
1890 * Returns: the unique bus names of connections currently queued for the @name
1891 * or %NULL if @error is set. Free with g_strfreev().
1896 g_dbus_get_list_queued_owners (GDBusConnection *connection,
1902 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1903 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
1904 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1906 strv = _g_dbus_get_list_internal (connection, name, LIST_QUEUED_OWNERS, error);
1912 * g_dbus_get_name_owner:
1913 * @connection: a #GDBusConnection
1914 * @name: well-known bus name to get the owner of
1915 * @error: return location for error or %NULL
1917 * Synchronously returns the unique connection name of the primary owner of
1918 * the name given. If the requested name doesn't have an owner, an @error is
1921 * If @name contains a value not compatible with the D-Bus syntax and naming
1922 * conventions for bus names, the operation returns %NULL and @error is set.
1924 * The calling thread is blocked until a reply is received.
1926 * Returns: the unique connection name of the primary owner of the
1927 * name given. If the requested name doesn't have an owner, function
1928 * returns %NULL and @error is set. Free with g_free().
1933 g_dbus_get_name_owner (GDBusConnection *connection,
1940 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1941 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
1942 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1947 if (connection->kdbus_worker)
1948 result = _g_kdbus_GetNameOwner (connection->kdbus_worker, name, error);
1950 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1951 "org.freedesktop.DBus", "GetNameOwner",
1952 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(s)"),
1953 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1956 g_variant_get (result, "(s)", &name_owner);
1957 g_variant_unref (result);
1966 * g_dbus_get_connection_pid:
1967 * @connection: a #GDBusConnection
1968 * @name: a unique or well-known bus name of the connection to query
1969 * @error: return location for error or %NULL
1971 * Synchronously returns the Unix process ID of the process connected to the
1972 * bus. If unable to determine it, an @error is returned.
1974 * If @name contains a value not compatible with the D-Bus syntax and naming
1975 * conventions for bus names, the operation returns (guint32) -1 and @error
1978 * The calling thread is blocked until a reply is received.
1980 * Returns: the Unix process ID of the process connected to the bus or
1981 * (guint32) -1 if @error is set.
1986 g_dbus_get_connection_pid (GDBusConnection *connection,
1993 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), -1);
1994 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), -1);
1995 g_return_val_if_fail (error == NULL || *error == NULL, -1);
2000 if (connection->kdbus_worker)
2001 result = _g_kdbus_GetConnectionUnixProcessID (connection->kdbus_worker, name, error);
2003 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
2004 "org.freedesktop.DBus", "GetConnectionUnixProcessID",
2005 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
2006 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
2009 g_variant_get (result, "(u)", &pid);
2010 g_variant_unref (result);
2017 * g_dbus_get_connection_uid:
2018 * @connection: a #GDBusConnection
2019 * @name: a unique or well-known bus name of the connection to query
2020 * @error: return location for error or %NULL
2022 * Synchronously returns the Unix user ID of the process connected to the
2023 * bus. If unable to determine it, an @error is returned.
2025 * If @name contains a value not compatible with the D-Bus syntax and naming
2026 * conventions for bus names, the operation returns (guint32) -1 and @error
2029 * The calling thread is blocked until a reply is received.
2031 * Returns: the Unix user ID of the process connected to the bus or
2032 * (guint32) -1 if @error is set.
2037 g_dbus_get_connection_uid (GDBusConnection *connection,
2044 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), -1);
2045 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), -1);
2046 g_return_val_if_fail (error == NULL || *error == NULL, -1);
2051 if (connection->kdbus_worker)
2052 result = _g_kdbus_GetConnectionUnixUser (connection->kdbus_worker, name, error);
2054 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
2055 "org.freedesktop.DBus", "GetConnectionUnixUser",
2056 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
2057 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
2060 g_variant_get (result, "(u)", &uid);
2061 g_variant_unref (result);
2067 /* ---------------------------------------------------------------------------------------------------- */
2070 * g_dbus_connection_get_last_serial:
2071 * @connection: a #GDBusConnection
2073 * Retrieves the last serial number assigned to a #GDBusMessage on
2074 * the current thread. This includes messages sent via both low-level
2075 * API such as g_dbus_connection_send_message() as well as
2076 * high-level API such as g_dbus_connection_emit_signal(),
2077 * g_dbus_connection_call() or g_dbus_proxy_call().
2079 * Returns: the last used serial or zero when no message has been sent
2080 * within the current thread
2085 g_dbus_connection_get_last_serial (GDBusConnection *connection)
2089 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2091 CONNECTION_LOCK (connection);
2092 ret = GPOINTER_TO_UINT (g_hash_table_lookup (connection->map_thread_to_last_serial,
2094 CONNECTION_UNLOCK (connection);
2099 /* ---------------------------------------------------------------------------------------------------- */
2101 /* Can be called by any thread, with the connection lock held */
2103 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
2104 GDBusMessage *message,
2105 GDBusSendMessageFlags flags,
2106 volatile guint32 *out_serial,
2111 guint32 serial_to_use;
2114 CONNECTION_ENSURE_LOCK (connection);
2116 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2117 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2119 /* TODO: check all necessary headers are present */
2124 if (out_serial != NULL)
2127 /* If we're in initable_init(), don't check for being initialized, to avoid
2128 * chicken-and-egg problems. initable_init() is responsible for setting up
2129 * our prerequisites (mainly connection->worker), and only calling us
2130 * from its own thread (so no memory barrier is needed).
2132 if (!check_unclosed (connection,
2133 (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
2137 if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
2138 g_dbus_message_set_serial (message, ++connection->last_serial);
2140 serial_to_use = g_dbus_message_get_serial (message);
2143 * serializes message to a blob
2145 if (connection->worker)
2147 blob = g_dbus_message_to_blob (message,
2149 connection->capabilities,
2157 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
2160 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
2163 g_assert_not_reached ();
2168 g_dbus_message_lock (message);
2171 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
2172 blob_size, serial_to_use, connection);
2173 g_printerr ("----\n");
2174 hexdump (blob, blob_size);
2175 g_printerr ("----\n");
2178 /* TODO: use connection->auth to encode the blob */
2180 if (out_serial != NULL)
2181 *out_serial = serial_to_use;
2183 /* store used serial for the current thread */
2184 /* TODO: watch the thread disposal and remove associated record
2186 * - see https://bugzilla.gnome.org/show_bug.cgi?id=676825#c7
2188 g_hash_table_replace (connection->map_thread_to_last_serial,
2190 GUINT_TO_POINTER (serial_to_use));
2194 if (connection->worker)
2195 _g_dbus_worker_send_message (connection->worker,
2200 ret = g_kdbus_worker_send_message (connection->kdbus_worker, message, error);
2202 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
2211 * g_dbus_connection_send_message:
2212 * @connection: a #GDBusConnection
2213 * @message: a #GDBusMessage
2214 * @flags: flags affecting how the message is sent
2215 * @out_serial: (out) (allow-none): return location for serial number assigned
2216 * to @message when sending it or %NULL
2217 * @error: Return location for error or %NULL
2219 * Asynchronously sends @message to the peer represented by @connection.
2221 * Unless @flags contain the
2222 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2223 * will be assigned by @connection and set on @message via
2224 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2225 * serial number used will be written to this location prior to
2226 * submitting the message to the underlying transport.
2228 * If @connection is closed then the operation will fail with
2229 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
2230 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2232 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2233 * for an example of how to use this low-level API to send and receive
2234 * UNIX file descriptors.
2236 * Note that @message must be unlocked, unless @flags contain the
2237 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2239 * Returns: %TRUE if the message was well-formed and queued for
2240 * transmission, %FALSE if @error is set
2245 g_dbus_connection_send_message (GDBusConnection *connection,
2246 GDBusMessage *message,
2247 GDBusSendMessageFlags flags,
2248 volatile guint32 *out_serial,
2253 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2254 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2255 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
2256 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
2258 CONNECTION_LOCK (connection);
2259 ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
2260 CONNECTION_UNLOCK (connection);
2264 /* ---------------------------------------------------------------------------------------------------- */
2268 volatile gint ref_count;
2269 GDBusConnection *connection;
2271 GSimpleAsyncResult *simple;
2273 GMainContext *main_context;
2275 GCancellable *cancellable;
2277 gulong cancellable_handler_id;
2279 GSource *timeout_source;
2284 /* Can be called from any thread with or without lock held */
2285 static SendMessageData *
2286 send_message_data_ref (SendMessageData *data)
2288 g_atomic_int_inc (&data->ref_count);
2292 /* Can be called from any thread with or without lock held */
2294 send_message_data_unref (SendMessageData *data)
2296 if (g_atomic_int_dec_and_test (&data->ref_count))
2298 g_assert (data->timeout_source == NULL);
2299 g_assert (data->simple == NULL);
2300 g_assert (data->cancellable_handler_id == 0);
2301 g_object_unref (data->connection);
2302 if (data->cancellable != NULL)
2303 g_object_unref (data->cancellable);
2304 g_main_context_unref (data->main_context);
2309 /* ---------------------------------------------------------------------------------------------------- */
2311 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
2313 send_message_with_reply_deliver (SendMessageData *data, gboolean remove)
2315 CONNECTION_ENSURE_LOCK (data->connection);
2317 g_assert (!data->delivered);
2319 data->delivered = TRUE;
2321 g_simple_async_result_complete_in_idle (data->simple);
2322 g_object_unref (data->simple);
2323 data->simple = NULL;
2325 if (data->timeout_source != NULL)
2327 g_source_destroy (data->timeout_source);
2328 data->timeout_source = NULL;
2330 if (data->cancellable_handler_id > 0)
2332 g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
2333 data->cancellable_handler_id = 0;
2338 g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
2339 GUINT_TO_POINTER (data->serial)));
2342 send_message_data_unref (data);
2345 /* ---------------------------------------------------------------------------------------------------- */
2347 /* Can be called from any thread with lock held */
2349 send_message_data_deliver_reply_unlocked (SendMessageData *data,
2350 GDBusMessage *reply)
2352 if (data->delivered)
2355 g_simple_async_result_set_op_res_gpointer (data->simple,
2356 g_object_ref (reply),
2359 send_message_with_reply_deliver (data, TRUE);
2365 /* ---------------------------------------------------------------------------------------------------- */
2367 /* Called from a user thread, lock is not held */
2369 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
2371 SendMessageData *data = user_data;
2373 CONNECTION_LOCK (data->connection);
2374 if (data->delivered)
2377 g_simple_async_result_set_error (data->simple,
2379 G_IO_ERROR_CANCELLED,
2380 _("Operation was cancelled"));
2382 send_message_with_reply_deliver (data, TRUE);
2385 CONNECTION_UNLOCK (data->connection);
2389 /* Can be called from any thread with or without lock held */
2391 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
2394 SendMessageData *data = user_data;
2395 GSource *idle_source;
2397 /* postpone cancellation to idle handler since we may be called directly
2398 * via g_cancellable_connect() (e.g. holding lock)
2400 idle_source = g_idle_source_new ();
2401 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
2402 g_source_set_callback (idle_source,
2403 send_message_with_reply_cancelled_idle_cb,
2404 send_message_data_ref (data),
2405 (GDestroyNotify) send_message_data_unref);
2406 g_source_set_name (idle_source, "[gio] send_message_with_reply_cancelled_idle_cb");
2407 g_source_attach (idle_source, data->main_context);
2408 g_source_unref (idle_source);
2411 /* ---------------------------------------------------------------------------------------------------- */
2413 /* Called from a user thread, lock is not held */
2415 send_message_with_reply_timeout_cb (gpointer user_data)
2417 SendMessageData *data = user_data;
2419 CONNECTION_LOCK (data->connection);
2420 if (data->delivered)
2423 g_simple_async_result_set_error (data->simple,
2425 G_IO_ERROR_TIMED_OUT,
2426 _("Timeout was reached"));
2428 send_message_with_reply_deliver (data, TRUE);
2431 CONNECTION_UNLOCK (data->connection);
2436 /* ---------------------------------------------------------------------------------------------------- */
2438 /* Called from a user thread, connection's lock is held */
2440 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
2441 GDBusMessage *message,
2442 GDBusSendMessageFlags flags,
2444 volatile guint32 *out_serial,
2445 GCancellable *cancellable,
2446 GAsyncReadyCallback callback,
2449 GSimpleAsyncResult *simple;
2450 SendMessageData *data;
2452 volatile guint32 serial;
2456 if (out_serial == NULL)
2457 out_serial = &serial;
2459 if (timeout_msec == -1)
2460 timeout_msec = 25 * 1000;
2462 simple = g_simple_async_result_new (G_OBJECT (connection),
2465 g_dbus_connection_send_message_with_reply);
2466 g_simple_async_result_set_check_cancellable (simple, cancellable);
2468 if (g_cancellable_is_cancelled (cancellable))
2470 g_simple_async_result_set_error (simple,
2472 G_IO_ERROR_CANCELLED,
2473 _("Operation was cancelled"));
2474 g_simple_async_result_complete_in_idle (simple);
2475 g_object_unref (simple);
2480 if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
2482 g_simple_async_result_take_error (simple, error);
2483 g_simple_async_result_complete_in_idle (simple);
2484 g_object_unref (simple);
2488 data = g_new0 (SendMessageData, 1);
2489 data->ref_count = 1;
2490 data->connection = g_object_ref (connection);
2491 data->simple = simple;
2492 data->serial = *out_serial;
2493 data->main_context = g_main_context_ref_thread_default ();
2495 if (cancellable != NULL)
2497 data->cancellable = g_object_ref (cancellable);
2498 data->cancellable_handler_id = g_cancellable_connect (cancellable,
2499 G_CALLBACK (send_message_with_reply_cancelled_cb),
2500 send_message_data_ref (data),
2501 (GDestroyNotify) send_message_data_unref);
2504 if (timeout_msec != G_MAXINT)
2506 data->timeout_source = g_timeout_source_new (timeout_msec);
2507 g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
2508 g_source_set_callback (data->timeout_source,
2509 send_message_with_reply_timeout_cb,
2510 send_message_data_ref (data),
2511 (GDestroyNotify) send_message_data_unref);
2512 g_source_attach (data->timeout_source, data->main_context);
2513 g_source_unref (data->timeout_source);
2516 g_hash_table_insert (connection->map_method_serial_to_send_message_data,
2517 GUINT_TO_POINTER (*out_serial),
2525 * g_dbus_connection_send_message_with_reply:
2526 * @connection: a #GDBusConnection
2527 * @message: a #GDBusMessage
2528 * @flags: flags affecting how the message is sent
2529 * @timeout_msec: the timeout in milliseconds, -1 to use the default
2530 * timeout or %G_MAXINT for no timeout
2531 * @out_serial: (out) (allow-none): return location for serial number assigned
2532 * to @message when sending it or %NULL
2533 * @cancellable: (allow-none): a #GCancellable or %NULL
2534 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
2535 * is satisfied or %NULL if you don't care about the result
2536 * @user_data: The data to pass to @callback
2538 * Asynchronously sends @message to the peer represented by @connection.
2540 * Unless @flags contain the
2541 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2542 * will be assigned by @connection and set on @message via
2543 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2544 * serial number used will be written to this location prior to
2545 * submitting the message to the underlying transport.
2547 * If @connection is closed then the operation will fail with
2548 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2549 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2550 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2552 * This is an asynchronous method. When the operation is finished, @callback
2553 * will be invoked in the
2554 * [thread-default main context][g-main-context-push-thread-default]
2555 * of the thread you are calling this method from. You can then call
2556 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
2557 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
2559 * Note that @message must be unlocked, unless @flags contain the
2560 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2562 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2563 * for an example of how to use this low-level API to send and receive
2564 * UNIX file descriptors.
2569 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
2570 GDBusMessage *message,
2571 GDBusSendMessageFlags flags,
2573 volatile guint32 *out_serial,
2574 GCancellable *cancellable,
2575 GAsyncReadyCallback callback,
2578 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2579 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2580 g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
2581 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
2583 CONNECTION_LOCK (connection);
2584 g_dbus_connection_send_message_with_reply_unlocked (connection,
2592 CONNECTION_UNLOCK (connection);
2596 * g_dbus_connection_send_message_with_reply_finish:
2597 * @connection: a #GDBusConnection
2598 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
2599 * g_dbus_connection_send_message_with_reply()
2600 * @error: teturn location for error or %NULL
2602 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
2604 * Note that @error is only set if a local in-process error
2605 * occurred. That is to say that the returned #GDBusMessage object may
2606 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2607 * g_dbus_message_to_gerror() to transcode this to a #GError.
2609 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2610 * for an example of how to use this low-level API to send and receive
2611 * UNIX file descriptors.
2613 * Returns: (transfer full): a locked #GDBusMessage or %NULL if @error is set
2618 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
2622 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2623 GDBusMessage *reply;
2625 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2626 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2630 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
2632 if (g_simple_async_result_propagate_error (simple, error))
2635 reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
2641 /* ---------------------------------------------------------------------------------------------------- */
2646 GMainContext *context;
2648 } SendMessageSyncData;
2650 /* Called from a user thread, lock is not held */
2652 send_message_with_reply_sync_cb (GDBusConnection *connection,
2656 SendMessageSyncData *data = user_data;
2657 data->res = g_object_ref (res);
2658 g_main_loop_quit (data->loop);
2662 * g_dbus_connection_send_message_with_reply_sync:
2663 * @connection: a #GDBusConnection
2664 * @message: a #GDBusMessage
2665 * @flags: flags affecting how the message is sent.
2666 * @timeout_msec: the timeout in milliseconds, -1 to use the default
2667 * timeout or %G_MAXINT for no timeout
2668 * @out_serial: (out) (allow-none): return location for serial number
2669 * assigned to @message when sending it or %NULL
2670 * @cancellable: (allow-none): a #GCancellable or %NULL
2671 * @error: return location for error or %NULL
2673 * Synchronously sends @message to the peer represented by @connection
2674 * and blocks the calling thread until a reply is received or the
2675 * timeout is reached. See g_dbus_connection_send_message_with_reply()
2676 * for the asynchronous version of this method.
2678 * Unless @flags contain the
2679 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2680 * will be assigned by @connection and set on @message via
2681 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2682 * serial number used will be written to this location prior to
2683 * submitting the message to the underlying transport.
2685 * If @connection is closed then the operation will fail with
2686 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2687 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2688 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2690 * Note that @error is only set if a local in-process error
2691 * occurred. That is to say that the returned #GDBusMessage object may
2692 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2693 * g_dbus_message_to_gerror() to transcode this to a #GError.
2695 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2696 * for an example of how to use this low-level API to send and receive
2697 * UNIX file descriptors.
2699 * Note that @message must be unlocked, unless @flags contain the
2700 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2702 * Returns: (transfer full): a locked #GDBusMessage that is the reply
2703 * to @message or %NULL if @error is set
2708 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
2709 GDBusMessage *message,
2710 GDBusSendMessageFlags flags,
2712 volatile guint32 *out_serial,
2713 GCancellable *cancellable,
2716 SendMessageSyncData *data;
2717 GDBusMessage *reply;
2719 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2720 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2721 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
2722 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2723 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2725 data = g_new0 (SendMessageSyncData, 1);
2727 if (connection->kdbus_worker)
2728 data->context = g_main_context_ref_thread_default ();
2730 data->context = g_main_context_new ();
2732 data->loop = g_main_loop_new (data->context, FALSE);
2734 g_main_context_push_thread_default (data->context);
2736 g_dbus_connection_send_message_with_reply (connection,
2742 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2744 g_main_loop_run (data->loop);
2745 reply = g_dbus_connection_send_message_with_reply_finish (connection,
2749 g_main_context_pop_thread_default (data->context);
2751 g_main_context_unref (data->context);
2752 g_main_loop_unref (data->loop);
2753 g_object_unref (data->res);
2759 /* ---------------------------------------------------------------------------------------------------- */
2763 GDBusMessageFilterFunction func;
2770 GDBusMessageFilterFunction filter_function;
2772 GDestroyNotify user_data_free_func;
2775 /* Called in GDBusWorker's thread - we must not block - with no lock held */
2777 on_worker_message_received (GDBusMessage *message,
2780 GDBusConnection *connection;
2781 FilterCallback *filters;
2786 G_LOCK (message_bus_lock);
2787 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2790 G_UNLOCK (message_bus_lock);
2793 connection = G_DBUS_CONNECTION (user_data);
2794 g_object_ref (connection);
2795 G_UNLOCK (message_bus_lock);
2797 //g_debug ("in on_worker_message_received");
2799 g_object_ref (message);
2800 g_dbus_message_lock (message);
2802 //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2804 /* First collect the set of callback functions */
2805 CONNECTION_LOCK (connection);
2806 num_filters = connection->filters->len;
2807 filters = g_new0 (FilterCallback, num_filters);
2808 for (n = 0; n < num_filters; n++)
2810 FilterData *data = connection->filters->pdata[n];
2811 filters[n].func = data->filter_function;
2812 filters[n].user_data = data->user_data;
2814 CONNECTION_UNLOCK (connection);
2816 /* then call the filters in order (without holding the lock) */
2817 for (n = 0; n < num_filters; n++)
2819 message = filters[n].func (connection,
2822 filters[n].user_data);
2823 if (message == NULL)
2825 g_dbus_message_lock (message);
2828 /* Standard dispatch unless the filter ate the message - no need to
2829 * do anything if the message was altered
2831 if (message != NULL)
2833 GDBusMessageType message_type;
2835 message_type = g_dbus_message_get_message_type (message);
2836 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2838 guint32 reply_serial;
2839 SendMessageData *send_message_data;
2841 reply_serial = g_dbus_message_get_reply_serial (message);
2842 CONNECTION_LOCK (connection);
2843 send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
2844 GUINT_TO_POINTER (reply_serial));
2845 if (send_message_data != NULL)
2847 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2848 send_message_data_deliver_reply_unlocked (send_message_data, message);
2852 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2854 CONNECTION_UNLOCK (connection);
2856 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2858 CONNECTION_LOCK (connection);
2859 distribute_signals (connection, message);
2860 CONNECTION_UNLOCK (connection);
2862 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2864 CONNECTION_LOCK (connection);
2865 distribute_method_call (connection, message);
2866 CONNECTION_UNLOCK (connection);
2870 if (message != NULL)
2871 g_object_unref (message);
2872 g_object_unref (connection);
2876 /* Called in GDBusWorker's thread, lock is not held */
2877 static GDBusMessage *
2878 on_worker_message_about_to_be_sent (GDBusMessage *message,
2881 GDBusConnection *connection;
2882 FilterCallback *filters;
2887 G_LOCK (message_bus_lock);
2888 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2891 G_UNLOCK (message_bus_lock);
2894 connection = G_DBUS_CONNECTION (user_data);
2895 g_object_ref (connection);
2896 G_UNLOCK (message_bus_lock);
2898 //g_debug ("in on_worker_message_about_to_be_sent");
2900 /* First collect the set of callback functions */
2901 CONNECTION_LOCK (connection);
2902 num_filters = connection->filters->len;
2903 filters = g_new0 (FilterCallback, num_filters);
2904 for (n = 0; n < num_filters; n++)
2906 FilterData *data = connection->filters->pdata[n];
2907 filters[n].func = data->filter_function;
2908 filters[n].user_data = data->user_data;
2910 CONNECTION_UNLOCK (connection);
2912 /* then call the filters in order (without holding the lock) */
2913 for (n = 0; n < num_filters; n++)
2915 g_dbus_message_lock (message);
2916 message = filters[n].func (connection,
2919 filters[n].user_data);
2920 if (message == NULL)
2924 g_object_unref (connection);
2930 /* called with connection lock held, in GDBusWorker thread */
2932 cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
2934 SendMessageData *data = value;
2936 if (data->delivered)
2939 g_simple_async_result_set_error (data->simple,
2942 _("The connection is closed"));
2944 /* Ask send_message_with_reply_deliver not to remove the element from the
2945 * hash table - we're in the middle of a foreach; that would be unsafe.
2946 * Instead, return TRUE from this function so that it gets removed safely.
2948 send_message_with_reply_deliver (data, FALSE);
2952 /* Called in GDBusWorker's thread - we must not block - without lock held */
2954 on_worker_closed (gboolean remote_peer_vanished,
2958 GDBusConnection *connection;
2960 guint old_atomic_flags;
2962 G_LOCK (message_bus_lock);
2963 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2966 G_UNLOCK (message_bus_lock);
2969 connection = G_DBUS_CONNECTION (user_data);
2970 g_object_ref (connection);
2971 G_UNLOCK (message_bus_lock);
2973 //g_debug ("in on_worker_closed: %s", error->message);
2975 CONNECTION_LOCK (connection);
2976 /* Even though this is atomic, we do it inside the lock to avoid breaking
2977 * assumptions in remove_match_rule(). We'd need the lock in a moment
2978 * anyway, so, no loss.
2980 old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
2982 if (!(old_atomic_flags & FLAG_CLOSED))
2984 g_hash_table_foreach_remove (connection->map_method_serial_to_send_message_data, cancel_method_on_close, NULL);
2985 schedule_closed_unlocked (connection, remote_peer_vanished, error);
2987 CONNECTION_UNLOCK (connection);
2989 g_object_unref (connection);
2992 /* ---------------------------------------------------------------------------------------------------- */
2994 /* Determines the biggest set of capabilities we can support on this
2997 * Called with the init_lock held.
2999 static GDBusCapabilityFlags
3000 get_offered_capabilities_max (GDBusConnection *connection)
3002 GDBusCapabilityFlags ret;
3003 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
3005 if (G_IS_UNIX_CONNECTION (connection->stream))
3006 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
3011 /* Called in a user thread, lock is not held */
3013 initable_init (GInitable *initable,
3014 GCancellable *cancellable,
3017 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
3018 gboolean initially_frozen;
3021 /* This method needs to be idempotent to work with the singleton
3022 * pattern. See the docs for g_initable_init(). We implement this by
3025 * Unfortunately we can't use the main lock since the on_worker_*()
3026 * callbacks above needs the lock during initialization (for message
3027 * bus connections we do a synchronous Hello() call on the bus).
3029 g_mutex_lock (&connection->init_lock);
3033 /* Make this a no-op if we're already initialized (successfully or
3036 if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
3038 ret = (connection->initialization_error == NULL);
3042 /* Because of init_lock, we can't get here twice in different threads */
3043 g_assert (connection->initialization_error == NULL);
3045 /* The user can pass multiple (but mutally exclusive) construct
3048 * - stream (of type GIOStream)
3049 * - address (of type gchar*)
3051 * At the end of the day we end up with a non-NULL GIOStream
3052 * object in connection->stream.
3054 if (connection->address != NULL)
3058 g_assert (connection->stream == NULL);
3060 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
3061 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
3063 g_set_error_literal (&connection->initialization_error,
3065 G_IO_ERROR_INVALID_ARGUMENT,
3066 _("Unsupported flags encountered when constructing a client-side connection"));
3070 ret = g_dbus_address_get_stream_internal (connection->address, TRUE,
3071 NULL, /* TODO: out_guid */
3072 cancellable, &connection->initialization_error);
3076 if (G_IS_IO_STREAM (ret))
3077 connection->stream = G_IO_STREAM (ret);
3078 else if (G_IS_KDBUS_WORKER (ret))
3079 connection->kdbus_worker = G_KDBUS_WORKER (ret);
3081 g_assert_not_reached ();
3083 else if (connection->stream != NULL)
3089 g_assert_not_reached ();
3092 /* Skip authentication process for kdbus transport */
3093 if (connection->kdbus_worker)
3095 /* kdbus connection always supports exchanging UNIX file descriptors with the remote peer */
3096 connection->capabilities |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
3100 /* Authenticate the connection */
3101 if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
3103 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
3104 g_assert (connection->guid != NULL);
3105 connection->auth = _g_dbus_auth_new (connection->stream);
3106 if (!_g_dbus_auth_run_server (connection->auth,
3107 connection->authentication_observer,
3109 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
3110 get_offered_capabilities_max (connection),
3111 &connection->capabilities,
3112 &connection->credentials,
3114 &connection->initialization_error))
3117 else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
3119 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
3120 g_assert (connection->guid == NULL);
3121 connection->auth = _g_dbus_auth_new (connection->stream);
3122 connection->guid = _g_dbus_auth_run_client (connection->auth,
3123 connection->authentication_observer,
3124 get_offered_capabilities_max (connection),
3125 &connection->capabilities,
3127 &connection->initialization_error);
3128 if (connection->guid == NULL)
3132 if (connection->authentication_observer != NULL)
3134 g_object_unref (connection->authentication_observer);
3135 connection->authentication_observer = NULL;
3140 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
3142 //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
3145 /* We want all IO operations to be non-blocking since they happen in
3146 * the worker thread which is shared by _all_ connections.
3148 if (G_IS_SOCKET_CONNECTION (connection->stream))
3150 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
3154 G_LOCK (message_bus_lock);
3155 if (alive_connections == NULL)
3156 alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
3157 g_hash_table_insert (alive_connections, connection, connection);
3158 G_UNLOCK (message_bus_lock);
3160 initially_frozen = (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0;
3162 if (connection->kdbus_worker)
3163 g_kdbus_worker_associate (connection->kdbus_worker,
3164 connection->capabilities,
3165 on_worker_message_received,
3166 on_worker_message_about_to_be_sent,
3170 connection->worker = _g_dbus_worker_new (connection->stream,
3171 connection->capabilities,
3173 on_worker_message_received,
3174 on_worker_message_about_to_be_sent,
3178 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
3179 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3181 GVariant *hello_result;
3183 /* we could lift this restriction by adding code in gdbusprivate.c */
3184 if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
3186 g_set_error_literal (&connection->initialization_error,
3189 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
3193 if (connection->kdbus_worker)
3195 hello_result = _g_kdbus_Hello (connection->kdbus_worker, &connection->initialization_error);
3199 hello_result = g_dbus_connection_call_sync (connection,
3200 "org.freedesktop.DBus", /* name */
3201 "/org/freedesktop/DBus", /* path */
3202 "org.freedesktop.DBus", /* interface */
3204 NULL, /* parameters */
3205 G_VARIANT_TYPE ("(s)"),
3206 CALL_FLAGS_INITIALIZING,
3208 NULL, /* TODO: cancellable */
3209 &connection->initialization_error);
3212 if (hello_result == NULL)
3215 g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
3216 g_variant_unref (hello_result);
3217 //g_debug ("unique name is '%s'", connection->bus_unique_name);
3220 if (connection->kdbus_worker && !initially_frozen)
3221 g_kdbus_worker_unfreeze (connection->kdbus_worker);
3227 g_assert (connection->initialization_error != NULL);
3228 g_propagate_error (error, g_error_copy (connection->initialization_error));
3231 g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
3232 g_mutex_unlock (&connection->init_lock);
3238 initable_iface_init (GInitableIface *initable_iface)
3240 initable_iface->init = initable_init;
3243 /* ---------------------------------------------------------------------------------------------------- */
3246 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
3251 /* ---------------------------------------------------------------------------------------------------- */
3254 * g_dbus_connection_new:
3255 * @stream: a #GIOStream
3256 * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
3257 * @flags: flags describing how to make the connection
3258 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3259 * @cancellable: (allow-none): a #GCancellable or %NULL
3260 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3261 * @user_data: the data to pass to @callback
3263 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
3264 * with the end represented by @stream.
3266 * If @stream is a #GSocketConnection, then the corresponding #GSocket
3267 * will be put into non-blocking mode.
3269 * The D-Bus connection will interact with @stream from a worker thread.
3270 * As a result, the caller should not interact with @stream after this
3271 * method has been called, except by calling g_object_unref() on it.
3273 * If @observer is not %NULL it may be used to control the
3274 * authentication process.
3276 * When the operation is finished, @callback will be invoked. You can
3277 * then call g_dbus_connection_new_finish() to get the result of the
3280 * This is a asynchronous failable constructor. See
3281 * g_dbus_connection_new_sync() for the synchronous
3287 g_dbus_connection_new (GIOStream *stream,
3289 GDBusConnectionFlags flags,
3290 GDBusAuthObserver *observer,
3291 GCancellable *cancellable,
3292 GAsyncReadyCallback callback,
3295 g_return_if_fail (G_IS_IO_STREAM (stream));
3296 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
3304 "authentication-observer", observer,
3309 * g_dbus_connection_new_finish:
3310 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback
3311 * passed to g_dbus_connection_new().
3312 * @error: return location for error or %NULL
3314 * Finishes an operation started with g_dbus_connection_new().
3316 * Returns: a #GDBusConnection or %NULL if @error is set. Free
3317 * with g_object_unref().
3322 g_dbus_connection_new_finish (GAsyncResult *res,
3326 GObject *source_object;
3328 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3329 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3331 source_object = g_async_result_get_source_object (res);
3332 g_assert (source_object != NULL);
3333 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
3336 g_object_unref (source_object);
3338 return G_DBUS_CONNECTION (object);
3344 * g_dbus_connection_new_sync:
3345 * @stream: a #GIOStream
3346 * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
3347 * @flags: flags describing how to make the connection
3348 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3349 * @cancellable: (allow-none): a #GCancellable or %NULL
3350 * @error: return location for error or %NULL
3352 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
3353 * with the end represented by @stream.
3355 * If @stream is a #GSocketConnection, then the corresponding #GSocket
3356 * will be put into non-blocking mode.
3358 * The D-Bus connection will interact with @stream from a worker thread.
3359 * As a result, the caller should not interact with @stream after this
3360 * method has been called, except by calling g_object_unref() on it.
3362 * If @observer is not %NULL it may be used to control the
3363 * authentication process.
3365 * This is a synchronous failable constructor. See
3366 * g_dbus_connection_new() for the asynchronous version.
3368 * Returns: a #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
3373 g_dbus_connection_new_sync (GIOStream *stream,
3375 GDBusConnectionFlags flags,
3376 GDBusAuthObserver *observer,
3377 GCancellable *cancellable,
3380 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
3381 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3382 return g_initable_new (G_TYPE_DBUS_CONNECTION,
3388 "authentication-observer", observer,
3392 /* ---------------------------------------------------------------------------------------------------- */
3395 * g_dbus_connection_new_for_address:
3396 * @address: a D-Bus address
3397 * @flags: flags describing how to make the connection
3398 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3399 * @cancellable: (allow-none): a #GCancellable or %NULL
3400 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3401 * @user_data: the data to pass to @callback
3403 * Asynchronously connects and sets up a D-Bus client connection for
3404 * exchanging D-Bus messages with an endpoint specified by @address
3405 * which must be in the D-Bus address format.
3407 * This constructor can only be used to initiate client-side
3408 * connections - use g_dbus_connection_new() if you need to act as the
3409 * server. In particular, @flags cannot contain the
3410 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
3411 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
3413 * When the operation is finished, @callback will be invoked. You can
3414 * then call g_dbus_connection_new_finish() to get the result of the
3417 * If @observer is not %NULL it may be used to control the
3418 * authentication process.
3420 * This is a asynchronous failable constructor. See
3421 * g_dbus_connection_new_for_address_sync() for the synchronous
3427 g_dbus_connection_new_for_address (const gchar *address,
3428 GDBusConnectionFlags flags,
3429 GDBusAuthObserver *observer,
3430 GCancellable *cancellable,
3431 GAsyncReadyCallback callback,
3434 g_return_if_fail (address != NULL);
3435 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
3442 "authentication-observer", observer,
3447 * g_dbus_connection_new_for_address_finish:
3448 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
3449 * to g_dbus_connection_new()
3450 * @error: return location for error or %NULL
3452 * Finishes an operation started with g_dbus_connection_new_for_address().
3454 * Returns: a #GDBusConnection or %NULL if @error is set. Free with
3460 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
3464 GObject *source_object;
3466 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3467 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3469 source_object = g_async_result_get_source_object (res);
3470 g_assert (source_object != NULL);
3471 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
3474 g_object_unref (source_object);
3476 return G_DBUS_CONNECTION (object);
3482 * g_dbus_connection_new_for_address_sync:
3483 * @address: a D-Bus address
3484 * @flags: flags describing how to make the connection
3485 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3486 * @cancellable: (allow-none): a #GCancellable or %NULL
3487 * @error: return location for error or %NULL
3489 * Synchronously connects and sets up a D-Bus client connection for
3490 * exchanging D-Bus messages with an endpoint specified by @address
3491 * which must be in the D-Bus address format.
3493 * This constructor can only be used to initiate client-side
3494 * connections - use g_dbus_connection_new_sync() if you need to act
3495 * as the server. In particular, @flags cannot contain the
3496 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
3497 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
3499 * This is a synchronous failable constructor. See
3500 * g_dbus_connection_new_for_address() for the asynchronous version.
3502 * If @observer is not %NULL it may be used to control the
3503 * authentication process.
3505 * Returns: a #GDBusConnection or %NULL if @error is set. Free with
3511 g_dbus_connection_new_for_address_sync (const gchar *address,
3512 GDBusConnectionFlags flags,
3513 GDBusAuthObserver *observer,
3514 GCancellable *cancellable,
3517 g_return_val_if_fail (address != NULL, NULL);
3518 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3519 return g_initable_new (G_TYPE_DBUS_CONNECTION,
3524 "authentication-observer", observer,
3528 /* ---------------------------------------------------------------------------------------------------- */
3531 * g_dbus_connection_set_exit_on_close:
3532 * @connection: a #GDBusConnection
3533 * @exit_on_close: whether the process should be terminated
3534 * when @connection is closed by the remote peer
3536 * Sets whether the process should be terminated when @connection is
3537 * closed by the remote peer. See #GDBusConnection:exit-on-close for
3540 * Note that this function should be used with care. Most modern UNIX
3541 * desktops tie the notion of a user session the session bus, and expect
3542 * all of a users applications to quit when their bus connection goes away.
3543 * If you are setting @exit_on_close to %FALSE for the shared session
3544 * bus connection, you should make sure that your application exits
3545 * when the user session ends.
3550 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
3551 gboolean exit_on_close)
3553 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3556 g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
3558 g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
3563 * g_dbus_connection_get_exit_on_close:
3564 * @connection: a #GDBusConnection
3566 * Gets whether the process is terminated when @connection is
3567 * closed by the remote peer. See
3568 * #GDBusConnection:exit-on-close for more details.
3570 * Returns: whether the process is terminated when @connection is
3571 * closed by the remote peer
3576 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
3578 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3580 if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
3587 * g_dbus_connection_get_guid:
3588 * @connection: a #GDBusConnection
3590 * The GUID of the peer performing the role of server when
3591 * authenticating. See #GDBusConnection:guid for more details.
3593 * Returns: The GUID. Do not free this string, it is owned by
3599 g_dbus_connection_get_guid (GDBusConnection *connection)
3601 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3602 return connection->guid;
3606 * g_dbus_connection_get_unique_name:
3607 * @connection: a #GDBusConnection
3609 * Gets the unique name of @connection as assigned by the message
3610 * bus. This can also be used to figure out if @connection is a
3611 * message bus connection.
3613 * Returns: the unique name or %NULL if @connection is not a message
3614 * bus connection. Do not free this string, it is owned by
3620 g_dbus_connection_get_unique_name (GDBusConnection *connection)
3622 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3624 /* do not use g_return_val_if_fail(), we want the memory barrier */
3625 if (!check_initialized (connection))
3628 return connection->bus_unique_name;
3632 * g_dbus_connection_get_peer_credentials:
3633 * @connection: a #GDBusConnection
3635 * Gets the credentials of the authenticated peer. This will always
3636 * return %NULL unless @connection acted as a server
3637 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
3638 * when set up and the client passed credentials as part of the
3639 * authentication process.
3641 * In a message bus setup, the message bus is always the server and
3642 * each application is a client. So this method will always return
3643 * %NULL for message bus clients.
3645 * Returns: (transfer none): a #GCredentials or %NULL if not available.
3646 * Do not free this object, it is owned by @connection.
3651 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
3653 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3655 /* do not use g_return_val_if_fail(), we want the memory barrier */
3656 if (!check_initialized (connection))
3659 return connection->credentials;
3662 /* ---------------------------------------------------------------------------------------------------- */
3664 static guint _global_filter_id = 1;
3667 * g_dbus_connection_add_filter:
3668 * @connection: a #GDBusConnection
3669 * @filter_function: a filter function
3670 * @user_data: user data to pass to @filter_function
3671 * @user_data_free_func: function to free @user_data with when filter
3672 * is removed or %NULL
3674 * Adds a message filter. Filters are handlers that are run on all
3675 * incoming and outgoing messages, prior to standard dispatch. Filters
3676 * are run in the order that they were added. The same handler can be
3677 * added as a filter more than once, in which case it will be run more
3678 * than once. Filters added during a filter callback won't be run on
3679 * the message being processed. Filter functions are allowed to modify
3680 * and even drop messages.
3682 * Note that filters are run in a dedicated message handling thread so
3683 * they can't block and, generally, can't do anything but signal a
3684 * worker thread. Also note that filters are rarely needed - use API
3685 * such as g_dbus_connection_send_message_with_reply(),
3686 * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
3688 * If a filter consumes an incoming message the message is not
3689 * dispatched anywhere else - not even the standard dispatch machinery
3690 * (that API such as g_dbus_connection_signal_subscribe() and
3691 * g_dbus_connection_send_message_with_reply() relies on) will see the
3692 * message. Similary, if a filter consumes an outgoing message, the
3693 * message will not be sent to the other peer.
3695 * Returns: a filter identifier that can be used with
3696 * g_dbus_connection_remove_filter()
3701 g_dbus_connection_add_filter (GDBusConnection *connection,
3702 GDBusMessageFilterFunction filter_function,
3704 GDestroyNotify user_data_free_func)
3708 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3709 g_return_val_if_fail (filter_function != NULL, 0);
3710 g_return_val_if_fail (check_initialized (connection), 0);
3712 CONNECTION_LOCK (connection);
3713 data = g_new0 (FilterData, 1);
3714 data->id = _global_filter_id++; /* TODO: overflow etc. */
3715 data->filter_function = filter_function;
3716 data->user_data = user_data;
3717 data->user_data_free_func = user_data_free_func;
3718 g_ptr_array_add (connection->filters, data);
3719 CONNECTION_UNLOCK (connection);
3724 /* only called from finalize(), removes all filters */
3726 purge_all_filters (GDBusConnection *connection)
3729 for (n = 0; n < connection->filters->len; n++)
3731 FilterData *data = connection->filters->pdata[n];
3732 if (data->user_data_free_func != NULL)
3733 data->user_data_free_func (data->user_data);
3739 * g_dbus_connection_remove_filter:
3740 * @connection: a #GDBusConnection
3741 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
3748 g_dbus_connection_remove_filter (GDBusConnection *connection,
3752 FilterData *to_destroy;
3754 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3755 g_return_if_fail (check_initialized (connection));
3757 CONNECTION_LOCK (connection);
3759 for (n = 0; n < connection->filters->len; n++)
3761 FilterData *data = connection->filters->pdata[n];
3762 if (data->id == filter_id)
3764 g_ptr_array_remove_index (connection->filters, n);
3769 CONNECTION_UNLOCK (connection);
3771 /* do free without holding lock */
3772 if (to_destroy != NULL)
3774 if (to_destroy->user_data_free_func != NULL)
3775 to_destroy->user_data_free_func (to_destroy->user_data);
3776 g_free (to_destroy);
3780 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
3784 /* ---------------------------------------------------------------------------------------------------- */
3790 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
3791 gchar *interface_name;
3795 GDBusSignalFlags flags;
3796 GArray *subscribers;
3801 GDBusSignalCallback callback;
3803 GDestroyNotify user_data_free_func;
3805 GMainContext *context;
3809 signal_data_free (SignalData *signal_data)
3811 g_free (signal_data->rule);
3812 g_free (signal_data->sender);
3813 g_free (signal_data->sender_unique_name);
3814 g_free (signal_data->interface_name);
3815 g_free (signal_data->member);
3816 g_free (signal_data->object_path);
3817 g_free (signal_data->arg0);
3818 g_array_free (signal_data->subscribers, TRUE);
3819 g_free (signal_data);
3823 args_to_rule (const gchar *sender,
3824 const gchar *interface_name,
3825 const gchar *member,
3826 const gchar *object_path,
3828 GDBusSignalFlags flags)
3832 rule = g_string_new ("type='signal'");
3833 if (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE)
3834 g_string_prepend_c (rule, '-');
3836 g_string_append_printf (rule, ",sender='%s'", sender);
3837 if (interface_name != NULL)
3838 g_string_append_printf (rule, ",interface='%s'", interface_name);
3840 g_string_append_printf (rule, ",member='%s'", member);
3841 if (object_path != NULL)
3842 g_string_append_printf (rule, ",path='%s'", object_path);
3846 if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
3847 g_string_append_printf (rule, ",arg0path='%s'", arg0);
3848 else if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
3849 g_string_append_printf (rule, ",arg0namespace='%s'", arg0);
3851 g_string_append_printf (rule, ",arg0='%s'", arg0);
3854 return g_string_free (rule, FALSE);
3857 static guint _global_subscriber_id = 1;
3858 static guint _global_registration_id = 1;
3859 static guint _global_subtree_registration_id = 1;
3861 /* ---------------------------------------------------------------------------------------------------- */
3863 /* Called in a user thread, lock is held */
3865 add_match_rule (GDBusConnection *connection,
3866 const gchar *match_rule)
3869 GDBusMessage *message;
3871 if (match_rule[0] == '-')
3874 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3875 "/org/freedesktop/DBus", /* path */
3876 "org.freedesktop.DBus", /* interface */
3878 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3880 if (!g_dbus_connection_send_message_unlocked (connection,
3882 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3886 g_critical ("Error while sending AddMatch() message: %s", error->message);
3887 g_error_free (error);
3889 g_object_unref (message);
3892 /* ---------------------------------------------------------------------------------------------------- */
3894 /* Called in a user thread, lock is held */
3896 remove_match_rule (GDBusConnection *connection,
3897 const gchar *match_rule)
3900 GDBusMessage *message;
3902 if (match_rule[0] == '-')
3905 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3906 "/org/freedesktop/DBus", /* path */
3907 "org.freedesktop.DBus", /* interface */
3909 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3912 if (!g_dbus_connection_send_message_unlocked (connection,
3914 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3918 /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
3919 * critical; but we're holding the lock, and our caller checked whether
3920 * we were already closed, so we can't get that error.
3922 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3923 g_error_free (error);
3925 g_object_unref (message);
3928 /* ---------------------------------------------------------------------------------------------------- */
3931 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3933 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3934 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3935 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3936 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3937 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3940 /* ---------------------------------------------------------------------------------------------------- */
3943 * g_dbus_connection_signal_subscribe:
3944 * @connection: a #GDBusConnection
3945 * @sender: (allow-none): sender name to match on (unique or well-known name)
3946 * or %NULL to listen from all senders
3947 * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
3948 * match on all interfaces
3949 * @member: (allow-none): D-Bus signal name to match on or %NULL to match on
3951 * @object_path: (allow-none): object path to match on or %NULL to match on
3953 * @arg0: (allow-none): contents of first string argument to match on or %NULL
3954 * to match on all kinds of arguments
3955 * @flags: flags describing how to subscribe to the signal (currently unused)
3956 * @callback: callback to invoke when there is a signal matching the requested data
3957 * @user_data: user data to pass to @callback
3958 * @user_data_free_func: (allow-none): function to free @user_data with when
3959 * subscription is removed or %NULL
3961 * Subscribes to signals on @connection and invokes @callback with a whenever
3962 * the signal is received. Note that @callback will be invoked in the
3963 * [thread-default main context][g-main-context-push-thread-default]
3964 * of the thread you are calling this method from.
3966 * If @connection is not a message bus connection, @sender must be
3969 * If @sender is a well-known name note that @callback is invoked with
3970 * the unique name for the owner of @sender, not the well-known name
3971 * as one would expect. This is because the message bus rewrites the
3972 * name. As such, to avoid certain race conditions, users should be
3973 * tracking the name owner of the well-known name and use that when
3974 * processing the received signal.
3976 * If one of %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE or
3977 * %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH are given, @arg0 is
3978 * interpreted as part of a namespace or path. The first argument
3979 * of a signal is matched against that part as specified by D-Bus.
3981 * Returns: a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe()
3986 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
3987 const gchar *sender,
3988 const gchar *interface_name,
3989 const gchar *member,
3990 const gchar *object_path,
3992 GDBusSignalFlags flags,
3993 GDBusSignalCallback callback,
3995 GDestroyNotify user_data_free_func)
3998 SignalData *signal_data;
3999 SignalSubscriber subscriber;
4000 GPtrArray *signal_data_array;
4001 const gchar *sender_unique_name;
4003 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
4004 * an OOM condition. We might want to change that but that would involve making
4005 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
4006 * handle that. And there's really no sensible way of handling this short of retrying
4007 * to add the match rule... and then there's the little thing that, hey, maybe there's
4008 * a reason the bus in an OOM condition.
4010 * Doable, but not really sure it's worth it...
4013 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4014 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
4015 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
4016 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
4017 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
4018 g_return_val_if_fail (callback != NULL, 0);
4019 g_return_val_if_fail (check_initialized (connection), 0);
4020 g_return_val_if_fail (!((flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH) && (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)), 0);
4021 g_return_val_if_fail (!(arg0 == NULL && (flags & (G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH | G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE))), 0);
4023 CONNECTION_LOCK (connection);
4025 /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
4026 * with a '-' character to prefix the rule (which will otherwise be
4029 * This allows us to hash the rule and do our lifecycle tracking in
4030 * the usual way, but the '-' prevents the match rule from ever
4031 * actually being send to the bus (either for add or remove).
4033 rule = args_to_rule (sender, interface_name, member, object_path, arg0, flags);
4035 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
4036 sender_unique_name = sender;
4038 sender_unique_name = "";
4040 subscriber.callback = callback;
4041 subscriber.user_data = user_data;
4042 subscriber.user_data_free_func = user_data_free_func;
4043 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
4044 subscriber.context = g_main_context_ref_thread_default ();
4046 /* see if we've already have this rule */
4047 signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
4048 if (signal_data != NULL)
4050 g_array_append_val (signal_data->subscribers, subscriber);
4055 signal_data = g_new0 (SignalData, 1);
4056 signal_data->rule = rule;
4057 signal_data->sender = g_strdup (sender);
4058 signal_data->sender_unique_name = g_strdup (sender_unique_name);
4059 signal_data->interface_name = g_strdup (interface_name);
4060 signal_data->member = g_strdup (member);
4061 signal_data->object_path = g_strdup (object_path);
4062 signal_data->arg0 = g_strdup (arg0);
4063 signal_data->flags = flags;
4064 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4065 g_array_append_val (signal_data->subscribers, subscriber);
4067 g_hash_table_insert (connection->map_rule_to_signal_data,
4071 /* Add the match rule to the bus...
4073 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
4074 * always send such messages to us.
4076 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
4078 if (connection->kdbus_worker)
4080 if (g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
4081 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
4082 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
4083 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
4084 g_strcmp0 (signal_data->member, "NameAcquired") == 0 ||
4085 g_strcmp0 (signal_data->member, "NameOwnerChanged") == 0))
4087 if (g_strcmp0 (signal_data->member, "NameAcquired") == 0)
4088 _g_kdbus_subscribe_name_acquired (connection->kdbus_worker, arg0, (guint64) subscriber.id);
4089 else if (g_strcmp0 (signal_data->member, "NameLost") == 0)
4090 _g_kdbus_subscribe_name_lost (connection->kdbus_worker, arg0, (guint64) subscriber.id);
4091 else if (g_strcmp0 (signal_data->member, "NameOwnerChanged") == 0)
4092 _g_kdbus_subscribe_name_owner_changed (connection->kdbus_worker, arg0, (guint64) subscriber.id);
4095 _g_kdbus_AddMatch (connection->kdbus_worker, signal_data->rule, subscriber.id);
4099 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
4100 add_match_rule (connection, signal_data->rule);
4104 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
4105 signal_data->sender_unique_name);
4106 if (signal_data_array == NULL)
4108 signal_data_array = g_ptr_array_new ();
4109 g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
4110 g_strdup (signal_data->sender_unique_name),
4113 g_ptr_array_add (signal_data_array, signal_data);
4116 g_hash_table_insert (connection->map_id_to_signal_data,
4117 GUINT_TO_POINTER (subscriber.id),
4120 CONNECTION_UNLOCK (connection);
4122 return subscriber.id;
4125 /* ---------------------------------------------------------------------------------------------------- */
4127 /* called in any thread */
4128 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
4130 unsubscribe_id_internal (GDBusConnection *connection,
4131 guint subscription_id,
4132 GArray *out_removed_subscribers)
4134 SignalData *signal_data;
4135 GPtrArray *signal_data_array;
4138 signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
4139 GUINT_TO_POINTER (subscription_id));
4140 if (signal_data == NULL)
4142 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
4146 for (n = 0; n < signal_data->subscribers->len; n++)
4148 SignalSubscriber *subscriber;
4150 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
4151 if (subscriber->id != subscription_id)
4154 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
4155 GUINT_TO_POINTER (subscription_id)));
4156 g_array_append_val (out_removed_subscribers, *subscriber);
4157 g_array_remove_index (signal_data->subscribers, n);
4159 if (signal_data->subscribers->len == 0)
4161 g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
4163 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
4164 signal_data->sender_unique_name);
4165 g_warn_if_fail (signal_data_array != NULL);
4166 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
4168 if (signal_data_array->len == 0)
4170 g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
4171 signal_data->sender_unique_name));
4174 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
4175 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
4176 !g_dbus_connection_is_closed (connection) &&
4177 !connection->finalizing)
4179 /* The check for g_dbus_connection_is_closed() means that
4180 * sending the RemoveMatch message can't fail with
4181 * G_IO_ERROR_CLOSED, because we're holding the lock,
4182 * so on_worker_closed() can't happen between the check we just
4183 * did, and releasing the lock later.
4185 if (connection->kdbus_worker)
4186 _g_kdbus_RemoveMatch (connection->kdbus_worker, subscription_id);
4188 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
4189 remove_match_rule (connection, signal_data->rule);
4192 signal_data_free (signal_data);
4198 g_assert_not_reached ();
4205 * g_dbus_connection_signal_unsubscribe:
4206 * @connection: a #GDBusConnection
4207 * @subscription_id: a subscription id obtained from
4208 * g_dbus_connection_signal_subscribe()
4210 * Unsubscribes from signals.
4215 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
4216 guint subscription_id)
4218 GArray *subscribers;
4221 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
4222 g_return_if_fail (check_initialized (connection));
4224 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4226 CONNECTION_LOCK (connection);
4227 unsubscribe_id_internal (connection,
4230 CONNECTION_UNLOCK (connection);
4233 g_assert (subscribers->len == 0 || subscribers->len == 1);
4235 /* call GDestroyNotify without lock held */
4236 for (n = 0; n < subscribers->len; n++)
4238 SignalSubscriber *subscriber;
4239 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
4240 call_destroy_notify (subscriber->context,
4241 subscriber->user_data_free_func,
4242 subscriber->user_data);
4243 g_main_context_unref (subscriber->context);
4246 g_array_free (subscribers, TRUE);
4249 /* ---------------------------------------------------------------------------------------------------- */
4253 guint subscription_id;
4254 GDBusSignalCallback callback;
4256 GDBusMessage *message;
4257 GDBusConnection *connection;
4258 const gchar *sender;
4260 const gchar *interface;
4261 const gchar *member;
4264 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
4268 emit_signal_instance_in_idle_cb (gpointer data)
4270 SignalInstance *signal_instance = data;
4271 GVariant *parameters;
4272 gboolean has_subscription;
4274 parameters = g_dbus_message_get_body (signal_instance->message);
4275 if (parameters == NULL)
4277 parameters = g_variant_new ("()");
4278 g_variant_ref_sink (parameters);
4282 g_variant_ref (parameters);
4286 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
4287 signal_instance->subscription_id,
4288 signal_instance->sender,
4289 signal_instance->path,
4290 signal_instance->interface,
4291 signal_instance->member,
4292 g_variant_print (parameters, TRUE));
4295 /* Careful here, don't do the callback if we no longer has the subscription */
4296 CONNECTION_LOCK (signal_instance->connection);
4297 has_subscription = FALSE;
4298 if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
4299 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
4300 has_subscription = TRUE;
4301 CONNECTION_UNLOCK (signal_instance->connection);
4303 if (has_subscription)
4304 signal_instance->callback (signal_instance->connection,
4305 signal_instance->sender,
4306 signal_instance->path,
4307 signal_instance->interface,
4308 signal_instance->member,
4310 signal_instance->user_data);
4312 g_variant_unref (parameters);
4318 signal_instance_free (SignalInstance *signal_instance)
4320 g_object_unref (signal_instance->message);
4321 g_object_unref (signal_instance->connection);
4322 g_free (signal_instance);
4326 namespace_rule_matches (const gchar *namespace,
4332 len_namespace = strlen (namespace);
4333 len_name = strlen (name);
4335 if (len_name < len_namespace)
4338 if (memcmp (namespace, name, len_namespace) != 0)
4341 return len_namespace == len_name || name[len_namespace] == '.';
4345 path_rule_matches (const gchar *path_a,
4346 const gchar *path_b)
4350 len_a = strlen (path_a);
4351 len_b = strlen (path_b);
4353 if (len_a < len_b && path_a[len_a - 1] != '/')
4356 if (len_b < len_a && path_b[len_b - 1] != '/')
4359 return memcmp (path_a, path_b, MIN (len_a, len_b)) == 0;
4362 /* called in GDBusWorker thread WITH lock held */
4364 schedule_callbacks (GDBusConnection *connection,
4365 GPtrArray *signal_data_array,
4366 GDBusMessage *message,
4367 const gchar *sender)
4370 const gchar *interface;
4371 const gchar *member;
4380 interface = g_dbus_message_get_interface (message);
4381 member = g_dbus_message_get_member (message);
4382 path = g_dbus_message_get_path (message);
4383 arg0 = g_dbus_message_get_arg0 (message);
4386 g_print ("In schedule_callbacks:\n"
4388 " interface = '%s'\n"
4399 /* TODO: if this is slow, then we can change signal_data_array into
4400 * map_object_path_to_signal_data_array or something.
4402 for (n = 0; n < signal_data_array->len; n++)
4404 SignalData *signal_data = signal_data_array->pdata[n];
4406 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
4409 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
4412 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
4415 if (signal_data->arg0 != NULL)
4420 if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
4422 if (!namespace_rule_matches (signal_data->arg0, arg0))
4425 else if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
4427 if (!path_rule_matches (signal_data->arg0, arg0))
4430 else if (!g_str_equal (signal_data->arg0, arg0))
4434 for (m = 0; m < signal_data->subscribers->len; m++)
4436 SignalSubscriber *subscriber;
4437 GSource *idle_source;
4438 SignalInstance *signal_instance;
4440 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
4442 signal_instance = g_new0 (SignalInstance, 1);
4443 signal_instance->subscription_id = subscriber->id;
4444 signal_instance->callback = subscriber->callback;
4445 signal_instance->user_data = subscriber->user_data;
4446 signal_instance->message = g_object_ref (message);
4447 signal_instance->connection = g_object_ref (connection);
4448 signal_instance->sender = sender;
4449 signal_instance->path = path;
4450 signal_instance->interface = interface;
4451 signal_instance->member = member;
4453 idle_source = g_idle_source_new ();
4454 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4455 g_source_set_callback (idle_source,
4456 emit_signal_instance_in_idle_cb,
4458 (GDestroyNotify) signal_instance_free);
4459 g_source_set_name (idle_source, "[gio] emit_signal_instance_in_idle_cb");
4460 g_source_attach (idle_source, subscriber->context);
4461 g_source_unref (idle_source);
4466 /* called in GDBusWorker thread with lock held */
4468 distribute_signals (GDBusConnection *connection,
4469 GDBusMessage *message)
4471 GPtrArray *signal_data_array;
4472 const gchar *sender;
4474 sender = g_dbus_message_get_sender (message);
4476 if (G_UNLIKELY (_g_dbus_debug_signal ()))
4478 _g_dbus_debug_print_lock ();
4479 g_print ("========================================================================\n"
4480 "GDBus-debug:Signal:\n"
4481 " <<<< RECEIVED SIGNAL %s.%s\n"
4483 " sent by name %s\n",
4484 g_dbus_message_get_interface (message),
4485 g_dbus_message_get_member (message),
4486 g_dbus_message_get_path (message),
4487 sender != NULL ? sender : "(none)");
4488 _g_dbus_debug_print_unlock ();
4491 /* collect subscribers that match on sender */
4494 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
4495 if (signal_data_array != NULL)
4496 schedule_callbacks (connection, signal_data_array, message, sender);
4499 /* collect subscribers not matching on sender */
4500 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
4501 if (signal_data_array != NULL)
4502 schedule_callbacks (connection, signal_data_array, message, sender);
4505 /* ---------------------------------------------------------------------------------------------------- */
4507 /* only called from finalize(), removes all subscriptions */
4509 purge_all_signal_subscriptions (GDBusConnection *connection)
4511 GHashTableIter iter;
4514 GArray *subscribers;
4517 ids = g_array_new (FALSE, FALSE, sizeof (guint));
4518 g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
4519 while (g_hash_table_iter_next (&iter, &key, NULL))
4521 guint subscription_id = GPOINTER_TO_UINT (key);
4522 g_array_append_val (ids, subscription_id);
4525 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4526 for (n = 0; n < ids->len; n++)
4528 guint subscription_id = g_array_index (ids, guint, n);
4529 unsubscribe_id_internal (connection,
4533 g_array_free (ids, TRUE);
4535 /* call GDestroyNotify without lock held */
4536 for (n = 0; n < subscribers->len; n++)
4538 SignalSubscriber *subscriber;
4539 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
4540 call_destroy_notify (subscriber->context,
4541 subscriber->user_data_free_func,
4542 subscriber->user_data);
4543 g_main_context_unref (subscriber->context);
4546 g_array_free (subscribers, TRUE);
4549 /* ---------------------------------------------------------------------------------------------------- */
4551 static GDBusInterfaceVTable *
4552 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
4554 /* Don't waste memory by copying padding - remember to update this
4555 * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
4557 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
4561 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
4566 /* ---------------------------------------------------------------------------------------------------- */
4568 static GDBusSubtreeVTable *
4569 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
4571 /* Don't waste memory by copying padding - remember to update this
4572 * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
4574 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
4578 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
4583 /* ---------------------------------------------------------------------------------------------------- */
4585 struct ExportedObject
4588 GDBusConnection *connection;
4590 /* maps gchar* -> ExportedInterface* */
4591 GHashTable *map_if_name_to_ei;
4594 /* only called with lock held */
4596 exported_object_free (ExportedObject *eo)
4598 g_free (eo->object_path);
4599 g_hash_table_unref (eo->map_if_name_to_ei);
4608 gchar *interface_name;
4609 GDBusInterfaceVTable *vtable;
4610 GDBusInterfaceInfo *interface_info;
4612 GMainContext *context;
4614 GDestroyNotify user_data_free_func;
4615 } ExportedInterface;
4617 /* called with lock held */
4619 exported_interface_free (ExportedInterface *ei)
4621 g_dbus_interface_info_cache_release (ei->interface_info);
4622 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
4624 call_destroy_notify (ei->context,
4625 ei->user_data_free_func,
4628 g_main_context_unref (ei->context);
4630 g_free (ei->interface_name);
4631 _g_dbus_interface_vtable_free (ei->vtable);
4635 /* ---------------------------------------------------------------------------------------------------- */
4637 /* Convenience function to check if @registration_id (if not zero) or
4638 * @subtree_registration_id (if not zero) has been unregistered. If
4639 * so, returns %TRUE.
4641 * May be called by any thread. Caller must *not* hold lock.
4644 has_object_been_unregistered (GDBusConnection *connection,
4645 guint registration_id,
4646 guint subtree_registration_id)
4650 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4654 CONNECTION_LOCK (connection);
4655 if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
4656 GUINT_TO_POINTER (registration_id)) == NULL)
4660 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
4661 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
4665 CONNECTION_UNLOCK (connection);
4670 /* ---------------------------------------------------------------------------------------------------- */
4674 GDBusConnection *connection;
4675 GDBusMessage *message;
4677 const gchar *property_name;
4678 const GDBusInterfaceVTable *vtable;
4679 GDBusInterfaceInfo *interface_info;
4680 const GDBusPropertyInfo *property_info;
4681 guint registration_id;
4682 guint subtree_registration_id;
4686 property_data_free (PropertyData *data)
4688 g_object_unref (data->connection);
4689 g_object_unref (data->message);
4693 /* called in thread where object was registered - no locks held */
4695 invoke_get_property_in_idle_cb (gpointer _data)
4697 PropertyData *data = _data;
4700 GDBusMessage *reply;
4702 if (has_object_been_unregistered (data->connection,
4703 data->registration_id,
4704 data->subtree_registration_id))
4706 reply = g_dbus_message_new_method_error (data->message,
4707 "org.freedesktop.DBus.Error.UnknownMethod",
4708 _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
4709 g_dbus_message_get_path (data->message));
4710 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4711 g_object_unref (reply);
4716 value = data->vtable->get_property (data->connection,
4717 g_dbus_message_get_sender (data->message),
4718 g_dbus_message_get_path (data->message),
4719 data->interface_info->name,
4720 data->property_name,
4727 g_assert_no_error (error);
4729 g_variant_take_ref (value);
4730 reply = g_dbus_message_new_method_reply (data->message);
4731 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
4732 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4733 g_variant_unref (value);
4734 g_object_unref (reply);
4738 gchar *dbus_error_name;
4739 g_assert (error != NULL);
4740 dbus_error_name = g_dbus_error_encode_gerror (error);
4741 reply = g_dbus_message_new_method_error_literal (data->message,
4744 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4745 g_free (dbus_error_name);
4746 g_error_free (error);
4747 g_object_unref (reply);
4754 /* called in thread where object was registered - no locks held */
4756 invoke_set_property_in_idle_cb (gpointer _data)
4758 PropertyData *data = _data;
4760 GDBusMessage *reply;
4766 g_variant_get (g_dbus_message_get_body (data->message),
4772 if (!data->vtable->set_property (data->connection,
4773 g_dbus_message_get_sender (data->message),
4774 g_dbus_message_get_path (data->message),
4775 data->interface_info->name,
4776 data->property_name,
4781 gchar *dbus_error_name;
4782 g_assert (error != NULL);
4783 dbus_error_name = g_dbus_error_encode_gerror (error);
4784 reply = g_dbus_message_new_method_error_literal (data->message,
4787 g_free (dbus_error_name);
4788 g_error_free (error);
4792 reply = g_dbus_message_new_method_reply (data->message);
4795 g_assert (reply != NULL);
4796 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4797 g_object_unref (reply);
4798 g_variant_unref (value);
4803 /* called in any thread with connection's lock held */
4805 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
4806 GDBusMessage *message,
4807 guint registration_id,
4808 guint subtree_registration_id,
4810 GDBusInterfaceInfo *interface_info,
4811 const GDBusInterfaceVTable *vtable,
4812 GMainContext *main_context,
4816 const char *interface_name;
4817 const char *property_name;
4818 const GDBusPropertyInfo *property_info;
4819 GSource *idle_source;
4820 PropertyData *property_data;
4821 GDBusMessage *reply;
4826 g_variant_get (g_dbus_message_get_body (message),
4831 g_variant_get (g_dbus_message_get_body (message),
4840 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
4842 property_info = NULL;
4844 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4845 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
4846 if (property_info == NULL)
4848 reply = g_dbus_message_new_method_error (message,
4849 "org.freedesktop.DBus.Error.InvalidArgs",
4850 _("No such property '%s'"),
4852 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4853 g_object_unref (reply);
4858 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4860 reply = g_dbus_message_new_method_error (message,
4861 "org.freedesktop.DBus.Error.InvalidArgs",
4862 _("Property '%s' is not readable"),
4864 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4865 g_object_unref (reply);
4869 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
4871 reply = g_dbus_message_new_method_error (message,
4872 "org.freedesktop.DBus.Error.InvalidArgs",
4873 _("Property '%s' is not writable"),
4875 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4876 g_object_unref (reply);
4885 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
4886 * of the given value is wrong
4888 g_variant_get_child (g_dbus_message_get_body (message), 2, "v", &value);
4889 if (g_strcmp0 (g_variant_get_type_string (value), property_info->signature) != 0)
4891 reply = g_dbus_message_new_method_error (message,
4892 "org.freedesktop.DBus.Error.InvalidArgs",
4893 _("Error setting property '%s': Expected type '%s' but got '%s'"),
4894 property_name, property_info->signature,
4895 g_variant_get_type_string (value));
4896 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4897 g_variant_unref (value);
4898 g_object_unref (reply);
4903 g_variant_unref (value);
4906 /* If the vtable pointer for get_property() resp. set_property() is
4907 * NULL then dispatch the call via the method_call() handler.
4911 if (vtable->get_property == NULL)
4913 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4914 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4915 vtable, main_context, user_data);
4922 if (vtable->set_property == NULL)
4924 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4925 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4926 vtable, main_context, user_data);
4932 /* ok, got the property info - call user code in an idle handler */
4933 property_data = g_new0 (PropertyData, 1);
4934 property_data->connection = g_object_ref (connection);
4935 property_data->message = g_object_ref (message);
4936 property_data->user_data = user_data;
4937 property_data->property_name = property_name;
4938 property_data->vtable = vtable;
4939 property_data->interface_info = interface_info;
4940 property_data->property_info = property_info;
4941 property_data->registration_id = registration_id;
4942 property_data->subtree_registration_id = subtree_registration_id;
4944 idle_source = g_idle_source_new ();
4945 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4946 g_source_set_callback (idle_source,
4947 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
4949 (GDestroyNotify) property_data_free);
4951 g_source_set_name (idle_source, "[gio] invoke_get_property_in_idle_cb");
4953 g_source_set_name (idle_source, "[gio] invoke_set_property_in_idle_cb");
4954 g_source_attach (idle_source, main_context);
4955 g_source_unref (idle_source);
4963 /* called in GDBusWorker thread with connection's lock held */
4965 handle_getset_property (GDBusConnection *connection,
4967 GDBusMessage *message,
4970 ExportedInterface *ei;
4972 const char *interface_name;
4973 const char *property_name;
4978 g_variant_get (g_dbus_message_get_body (message),
4983 g_variant_get (g_dbus_message_get_body (message),
4989 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4990 * no such interface registered
4992 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4995 GDBusMessage *reply;
4996 reply = g_dbus_message_new_method_error (message,
4997 "org.freedesktop.DBus.Error.InvalidArgs",
4998 _("No such interface '%s'"),
5000 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5001 g_object_unref (reply);
5006 handled = validate_and_maybe_schedule_property_getset (eo->connection,
5019 /* ---------------------------------------------------------------------------------------------------- */
5023 GDBusConnection *connection;
5024 GDBusMessage *message;
5026 const GDBusInterfaceVTable *vtable;
5027 GDBusInterfaceInfo *interface_info;
5028 guint registration_id;
5029 guint subtree_registration_id;
5030 } PropertyGetAllData;
5033 property_get_all_data_free (PropertyData *data)
5035 g_object_unref (data->connection);
5036 g_object_unref (data->message);
5040 /* called in thread where object was registered - no locks held */
5042 invoke_get_all_properties_in_idle_cb (gpointer _data)
5044 PropertyGetAllData *data = _data;
5045 GVariantBuilder builder;
5046 GDBusMessage *reply;
5049 if (has_object_been_unregistered (data->connection,
5050 data->registration_id,
5051 data->subtree_registration_id))
5053 reply = g_dbus_message_new_method_error (data->message,
5054 "org.freedesktop.DBus.Error.UnknownMethod",
5055 _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
5056 g_dbus_message_get_path (data->message));
5057 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5058 g_object_unref (reply);
5062 /* TODO: Right now we never fail this call - we just omit values if
5063 * a get_property() call is failing.
5065 * We could fail the whole call if just a single get_property() call
5066 * returns an error. We need clarification in the D-Bus spec about this.
5068 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
5069 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
5070 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
5072 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
5075 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
5078 value = data->vtable->get_property (data->connection,
5079 g_dbus_message_get_sender (data->message),
5080 g_dbus_message_get_path (data->message),
5081 data->interface_info->name,
5082 property_info->name,
5089 g_variant_take_ref (value);
5090 g_variant_builder_add (&builder,
5092 property_info->name,
5094 g_variant_unref (value);
5096 g_variant_builder_close (&builder);
5098 reply = g_dbus_message_new_method_reply (data->message);
5099 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
5100 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5101 g_object_unref (reply);
5108 interface_has_readable_properties (GDBusInterfaceInfo *interface_info)
5112 if (!interface_info->properties)
5115 for (i = 0; interface_info->properties[i]; i++)
5116 if (interface_info->properties[i]->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)
5122 /* called in any thread with connection's lock held */
5124 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
5125 GDBusMessage *message,
5126 guint registration_id,
5127 guint subtree_registration_id,
5128 GDBusInterfaceInfo *interface_info,
5129 const GDBusInterfaceVTable *vtable,
5130 GMainContext *main_context,
5134 GSource *idle_source;
5135 PropertyGetAllData *property_get_all_data;
5142 /* If the vtable pointer for get_property() is NULL but we have a
5143 * non-zero number of readable properties, then dispatch the call via
5144 * the method_call() handler.
5146 if (vtable->get_property == NULL && interface_has_readable_properties (interface_info))
5148 schedule_method_call (connection, message, registration_id, subtree_registration_id,
5149 interface_info, NULL, NULL, g_dbus_message_get_body (message),
5150 vtable, main_context, user_data);
5155 /* ok, got the property info - call user in an idle handler */
5156 property_get_all_data = g_new0 (PropertyGetAllData, 1);
5157 property_get_all_data->connection = g_object_ref (connection);
5158 property_get_all_data->message = g_object_ref (message);
5159 property_get_all_data->user_data = user_data;
5160 property_get_all_data->vtable = vtable;
5161 property_get_all_data->interface_info = interface_info;
5162 property_get_all_data->registration_id = registration_id;
5163 property_get_all_data->subtree_registration_id = subtree_registration_id;
5165 idle_source = g_idle_source_new ();
5166 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
5167 g_source_set_callback (idle_source,
5168 invoke_get_all_properties_in_idle_cb,
5169 property_get_all_data,
5170 (GDestroyNotify) property_get_all_data_free);
5171 g_source_set_name (idle_source, "[gio] invoke_get_all_properties_in_idle_cb");
5172 g_source_attach (idle_source, main_context);
5173 g_source_unref (idle_source);
5181 /* called in GDBusWorker thread with connection's lock held */
5183 handle_get_all_properties (GDBusConnection *connection,
5185 GDBusMessage *message)
5187 ExportedInterface *ei;
5189 const char *interface_name;
5193 g_variant_get (g_dbus_message_get_body (message),
5197 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
5198 * no such interface registered
5200 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
5203 GDBusMessage *reply;
5204 reply = g_dbus_message_new_method_error (message,
5205 "org.freedesktop.DBus.Error.InvalidArgs",
5206 _("No such interface"),
5208 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5209 g_object_unref (reply);
5214 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
5226 /* ---------------------------------------------------------------------------------------------------- */
5228 static const gchar introspect_header[] =
5229 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
5230 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
5231 "<!-- GDBus " PACKAGE_VERSION " -->\n"
5234 static const gchar introspect_tail[] =
5237 static const gchar introspect_properties_interface[] =
5238 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
5239 " <method name=\"Get\">\n"
5240 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5241 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
5242 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
5244 " <method name=\"GetAll\">\n"
5245 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5246 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
5248 " <method name=\"Set\">\n"
5249 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5250 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
5251 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
5253 " <signal name=\"PropertiesChanged\">\n"
5254 " <arg type=\"s\" name=\"interface_name\"/>\n"
5255 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
5256 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
5260 static const gchar introspect_introspectable_interface[] =
5261 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
5262 " <method name=\"Introspect\">\n"
5263 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
5266 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
5267 " <method name=\"Ping\"/>\n"
5268 " <method name=\"GetMachineId\">\n"
5269 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
5274 introspect_append_header (GString *s)
5276 g_string_append (s, introspect_header);
5280 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
5282 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
5288 begin = object_path + path_len;
5289 end = strchr (begin, '/');
5291 s = g_strndup (begin, end - begin);
5293 s = g_strdup (begin);
5295 if (g_hash_table_lookup (set, s) == NULL)
5296 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
5302 /* TODO: we want a nicer public interface for this */
5303 /* called in any thread with connection's lock held */
5305 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
5310 GHashTableIter hash_iter;
5311 const gchar *object_path;
5317 CONNECTION_ENSURE_LOCK (connection);
5319 path_len = strlen (path);
5323 set = g_hash_table_new (g_str_hash, g_str_equal);
5325 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
5326 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
5327 maybe_add_path (path, path_len, object_path, set);
5329 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
5330 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
5331 maybe_add_path (path, path_len, object_path, set);
5333 p = g_ptr_array_new ();
5334 keys = g_hash_table_get_keys (set);
5335 for (l = keys; l != NULL; l = l->next)
5336 g_ptr_array_add (p, l->data);
5337 g_hash_table_unref (set);
5340 g_ptr_array_add (p, NULL);
5341 ret = (gchar **) g_ptr_array_free (p, FALSE);
5345 /* called in any thread with connection's lock not held */
5347 g_dbus_connection_list_registered (GDBusConnection *connection,
5351 CONNECTION_LOCK (connection);
5352 ret = g_dbus_connection_list_registered_unlocked (connection, path);
5353 CONNECTION_UNLOCK (connection);
5357 /* called in GDBusWorker thread with connection's lock held */
5359 handle_introspect (GDBusConnection *connection,
5361 GDBusMessage *message)
5365 GDBusMessage *reply;
5366 GHashTableIter hash_iter;
5367 ExportedInterface *ei;
5370 /* first the header with the standard interfaces */
5371 s = g_string_sized_new (sizeof (introspect_header) +
5372 sizeof (introspect_properties_interface) +
5373 sizeof (introspect_introspectable_interface) +
5374 sizeof (introspect_tail));
5375 introspect_append_header (s);
5376 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
5377 "org.freedesktop.DBus.Properties"))
5378 g_string_append (s, introspect_properties_interface);
5380 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
5381 "org.freedesktop.DBus.Introspectable"))
5382 g_string_append (s, introspect_introspectable_interface);
5384 /* then include the registered interfaces */
5385 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
5386 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
5387 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
5389 /* finally include nodes registered below us */
5390 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
5391 for (n = 0; registered != NULL && registered[n] != NULL; n++)
5392 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
5393 g_strfreev (registered);
5394 g_string_append (s, introspect_tail);
5396 reply = g_dbus_message_new_method_reply (message);
5397 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5398 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5399 g_object_unref (reply);
5400 g_string_free (s, TRUE);
5405 /* called in thread where object was registered - no locks held */
5407 call_in_idle_cb (gpointer user_data)
5409 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
5410 GDBusInterfaceVTable *vtable;
5411 guint registration_id;
5412 guint subtree_registration_id;
5414 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
5415 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
5417 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
5419 subtree_registration_id))
5421 GDBusMessage *reply;
5422 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
5423 "org.freedesktop.DBus.Error.UnknownMethod",
5424 _("No such interface '%s' on object at path %s"),
5425 g_dbus_method_invocation_get_interface_name (invocation),
5426 g_dbus_method_invocation_get_object_path (invocation));
5427 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5428 g_object_unref (reply);
5432 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
5433 g_assert (vtable != NULL && vtable->method_call != NULL);
5435 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
5436 g_dbus_method_invocation_get_sender (invocation),
5437 g_dbus_method_invocation_get_object_path (invocation),
5438 g_dbus_method_invocation_get_interface_name (invocation),
5439 g_dbus_method_invocation_get_method_name (invocation),
5440 g_dbus_method_invocation_get_parameters (invocation),
5441 g_object_ref (invocation),
5442 g_dbus_method_invocation_get_user_data (invocation));
5448 /* called in GDBusWorker thread with connection's lock held */
5450 schedule_method_call (GDBusConnection *connection,
5451 GDBusMessage *message,
5452 guint registration_id,
5453 guint subtree_registration_id,
5454 const GDBusInterfaceInfo *interface_info,
5455 const GDBusMethodInfo *method_info,
5456 const GDBusPropertyInfo *property_info,
5457 GVariant *parameters,
5458 const GDBusInterfaceVTable *vtable,
5459 GMainContext *main_context,
5462 GDBusMethodInvocation *invocation;
5463 GSource *idle_source;
5465 invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
5466 g_dbus_message_get_path (message),
5467 g_dbus_message_get_interface (message),
5468 g_dbus_message_get_member (message),
5476 /* TODO: would be nicer with a real MethodData like we already
5477 * have PropertyData and PropertyGetAllData... */
5478 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
5479 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
5480 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
5482 idle_source = g_idle_source_new ();
5483 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
5484 g_source_set_callback (idle_source,
5488 g_source_set_name (idle_source, "[gio] call_in_idle_cb");
5489 g_source_attach (idle_source, main_context);
5490 g_source_unref (idle_source);
5493 /* called in GDBusWorker thread with connection's lock held */
5495 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
5496 GDBusMessage *message,
5497 guint registration_id,
5498 guint subtree_registration_id,
5499 GDBusInterfaceInfo *interface_info,
5500 const GDBusInterfaceVTable *vtable,
5501 GMainContext *main_context,
5504 GDBusMethodInfo *method_info;
5505 GDBusMessage *reply;
5506 GVariant *parameters;
5508 GVariantType *in_type;
5512 /* TODO: the cost of this is O(n) - it might be worth caching the result */
5513 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
5515 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
5516 * error to the caller
5518 if (method_info == NULL)
5520 reply = g_dbus_message_new_method_error (message,
5521 "org.freedesktop.DBus.Error.UnknownMethod",
5522 _("No such method '%s'"),
5523 g_dbus_message_get_member (message));
5524 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5525 g_object_unref (reply);
5530 parameters = g_dbus_message_get_body (message);
5531 if (parameters == NULL)
5533 parameters = g_variant_new ("()");
5534 g_variant_ref_sink (parameters);
5538 g_variant_ref (parameters);
5541 /* Check that the incoming args are of the right type - if they are not, return
5542 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
5544 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
5545 if (!g_variant_is_of_type (parameters, in_type))
5549 type_string = g_variant_type_dup_string (in_type);
5551 reply = g_dbus_message_new_method_error (message,
5552 "org.freedesktop.DBus.Error.InvalidArgs",
5553 _("Type of message, '%s', does not match expected type '%s'"),
5554 g_variant_get_type_string (parameters),
5556 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5557 g_variant_type_free (in_type);
5558 g_variant_unref (parameters);
5559 g_object_unref (reply);
5560 g_free (type_string);
5564 g_variant_type_free (in_type);
5566 /* schedule the call in idle */
5567 schedule_method_call (connection, message, registration_id, subtree_registration_id,
5568 interface_info, method_info, NULL, parameters,
5569 vtable, main_context, user_data);
5570 g_variant_unref (parameters);
5577 /* ---------------------------------------------------------------------------------------------------- */
5579 /* called in GDBusWorker thread with connection's lock held */
5581 obj_message_func (GDBusConnection *connection,
5583 GDBusMessage *message)
5585 const gchar *interface_name;
5586 const gchar *member;
5587 const gchar *signature;
5592 interface_name = g_dbus_message_get_interface (message);
5593 member = g_dbus_message_get_member (message);
5594 signature = g_dbus_message_get_signature (message);
5596 /* see if we have an interface for handling this call */
5597 if (interface_name != NULL)
5599 ExportedInterface *ei;
5600 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
5603 /* we do - invoke the handler in idle in the right thread */
5605 /* handle no vtable or handler being present */
5606 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
5609 handled = validate_and_maybe_schedule_method_call (connection,
5621 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
5622 g_strcmp0 (member, "Introspect") == 0 &&
5623 g_strcmp0 (signature, "") == 0)
5625 handled = handle_introspect (connection, eo, message);
5628 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5629 g_strcmp0 (member, "Get") == 0 &&
5630 g_strcmp0 (signature, "ss") == 0)
5632 handled = handle_getset_property (connection, eo, message, TRUE);
5635 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5636 g_strcmp0 (member, "Set") == 0 &&
5637 g_strcmp0 (signature, "ssv") == 0)
5639 handled = handle_getset_property (connection, eo, message, FALSE);
5642 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5643 g_strcmp0 (member, "GetAll") == 0 &&
5644 g_strcmp0 (signature, "s") == 0)
5646 handled = handle_get_all_properties (connection, eo, message);
5655 * g_dbus_connection_register_object:
5656 * @connection: a #GDBusConnection
5657 * @object_path: the object path to register at
5658 * @interface_info: introspection data for the interface
5659 * @vtable: (allow-none): a #GDBusInterfaceVTable to call into or %NULL
5660 * @user_data: (allow-none): data to pass to functions in @vtable
5661 * @user_data_free_func: function to call when the object path is unregistered
5662 * @error: return location for error or %NULL
5664 * Registers callbacks for exported objects at @object_path with the
5665 * D-Bus interface that is described in @interface_info.
5667 * Calls to functions in @vtable (and @user_data_free_func) will happen
5669 * [thread-default main context][g-main-context-push-thread-default]
5670 * of the thread you are calling this method from.
5672 * Note that all #GVariant values passed to functions in @vtable will match
5673 * the signature given in @interface_info - if a remote caller passes
5674 * incorrect values, the `org.freedesktop.DBus.Error.InvalidArgs`
5675 * is returned to the remote caller.
5677 * Additionally, if the remote caller attempts to invoke methods or
5678 * access properties not mentioned in @interface_info the
5679 * `org.freedesktop.DBus.Error.UnknownMethod` resp.
5680 * `org.freedesktop.DBus.Error.InvalidArgs` errors
5681 * are returned to the caller.
5683 * It is considered a programming error if the
5684 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
5685 * #GVariant of incorrect type.
5687 * If an existing callback is already registered at @object_path and
5688 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
5690 * GDBus automatically implements the standard D-Bus interfaces
5691 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
5692 * and org.freedesktop.Peer, so you don't have to implement those for the
5693 * objects you export. You can implement org.freedesktop.DBus.Properties
5694 * yourself, e.g. to handle getting and setting of properties asynchronously.
5696 * Note that the reference count on @interface_info will be
5697 * incremented by 1 (unless allocated statically, e.g. if the
5698 * reference count is -1, see g_dbus_interface_info_ref()) for as long
5699 * as the object is exported. Also note that @vtable will be copied.
5701 * See this [server][gdbus-server] for an example of how to use this method.
5703 * Returns: 0 if @error is set, otherwise a registration id (never 0)
5704 * that can be used with g_dbus_connection_unregister_object()
5709 g_dbus_connection_register_object (GDBusConnection *connection,
5710 const gchar *object_path,
5711 GDBusInterfaceInfo *interface_info,
5712 const GDBusInterfaceVTable *vtable,
5714 GDestroyNotify user_data_free_func,
5718 ExportedInterface *ei;
5721 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
5722 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
5723 g_return_val_if_fail (interface_info != NULL, 0);
5724 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
5725 g_return_val_if_fail (error == NULL || *error == NULL, 0);
5726 g_return_val_if_fail (check_initialized (connection), 0);
5730 CONNECTION_LOCK (connection);
5732 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
5735 eo = g_new0 (ExportedObject, 1);
5736 eo->object_path = g_strdup (object_path);
5737 eo->connection = connection;
5738 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
5741 (GDestroyNotify) exported_interface_free);
5742 g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
5745 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
5751 _("An object is already exported for the interface %s at %s"),
5752 interface_info->name,
5757 ei = g_new0 (ExportedInterface, 1);
5758 ei->id = _global_registration_id++; /* TODO: overflow etc. */
5760 ei->user_data = user_data;
5761 ei->user_data_free_func = user_data_free_func;
5762 ei->vtable = _g_dbus_interface_vtable_copy (vtable);
5763 ei->interface_info = g_dbus_interface_info_ref (interface_info);
5764 g_dbus_interface_info_cache_build (ei->interface_info);
5765 ei->interface_name = g_strdup (interface_info->name);
5766 ei->context = g_main_context_ref_thread_default ();
5768 g_hash_table_insert (eo->map_if_name_to_ei,
5769 (gpointer) ei->interface_name,
5771 g_hash_table_insert (connection->map_id_to_ei,
5772 GUINT_TO_POINTER (ei->id),
5778 CONNECTION_UNLOCK (connection);
5784 * g_dbus_connection_unregister_object:
5785 * @connection: a #GDBusConnection
5786 * @registration_id: a registration id obtained from
5787 * g_dbus_connection_register_object()
5789 * Unregisters an object.
5791 * Returns: %TRUE if the object was unregistered, %FALSE otherwise
5796 g_dbus_connection_unregister_object (GDBusConnection *connection,
5797 guint registration_id)
5799 ExportedInterface *ei;
5803 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5804 g_return_val_if_fail (check_initialized (connection), FALSE);
5808 CONNECTION_LOCK (connection);
5810 ei = g_hash_table_lookup (connection->map_id_to_ei,
5811 GUINT_TO_POINTER (registration_id));
5817 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
5818 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
5819 /* unregister object path if we have no more exported interfaces */
5820 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
5821 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
5827 CONNECTION_UNLOCK (connection);
5832 /* ---------------------------------------------------------------------------------------------------- */
5835 * g_dbus_connection_emit_signal:
5836 * @connection: a #GDBusConnection
5837 * @destination_bus_name: (allow-none): the unique bus name for the destination
5838 * for the signal or %NULL to emit to all listeners
5839 * @object_path: path of remote object
5840 * @interface_name: D-Bus interface to emit a signal on
5841 * @signal_name: the name of the signal to emit
5842 * @parameters: (allow-none): a #GVariant tuple with parameters for the signal
5843 * or %NULL if not passing parameters
5844 * @error: Return location for error or %NULL
5848 * If the parameters GVariant is floating, it is consumed.
5850 * This can only fail if @parameters is not compatible with the D-Bus protocol.
5852 * Returns: %TRUE unless @error is set
5857 g_dbus_connection_emit_signal (GDBusConnection *connection,
5858 const gchar *destination_bus_name,
5859 const gchar *object_path,
5860 const gchar *interface_name,
5861 const gchar *signal_name,
5862 GVariant *parameters,
5865 GDBusMessage *message;
5871 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5872 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
5873 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
5874 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
5875 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
5876 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
5877 g_return_val_if_fail (check_initialized (connection), FALSE);
5879 if (G_UNLIKELY (_g_dbus_debug_emission ()))
5881 _g_dbus_debug_print_lock ();
5882 g_print ("========================================================================\n"
5883 "GDBus-debug:Emission:\n"
5884 " >>>> SIGNAL EMISSION %s.%s()\n"
5886 " destination %s\n",
5887 interface_name, signal_name,
5889 destination_bus_name != NULL ? destination_bus_name : "(none)");
5890 _g_dbus_debug_print_unlock ();
5893 message = g_dbus_message_new_signal (object_path,
5897 if (destination_bus_name != NULL)
5898 g_dbus_message_set_header (message,
5899 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
5900 g_variant_new_string (destination_bus_name));
5902 if (parameters != NULL)
5903 g_dbus_message_set_body (message, parameters);
5905 ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
5906 g_object_unref (message);
5912 add_call_flags (GDBusMessage *message,
5913 GDBusCallFlags flags)
5915 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
5916 g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
5920 decode_method_reply (GDBusMessage *reply,
5921 const gchar *method_name,
5922 const GVariantType *reply_type,
5923 GUnixFDList **out_fd_list,
5929 switch (g_dbus_message_get_message_type (reply))
5931 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
5932 result = g_dbus_message_get_body (reply);
5935 result = g_variant_new ("()");
5936 g_variant_ref_sink (result);
5940 g_variant_ref (result);
5943 if (!g_variant_is_of_type (result, reply_type))
5945 gchar *type_string = g_variant_type_dup_string (reply_type);
5949 G_IO_ERROR_INVALID_ARGUMENT,
5950 _("Method '%s' returned type '%s', but expected '%s'"),
5951 method_name, g_variant_get_type_string (result), type_string);
5953 g_variant_unref (result);
5954 g_free (type_string);
5961 if (out_fd_list != NULL)
5963 *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
5964 if (*out_fd_list != NULL)
5965 g_object_ref (*out_fd_list);
5971 case G_DBUS_MESSAGE_TYPE_ERROR:
5972 g_dbus_message_to_gerror (reply, error);
5976 g_assert_not_reached ();
5986 GSimpleAsyncResult *simple;
5987 GVariantType *reply_type;
5988 gchar *method_name; /* for error message */
5992 GUnixFDList *fd_list;
5996 call_state_free (CallState *state)
5998 g_variant_type_free (state->reply_type);
5999 g_free (state->method_name);
6001 if (state->value != NULL)
6002 g_variant_unref (state->value);
6003 if (state->fd_list != NULL)
6004 g_object_unref (state->fd_list);
6005 g_slice_free (CallState, state);
6008 /* called in any thread, with the connection's lock not held */
6010 g_dbus_connection_call_done (GObject *source,
6011 GAsyncResult *result,
6014 GSimpleAsyncResult *simple;
6015 GDBusConnection *connection = G_DBUS_CONNECTION (source);
6016 CallState *state = user_data;
6018 GDBusMessage *reply;
6021 reply = g_dbus_connection_send_message_with_reply_finish (connection,
6025 if (G_UNLIKELY (_g_dbus_debug_call ()))
6027 _g_dbus_debug_print_lock ();
6028 g_print ("========================================================================\n"
6029 "GDBus-debug:Call:\n"
6030 " <<<< ASYNC COMPLETE %s() (serial %d)\n"
6036 g_print ("SUCCESS\n");
6040 g_print ("FAILED: %s\n",
6043 _g_dbus_debug_print_unlock ();
6047 state->value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
6049 simple = state->simple; /* why? because state is freed before we unref simple.. */
6052 g_simple_async_result_take_error (state->simple, error);
6053 g_simple_async_result_complete (state->simple);
6054 call_state_free (state);
6058 g_simple_async_result_set_op_res_gpointer (state->simple, state, (GDestroyNotify) call_state_free);
6059 g_simple_async_result_complete (state->simple);
6061 g_clear_object (&reply);
6062 g_object_unref (simple);
6065 /* called in any thread, with the connection's lock not held */
6067 g_dbus_connection_call_internal (GDBusConnection *connection,
6068 const gchar *bus_name,
6069 const gchar *object_path,
6070 const gchar *interface_name,
6071 const gchar *method_name,
6072 GVariant *parameters,
6073 const GVariantType *reply_type,
6074 GDBusCallFlags flags,
6076 GUnixFDList *fd_list,
6077 GCancellable *cancellable,
6078 GAsyncReadyCallback callback,
6081 GDBusMessage *message;
6084 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
6085 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
6086 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
6087 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
6088 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
6089 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
6090 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
6091 g_return_if_fail (check_initialized (connection));
6093 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
6095 g_return_if_fail (fd_list == NULL);
6098 message = g_dbus_message_new_method_call (bus_name,
6102 add_call_flags (message, flags);
6103 if (parameters != NULL)
6104 g_dbus_message_set_body (message, parameters);
6107 if (fd_list != NULL)
6108 g_dbus_message_set_unix_fd_list (message, fd_list);
6111 /* If the user has no callback then we can just send the message with
6112 * the G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set and skip all
6113 * the logic for processing the reply. If the service sends the reply
6114 * anyway then it will just be ignored.
6116 if (callback != NULL)
6120 state = g_slice_new0 (CallState);
6121 state->simple = g_simple_async_result_new (G_OBJECT (connection),
6122 callback, user_data,
6123 g_dbus_connection_call_internal);
6124 g_simple_async_result_set_check_cancellable (state->simple, cancellable);
6125 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
6127 if (reply_type == NULL)
6128 reply_type = G_VARIANT_TYPE_ANY;
6130 state->reply_type = g_variant_type_copy (reply_type);
6132 g_dbus_connection_send_message_with_reply (connection,
6134 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
6138 g_dbus_connection_call_done,
6140 serial = state->serial;
6144 GDBusMessageFlags flags;
6146 flags = g_dbus_message_get_flags (message);
6147 flags |= G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
6148 g_dbus_message_set_flags (message, flags);
6150 g_dbus_connection_send_message (connection,
6152 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
6156 if (G_UNLIKELY (_g_dbus_debug_call ()))
6158 _g_dbus_debug_print_lock ();
6159 g_print ("========================================================================\n"
6160 "GDBus-debug:Call:\n"
6161 " >>>> ASYNC %s.%s()\n"
6163 " owned by name %s (serial %d)\n",
6167 bus_name != NULL ? bus_name : "(none)",
6169 _g_dbus_debug_print_unlock ();
6172 if (message != NULL)
6173 g_object_unref (message);
6176 /* called in any thread, with the connection's lock not held */
6178 g_dbus_connection_call_finish_internal (GDBusConnection *connection,
6179 GUnixFDList **out_fd_list,
6183 GSimpleAsyncResult *simple;
6186 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
6187 g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
6188 g_dbus_connection_call_internal), NULL);
6189 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6191 simple = G_SIMPLE_ASYNC_RESULT (res);
6193 if (g_simple_async_result_propagate_error (simple, error))
6196 state = g_simple_async_result_get_op_res_gpointer (simple);
6197 if (out_fd_list != NULL)
6198 *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
6199 return g_variant_ref (state->value);
6202 /* called in any user thread, with the connection's lock not held */
6204 g_dbus_connection_call_sync_internal (GDBusConnection *connection,
6205 const gchar *bus_name,
6206 const gchar *object_path,
6207 const gchar *interface_name,
6208 const gchar *method_name,
6209 GVariant *parameters,
6210 const GVariantType *reply_type,
6211 GDBusCallFlags flags,
6213 GUnixFDList *fd_list,
6214 GUnixFDList **out_fd_list,
6215 GCancellable *cancellable,
6218 GDBusMessage *message;
6219 GDBusMessage *reply;
6221 GError *local_error;
6222 GDBusSendMessageFlags send_flags;
6228 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
6229 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
6230 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
6231 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
6232 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
6233 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
6234 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
6236 g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
6238 g_return_val_if_fail (fd_list == NULL, NULL);
6240 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6242 if (!(flags & CALL_FLAGS_INITIALIZING))
6243 g_return_val_if_fail (check_initialized (connection), FALSE);
6245 if (reply_type == NULL)
6246 reply_type = G_VARIANT_TYPE_ANY;
6248 message = g_dbus_message_new_method_call (bus_name,
6252 add_call_flags (message, flags);
6253 if (parameters != NULL)
6254 g_dbus_message_set_body (message, parameters);
6257 if (fd_list != NULL)
6258 g_dbus_message_set_unix_fd_list (message, fd_list);
6261 if (G_UNLIKELY (_g_dbus_debug_call ()))
6263 _g_dbus_debug_print_lock ();
6264 g_print ("========================================================================\n"
6265 "GDBus-debug:Call:\n"
6266 " >>>> SYNC %s.%s()\n"
6268 " owned by name %s\n",
6272 bus_name != NULL ? bus_name : "(none)");
6273 _g_dbus_debug_print_unlock ();
6278 send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
6280 /* translate from one flavour of flags to another... */
6281 if (flags & CALL_FLAGS_INITIALIZING)
6282 send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
6284 reply = g_dbus_connection_send_message_with_reply_sync (connection,
6288 NULL, /* volatile guint32 *out_serial */
6292 if (G_UNLIKELY (_g_dbus_debug_call ()))
6294 _g_dbus_debug_print_lock ();
6295 g_print ("========================================================================\n"
6296 "GDBus-debug:Call:\n"
6297 " <<<< SYNC COMPLETE %s.%s()\n"
6303 g_print ("SUCCESS\n");
6307 g_print ("FAILED: %s\n",
6308 local_error->message);
6310 _g_dbus_debug_print_unlock ();
6316 *error = local_error;
6318 g_error_free (local_error);
6322 result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
6325 if (message != NULL)
6326 g_object_unref (message);
6328 g_object_unref (reply);
6333 /* ---------------------------------------------------------------------------------------------------- */
6336 * g_dbus_connection_call:
6337 * @connection: a #GDBusConnection
6338 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6339 * @connection is not a message bus connection
6340 * @object_path: path of remote object
6341 * @interface_name: D-Bus interface to invoke method on
6342 * @method_name: the name of the method to invoke
6343 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6344 * or %NULL if not passing parameters
6345 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6346 * @flags: flags from the #GDBusCallFlags enumeration
6347 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6348 * timeout or %G_MAXINT for no timeout
6349 * @cancellable: (allow-none): a #GCancellable or %NULL
6350 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
6351 * is satisfied or %NULL if you don't care about the result of the
6353 * @user_data: the data to pass to @callback
6355 * Asynchronously invokes the @method_name method on the
6356 * @interface_name D-Bus interface on the remote object at
6357 * @object_path owned by @bus_name.
6359 * If @connection is closed then the operation will fail with
6360 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
6361 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
6362 * not compatible with the D-Bus protocol, the operation fails with
6363 * %G_IO_ERROR_INVALID_ARGUMENT.
6365 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
6366 * error will be raised if it does not match. Said another way, if you give a @reply_type
6367 * then any non-%NULL return value will be of this type.
6369 * If the @parameters #GVariant is floating, it is consumed. This allows
6370 * convenient 'inline' use of g_variant_new(), e.g.:
6371 * |[<!-- language="C" -->
6372 * g_dbus_connection_call (connection,
6373 * "org.freedesktop.StringThings",
6374 * "/org/freedesktop/StringThings",
6375 * "org.freedesktop.StringThings",
6377 * g_variant_new ("(ss)",
6381 * G_DBUS_CALL_FLAGS_NONE,
6384 * (GAsyncReadyCallback) two_strings_done,
6388 * This is an asynchronous method. When the operation is finished,
6389 * @callback will be invoked in the
6390 * [thread-default main context][g-main-context-push-thread-default]
6391 * of the thread you are calling this method from. You can then call
6392 * g_dbus_connection_call_finish() to get the result of the operation.
6393 * See g_dbus_connection_call_sync() for the synchronous version of this
6396 * If @callback is %NULL then the D-Bus method call message will be sent with
6397 * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
6402 g_dbus_connection_call (GDBusConnection *connection,
6403 const gchar *bus_name,
6404 const gchar *object_path,
6405 const gchar *interface_name,
6406 const gchar *method_name,
6407 GVariant *parameters,
6408 const GVariantType *reply_type,
6409 GDBusCallFlags flags,
6411 GCancellable *cancellable,
6412 GAsyncReadyCallback callback,
6415 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);
6419 * g_dbus_connection_call_finish:
6420 * @connection: a #GDBusConnection
6421 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call()
6422 * @error: return location for error or %NULL
6424 * Finishes an operation started with g_dbus_connection_call().
6426 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6427 * return values. Free with g_variant_unref().
6432 g_dbus_connection_call_finish (GDBusConnection *connection,
6436 return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
6440 * g_dbus_connection_call_sync:
6441 * @connection: a #GDBusConnection
6442 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6443 * @connection is not a message bus connection
6444 * @object_path: path of remote object
6445 * @interface_name: D-Bus interface to invoke method on
6446 * @method_name: the name of the method to invoke
6447 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6448 * or %NULL if not passing parameters
6449 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6450 * @flags: flags from the #GDBusCallFlags enumeration
6451 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6452 * timeout or %G_MAXINT for no timeout
6453 * @cancellable: (allow-none): a #GCancellable or %NULL
6454 * @error: return location for error or %NULL
6456 * Synchronously invokes the @method_name method on the
6457 * @interface_name D-Bus interface on the remote object at
6458 * @object_path owned by @bus_name.
6460 * If @connection is closed then the operation will fail with
6461 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
6462 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
6463 * contains a value not compatible with the D-Bus protocol, the operation
6464 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
6466 * If @reply_type is non-%NULL then the reply will be checked for having
6467 * this type and an error will be raised if it does not match. Said
6468 * another way, if you give a @reply_type then any non-%NULL return
6469 * value will be of this type.
6471 * If the @parameters #GVariant is floating, it is consumed.
6472 * This allows convenient 'inline' use of g_variant_new(), e.g.:
6473 * |[<!-- language="C" -->
6474 * g_dbus_connection_call_sync (connection,
6475 * "org.freedesktop.StringThings",
6476 * "/org/freedesktop/StringThings",
6477 * "org.freedesktop.StringThings",
6479 * g_variant_new ("(ss)",
6483 * G_DBUS_CALL_FLAGS_NONE,
6489 * The calling thread is blocked until a reply is received. See
6490 * g_dbus_connection_call() for the asynchronous version of
6493 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6494 * return values. Free with g_variant_unref().
6499 g_dbus_connection_call_sync (GDBusConnection *connection,
6500 const gchar *bus_name,
6501 const gchar *object_path,
6502 const gchar *interface_name,
6503 const gchar *method_name,
6504 GVariant *parameters,
6505 const GVariantType *reply_type,
6506 GDBusCallFlags flags,
6508 GCancellable *cancellable,
6511 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);
6514 /* ---------------------------------------------------------------------------------------------------- */
6519 * g_dbus_connection_call_with_unix_fd_list:
6520 * @connection: a #GDBusConnection
6521 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6522 * @connection is not a message bus connection
6523 * @object_path: path of remote object
6524 * @interface_name: D-Bus interface to invoke method on
6525 * @method_name: the name of the method to invoke
6526 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6527 * or %NULL if not passing parameters
6528 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6529 * @flags: flags from the #GDBusCallFlags enumeration
6530 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6531 * timeout or %G_MAXINT for no timeout
6532 * @fd_list: (allow-none): a #GUnixFDList or %NULL
6533 * @cancellable: (allow-none): a #GCancellable or %NULL
6534 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
6535 * satisfied or %NULL if you don't * care about the result of the
6537 * @user_data: The data to pass to @callback.
6539 * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
6541 * This method is only available on UNIX.
6546 g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
6547 const gchar *bus_name,
6548 const gchar *object_path,
6549 const gchar *interface_name,
6550 const gchar *method_name,
6551 GVariant *parameters,
6552 const GVariantType *reply_type,
6553 GDBusCallFlags flags,
6555 GUnixFDList *fd_list,
6556 GCancellable *cancellable,
6557 GAsyncReadyCallback callback,
6560 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);
6564 * g_dbus_connection_call_with_unix_fd_list_finish:
6565 * @connection: a #GDBusConnection
6566 * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
6567 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
6568 * g_dbus_connection_call_with_unix_fd_list()
6569 * @error: return location for error or %NULL
6571 * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
6573 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6574 * return values. Free with g_variant_unref().
6579 g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
6580 GUnixFDList **out_fd_list,
6584 return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
6588 * g_dbus_connection_call_with_unix_fd_list_sync:
6589 * @connection: a #GDBusConnection
6590 * @bus_name: (allow-none): a unique or well-known bus name or %NULL
6591 * if @connection is not a message bus connection
6592 * @object_path: path of remote object
6593 * @interface_name: D-Bus interface to invoke method on
6594 * @method_name: the name of the method to invoke
6595 * @parameters: (allow-none): a #GVariant tuple with parameters for
6596 * the method or %NULL if not passing parameters
6597 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6598 * @flags: flags from the #GDBusCallFlags enumeration
6599 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6600 * timeout or %G_MAXINT for no timeout
6601 * @fd_list: (allow-none): a #GUnixFDList or %NULL
6602 * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
6603 * @cancellable: (allow-none): a #GCancellable or %NULL
6604 * @error: return location for error or %NULL
6606 * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
6608 * This method is only available on UNIX.
6610 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6611 * return values. Free with g_variant_unref().
6616 g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
6617 const gchar *bus_name,
6618 const gchar *object_path,
6619 const gchar *interface_name,
6620 const gchar *method_name,
6621 GVariant *parameters,
6622 const GVariantType *reply_type,
6623 GDBusCallFlags flags,
6625 GUnixFDList *fd_list,
6626 GUnixFDList **out_fd_list,
6627 GCancellable *cancellable,
6630 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);
6633 #endif /* G_OS_UNIX */
6635 /* ---------------------------------------------------------------------------------------------------- */
6637 struct ExportedSubtree
6641 GDBusConnection *connection;
6642 GDBusSubtreeVTable *vtable;
6643 GDBusSubtreeFlags flags;
6645 GMainContext *context;
6647 GDestroyNotify user_data_free_func;
6651 exported_subtree_free (ExportedSubtree *es)
6653 call_destroy_notify (es->context,
6654 es->user_data_free_func,
6657 g_main_context_unref (es->context);
6659 _g_dbus_subtree_vtable_free (es->vtable);
6660 g_free (es->object_path);
6664 /* called without lock held in the thread where the caller registered
6668 handle_subtree_introspect (GDBusConnection *connection,
6669 ExportedSubtree *es,
6670 GDBusMessage *message)
6674 GDBusMessage *reply;
6677 const gchar *sender;
6678 const gchar *requested_object_path;
6679 const gchar *requested_node;
6680 GDBusInterfaceInfo **interfaces;
6682 gchar **subnode_paths;
6683 gboolean has_properties_interface;
6684 gboolean has_introspectable_interface;
6688 requested_object_path = g_dbus_message_get_path (message);
6689 sender = g_dbus_message_get_sender (message);
6690 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6692 s = g_string_new (NULL);
6693 introspect_append_header (s);
6695 /* Strictly we don't need the children in dynamic mode, but we avoid the
6696 * conditionals to preserve code clarity
6698 children = es->vtable->enumerate (es->connection,
6705 requested_node = strrchr (requested_object_path, '/') + 1;
6707 /* Assert existence of object if we are not dynamic */
6708 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
6709 !_g_strv_has_string ((const gchar * const *) children, requested_node))
6714 requested_node = NULL;
6717 interfaces = es->vtable->introspect (es->connection,
6722 if (interfaces != NULL)
6724 has_properties_interface = FALSE;
6725 has_introspectable_interface = FALSE;
6727 for (n = 0; interfaces[n] != NULL; n++)
6729 if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
6730 has_properties_interface = TRUE;
6731 else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
6732 has_introspectable_interface = TRUE;
6734 if (!has_properties_interface)
6735 g_string_append (s, introspect_properties_interface);
6736 if (!has_introspectable_interface)
6737 g_string_append (s, introspect_introspectable_interface);
6739 for (n = 0; interfaces[n] != NULL; n++)
6741 g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
6742 g_dbus_interface_info_unref (interfaces[n]);
6744 g_free (interfaces);
6747 /* then include <node> entries from the Subtree for the root */
6750 for (n = 0; children != NULL && children[n] != NULL; n++)
6751 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
6754 /* finally include nodes registered below us */
6755 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
6756 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
6757 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
6758 g_strfreev (subnode_paths);
6760 g_string_append (s, "</node>\n");
6762 reply = g_dbus_message_new_method_reply (message);
6763 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6764 g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6765 g_object_unref (reply);
6770 g_string_free (s, TRUE);
6771 g_strfreev (children);
6775 /* called without lock held in the thread where the caller registered
6779 handle_subtree_method_invocation (GDBusConnection *connection,
6780 ExportedSubtree *es,
6781 GDBusMessage *message)
6784 const gchar *sender;
6785 const gchar *interface_name;
6786 const gchar *member;
6787 const gchar *signature;
6788 const gchar *requested_object_path;
6789 const gchar *requested_node;
6791 GDBusInterfaceInfo *interface_info;
6792 const GDBusInterfaceVTable *interface_vtable;
6793 gpointer interface_user_data;
6795 GDBusInterfaceInfo **interfaces;
6796 gboolean is_property_get;
6797 gboolean is_property_set;
6798 gboolean is_property_get_all;
6803 requested_object_path = g_dbus_message_get_path (message);
6804 sender = g_dbus_message_get_sender (message);
6805 interface_name = g_dbus_message_get_interface (message);
6806 member = g_dbus_message_get_member (message);
6807 signature = g_dbus_message_get_signature (message);
6808 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6810 is_property_get = FALSE;
6811 is_property_set = FALSE;
6812 is_property_get_all = FALSE;
6813 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
6815 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
6816 is_property_get = TRUE;
6817 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
6818 is_property_set = TRUE;
6819 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
6820 is_property_get_all = TRUE;
6825 requested_node = strrchr (requested_object_path, '/') + 1;
6827 if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
6829 /* We don't want to dispatch to unenumerated
6830 * nodes, so ensure that the child exists.
6835 children = es->vtable->enumerate (es->connection,
6840 exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
6841 g_strfreev (children);
6849 requested_node = NULL;
6852 /* get introspection data for the node */
6853 interfaces = es->vtable->introspect (es->connection,
6855 requested_object_path,
6859 if (interfaces == NULL)
6862 interface_info = NULL;
6863 for (n = 0; interfaces[n] != NULL; n++)
6865 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6866 interface_info = interfaces[n];
6869 /* dispatch the call if the user wants to handle it */
6870 if (interface_info != NULL)
6872 /* figure out where to dispatch the method call */
6873 interface_user_data = NULL;
6874 interface_vtable = es->vtable->dispatch (es->connection,
6879 &interface_user_data,
6881 if (interface_vtable == NULL)
6884 CONNECTION_LOCK (connection);
6885 handled = validate_and_maybe_schedule_method_call (es->connection,
6892 interface_user_data);
6893 CONNECTION_UNLOCK (connection);
6895 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
6896 else if (is_property_get || is_property_set || is_property_get_all)
6898 if (is_property_get)
6899 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
6900 else if (is_property_set)
6901 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
6902 else if (is_property_get_all)
6903 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
6905 g_assert_not_reached ();
6907 /* see if the object supports this interface at all */
6908 for (n = 0; interfaces[n] != NULL; n++)
6910 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6911 interface_info = interfaces[n];
6914 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
6915 * claims it won't support the interface
6917 if (interface_info == NULL)
6919 GDBusMessage *reply;
6920 reply = g_dbus_message_new_method_error (message,
6921 "org.freedesktop.DBus.Error.InvalidArgs",
6922 _("No such interface '%s'"),
6924 g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6925 g_object_unref (reply);
6930 /* figure out where to dispatch the property get/set/getall calls */
6931 interface_user_data = NULL;
6932 interface_vtable = es->vtable->dispatch (es->connection,
6937 &interface_user_data,
6939 if (interface_vtable == NULL)
6941 g_warning ("The subtree introspection function indicates that '%s' "
6942 "is a valid interface name, but calling the dispatch "
6943 "function on that interface gave us NULL", interface_name);
6947 if (is_property_get || is_property_set)
6949 CONNECTION_LOCK (connection);
6950 handled = validate_and_maybe_schedule_property_getset (es->connection,
6958 interface_user_data);
6959 CONNECTION_UNLOCK (connection);
6961 else if (is_property_get_all)
6963 CONNECTION_LOCK (connection);
6964 handled = validate_and_maybe_schedule_property_get_all (es->connection,
6971 interface_user_data);
6972 CONNECTION_UNLOCK (connection);
6977 if (interfaces != NULL)
6979 for (n = 0; interfaces[n] != NULL; n++)
6980 g_dbus_interface_info_unref (interfaces[n]);
6981 g_free (interfaces);
6989 GDBusMessage *message;
6990 ExportedSubtree *es;
6991 } SubtreeDeferredData;
6994 subtree_deferred_data_free (SubtreeDeferredData *data)
6996 g_object_unref (data->message);
7000 /* called without lock held in the thread where the caller registered the subtree */
7002 process_subtree_vtable_message_in_idle_cb (gpointer _data)
7004 SubtreeDeferredData *data = _data;
7009 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
7010 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
7011 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
7012 handled = handle_subtree_introspect (data->es->connection,
7016 handled = handle_subtree_method_invocation (data->es->connection,
7022 CONNECTION_LOCK (data->es->connection);
7023 handled = handle_generic_unlocked (data->es->connection, data->message);
7024 CONNECTION_UNLOCK (data->es->connection);
7027 /* if we couldn't handle the request, just bail with the UnknownMethod error */
7030 GDBusMessage *reply;
7031 reply = g_dbus_message_new_method_error (data->message,
7032 "org.freedesktop.DBus.Error.UnknownMethod",
7033 _("Method '%s' on interface '%s' with signature '%s' does not exist"),
7034 g_dbus_message_get_member (data->message),
7035 g_dbus_message_get_interface (data->message),
7036 g_dbus_message_get_signature (data->message));
7037 g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7038 g_object_unref (reply);
7044 /* called in GDBusWorker thread with connection's lock held */
7046 subtree_message_func (GDBusConnection *connection,
7047 ExportedSubtree *es,
7048 GDBusMessage *message)
7050 GSource *idle_source;
7051 SubtreeDeferredData *data;
7053 data = g_new0 (SubtreeDeferredData, 1);
7054 data->message = g_object_ref (message);
7057 /* defer this call to an idle handler in the right thread */
7058 idle_source = g_idle_source_new ();
7059 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
7060 g_source_set_callback (idle_source,
7061 process_subtree_vtable_message_in_idle_cb,
7063 (GDestroyNotify) subtree_deferred_data_free);
7064 g_source_set_name (idle_source, "[gio] process_subtree_vtable_message_in_idle_cb");
7065 g_source_attach (idle_source, es->context);
7066 g_source_unref (idle_source);
7068 /* since we own the entire subtree, handlers for objects not in the subtree have been
7069 * tried already by libdbus-1 - so we just need to ensure that we're always going
7070 * to reply to the message
7076 * g_dbus_connection_register_subtree:
7077 * @connection: a #GDBusConnection
7078 * @object_path: the object path to register the subtree at
7079 * @vtable: a #GDBusSubtreeVTable to enumerate, introspect and
7080 * dispatch nodes in the subtree
7081 * @flags: flags used to fine tune the behavior of the subtree
7082 * @user_data: data to pass to functions in @vtable
7083 * @user_data_free_func: function to call when the subtree is unregistered
7084 * @error: return location for error or %NULL
7086 * Registers a whole subtree of dynamic objects.
7088 * The @enumerate and @introspection functions in @vtable are used to
7089 * convey, to remote callers, what nodes exist in the subtree rooted
7092 * When handling remote calls into any node in the subtree, first the
7093 * @enumerate function is used to check if the node exists. If the node exists
7094 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
7095 * the @introspection function is used to check if the node supports the
7096 * requested method. If so, the @dispatch function is used to determine
7097 * where to dispatch the call. The collected #GDBusInterfaceVTable and
7098 * #gpointer will be used to call into the interface vtable for processing
7101 * All calls into user-provided code will be invoked in the
7102 * [thread-default main context][g-main-context-push-thread-default]
7103 * of the thread you are calling this method from.
7105 * If an existing subtree is already registered at @object_path or
7106 * then @error is set to #G_IO_ERROR_EXISTS.
7108 * Note that it is valid to register regular objects (using
7109 * g_dbus_connection_register_object()) in a subtree registered with
7110 * g_dbus_connection_register_subtree() - if so, the subtree handler
7111 * is tried as the last resort. One way to think about a subtree
7112 * handler is to consider it a fallback handler for object paths not
7113 * registered via g_dbus_connection_register_object() or other bindings.
7115 * Note that @vtable will be copied so you cannot change it after
7118 * See this [server][gdbus-subtree-server] for an example of how to use
7121 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
7122 * that can be used with g_dbus_connection_unregister_subtree() .
7127 g_dbus_connection_register_subtree (GDBusConnection *connection,
7128 const gchar *object_path,
7129 const GDBusSubtreeVTable *vtable,
7130 GDBusSubtreeFlags flags,
7132 GDestroyNotify user_data_free_func,
7136 ExportedSubtree *es;
7138 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
7139 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
7140 g_return_val_if_fail (vtable != NULL, 0);
7141 g_return_val_if_fail (error == NULL || *error == NULL, 0);
7142 g_return_val_if_fail (check_initialized (connection), 0);
7146 CONNECTION_LOCK (connection);
7148 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
7154 _("A subtree is already exported for %s"),
7159 es = g_new0 (ExportedSubtree, 1);
7160 es->object_path = g_strdup (object_path);
7161 es->connection = connection;
7163 es->vtable = _g_dbus_subtree_vtable_copy (vtable);
7165 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
7166 es->user_data = user_data;
7167 es->user_data_free_func = user_data_free_func;
7168 es->context = g_main_context_ref_thread_default ();
7170 g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
7171 g_hash_table_insert (connection->map_id_to_es,
7172 GUINT_TO_POINTER (es->id),
7178 CONNECTION_UNLOCK (connection);
7183 /* ---------------------------------------------------------------------------------------------------- */
7186 * g_dbus_connection_unregister_subtree:
7187 * @connection: a #GDBusConnection
7188 * @registration_id: a subtree registration id obtained from
7189 * g_dbus_connection_register_subtree()
7191 * Unregisters a subtree.
7193 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise
7198 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
7199 guint registration_id)
7201 ExportedSubtree *es;
7204 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
7205 g_return_val_if_fail (check_initialized (connection), FALSE);
7209 CONNECTION_LOCK (connection);
7211 es = g_hash_table_lookup (connection->map_id_to_es,
7212 GUINT_TO_POINTER (registration_id));
7216 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
7217 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
7222 CONNECTION_UNLOCK (connection);
7227 /* ---------------------------------------------------------------------------------------------------- */
7229 /* may be called in any thread, with connection's lock held */
7231 handle_generic_ping_unlocked (GDBusConnection *connection,
7232 const gchar *object_path,
7233 GDBusMessage *message)
7235 GDBusMessage *reply;
7236 reply = g_dbus_message_new_method_reply (message);
7237 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7238 g_object_unref (reply);
7241 /* may be called in any thread, with connection's lock held */
7243 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
7244 const gchar *object_path,
7245 GDBusMessage *message)
7247 GDBusMessage *reply;
7250 if (connection->machine_id == NULL)
7255 connection->machine_id = _g_dbus_get_machine_id (&error);
7256 if (connection->machine_id == NULL)
7258 reply = g_dbus_message_new_method_error_literal (message,
7259 "org.freedesktop.DBus.Error.Failed",
7261 g_error_free (error);
7267 reply = g_dbus_message_new_method_reply (message);
7268 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
7270 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7271 g_object_unref (reply);
7274 /* may be called in any thread, with connection's lock held */
7276 handle_generic_introspect_unlocked (GDBusConnection *connection,
7277 const gchar *object_path,
7278 GDBusMessage *message)
7283 GDBusMessage *reply;
7285 /* first the header */
7286 s = g_string_new (NULL);
7287 introspect_append_header (s);
7289 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
7290 for (n = 0; registered != NULL && registered[n] != NULL; n++)
7291 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
7292 g_strfreev (registered);
7293 g_string_append (s, "</node>\n");
7295 reply = g_dbus_message_new_method_reply (message);
7296 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
7297 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7298 g_object_unref (reply);
7299 g_string_free (s, TRUE);
7302 /* may be called in any thread, with connection's lock held */
7304 handle_generic_unlocked (GDBusConnection *connection,
7305 GDBusMessage *message)
7308 const gchar *interface_name;
7309 const gchar *member;
7310 const gchar *signature;
7313 CONNECTION_ENSURE_LOCK (connection);
7317 interface_name = g_dbus_message_get_interface (message);
7318 member = g_dbus_message_get_member (message);
7319 signature = g_dbus_message_get_signature (message);
7320 path = g_dbus_message_get_path (message);
7322 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
7323 g_strcmp0 (member, "Introspect") == 0 &&
7324 g_strcmp0 (signature, "") == 0)
7326 handle_generic_introspect_unlocked (connection, path, message);
7329 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
7330 g_strcmp0 (member, "Ping") == 0 &&
7331 g_strcmp0 (signature, "") == 0)
7333 handle_generic_ping_unlocked (connection, path, message);
7336 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
7337 g_strcmp0 (member, "GetMachineId") == 0 &&
7338 g_strcmp0 (signature, "") == 0)
7340 handle_generic_get_machine_id_unlocked (connection, path, message);
7347 /* ---------------------------------------------------------------------------------------------------- */
7349 /* called in GDBusWorker thread with connection's lock held */
7351 distribute_method_call (GDBusConnection *connection,
7352 GDBusMessage *message)
7354 GDBusMessage *reply;
7356 ExportedSubtree *es;
7357 const gchar *object_path;
7358 const gchar *interface_name;
7359 const gchar *member;
7361 gchar *subtree_path;
7364 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
7366 interface_name = g_dbus_message_get_interface (message);
7367 member = g_dbus_message_get_member (message);
7368 path = g_dbus_message_get_path (message);
7369 subtree_path = g_strdup (path);
7370 needle = strrchr (subtree_path, '/');
7371 if (needle != NULL && needle != subtree_path)
7377 g_free (subtree_path);
7378 subtree_path = NULL;
7382 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
7384 _g_dbus_debug_print_lock ();
7385 g_print ("========================================================================\n"
7386 "GDBus-debug:Incoming:\n"
7387 " <<<< METHOD INVOCATION %s.%s()\n"
7389 " invoked by name %s\n"
7391 interface_name, member,
7393 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
7394 g_dbus_message_get_serial (message));
7395 _g_dbus_debug_print_unlock ();
7398 object_path = g_dbus_message_get_path (message);
7399 g_assert (object_path != NULL);
7401 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
7404 if (obj_message_func (connection, eo, message))
7408 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
7411 if (subtree_message_func (connection, es, message))
7415 if (subtree_path != NULL)
7417 es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
7420 if (subtree_message_func (connection, es, message))
7425 if (handle_generic_unlocked (connection, message))
7428 /* if we end up here, the message has not been not handled - so return an error saying this */
7429 reply = g_dbus_message_new_method_error (message,
7430 "org.freedesktop.DBus.Error.UnknownMethod",
7431 _("No such interface '%s' on object at path %s"),
7434 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7435 g_object_unref (reply);
7438 g_free (subtree_path);
7441 /* ---------------------------------------------------------------------------------------------------- */
7443 /* Called in any user thread, with the message_bus_lock held. */
7445 message_bus_get_singleton (GBusType bus_type,
7449 const gchar *starter_bus;
7455 case G_BUS_TYPE_SESSION:
7456 ret = &the_session_bus;
7459 case G_BUS_TYPE_SYSTEM:
7460 ret = &the_system_bus;
7463 case G_BUS_TYPE_USER:
7464 ret = &the_user_bus;
7467 case G_BUS_TYPE_MACHINE:
7468 ret = &the_machine_bus;
7471 case G_BUS_TYPE_STARTER:
7472 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
7473 if (g_strcmp0 (starter_bus, "session") == 0)
7475 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
7478 else if (g_strcmp0 (starter_bus, "system") == 0)
7480 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
7485 if (starter_bus != NULL)
7489 G_IO_ERROR_INVALID_ARGUMENT,
7490 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
7491 " - unknown value '%s'"),
7496 g_set_error_literal (error,
7498 G_IO_ERROR_INVALID_ARGUMENT,
7499 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
7500 "variable is not set"));
7506 g_assert_not_reached ();
7514 /* Called in any user thread, without holding locks. */
7515 static GDBusConnection *
7516 get_uninitialized_connection (GBusType bus_type,
7517 GCancellable *cancellable,
7520 GWeakRef *singleton;
7521 GDBusConnection *ret;
7525 G_LOCK (message_bus_lock);
7526 singleton = message_bus_get_singleton (bus_type, error);
7527 if (singleton == NULL)
7530 ret = g_weak_ref_get (singleton);
7535 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
7536 if (address == NULL)
7538 ret = g_object_new (G_TYPE_DBUS_CONNECTION,
7540 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
7541 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
7542 "exit-on-close", TRUE,
7545 g_weak_ref_set (singleton, ret);
7549 g_assert (ret != NULL);
7552 G_UNLOCK (message_bus_lock);
7556 /* May be called from any thread. Must not hold message_bus_lock. */
7558 _g_bus_get_singleton_if_exists (GBusType bus_type)
7560 GWeakRef *singleton;
7561 GDBusConnection *ret = NULL;
7563 G_LOCK (message_bus_lock);
7564 singleton = message_bus_get_singleton (bus_type, NULL);
7565 if (singleton == NULL)
7568 ret = g_weak_ref_get (singleton);
7571 G_UNLOCK (message_bus_lock);
7577 * @bus_type: a #GBusType
7578 * @cancellable: (allow-none): a #GCancellable or %NULL
7579 * @error: return location for error or %NULL
7581 * Synchronously connects to the message bus specified by @bus_type.
7582 * Note that the returned object may shared with other callers,
7583 * e.g. if two separate parts of a process calls this function with
7584 * the same @bus_type, they will share the same object.
7586 * This is a synchronous failable function. See g_bus_get() and
7587 * g_bus_get_finish() for the asynchronous version.
7589 * The returned object is a singleton, that is, shared with other
7590 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7591 * event that you need a private message bus connection, use
7592 * g_dbus_address_get_for_bus_sync() and
7593 * g_dbus_connection_new_for_address().
7595 * Note that the returned #GDBusConnection object will (usually) have
7596 * the #GDBusConnection:exit-on-close property set to %TRUE.
7598 * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
7599 * Free with g_object_unref().
7604 g_bus_get_sync (GBusType bus_type,
7605 GCancellable *cancellable,
7608 GDBusConnection *connection;
7610 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7612 connection = get_uninitialized_connection (bus_type, cancellable, error);
7613 if (connection == NULL)
7616 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
7618 g_object_unref (connection);
7627 bus_get_async_initable_cb (GObject *source_object,
7631 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
7635 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
7639 g_assert (error != NULL);
7640 g_simple_async_result_take_error (simple, error);
7641 g_object_unref (source_object);
7645 g_simple_async_result_set_op_res_gpointer (simple,
7649 g_simple_async_result_complete_in_idle (simple);
7650 g_object_unref (simple);
7655 * @bus_type: a #GBusType
7656 * @cancellable: (allow-none): a #GCancellable or %NULL
7657 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7658 * @user_data: the data to pass to @callback
7660 * Asynchronously connects to the message bus specified by @bus_type.
7662 * When the operation is finished, @callback will be invoked. You can
7663 * then call g_bus_get_finish() to get the result of the operation.
7665 * This is a asynchronous failable function. See g_bus_get_sync() for
7666 * the synchronous version.
7671 g_bus_get (GBusType bus_type,
7672 GCancellable *cancellable,
7673 GAsyncReadyCallback callback,
7676 GDBusConnection *connection;
7677 GSimpleAsyncResult *simple;
7680 simple = g_simple_async_result_new (NULL,
7684 g_simple_async_result_set_check_cancellable (simple, cancellable);
7687 connection = get_uninitialized_connection (bus_type, cancellable, &error);
7688 if (connection == NULL)
7690 g_assert (error != NULL);
7691 g_simple_async_result_take_error (simple, error);
7692 g_simple_async_result_complete_in_idle (simple);
7693 g_object_unref (simple);
7697 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
7700 bus_get_async_initable_cb,
7707 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
7709 * @error: return location for error or %NULL
7711 * Finishes an operation started with g_bus_get().
7713 * The returned object is a singleton, that is, shared with other
7714 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7715 * event that you need a private message bus connection, use
7716 * g_dbus_address_get_for_bus_sync() and
7717 * g_dbus_connection_new_for_address().
7719 * Note that the returned #GDBusConnection object will (usually) have
7720 * the #GDBusConnection:exit-on-close property set to %TRUE.
7722 * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
7723 * Free with g_object_unref().
7728 g_bus_get_finish (GAsyncResult *res,
7731 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
7733 GDBusConnection *ret;
7735 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7737 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
7741 if (g_simple_async_result_propagate_error (simple, error))
7744 object = g_simple_async_result_get_op_res_gpointer (simple);
7745 g_assert (object != NULL);
7746 ret = g_object_ref (G_DBUS_CONNECTION (object));
7752 /* ---------------------------------------------------------------------------------------------------- */