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 "gkdbusconnection.h"
127 #include "gunixconnection.h"
128 #include "gunixfdmessage.h"
131 #include "glibintl.h"
134 * SECTION:gdbusconnection
135 * @short_description: D-Bus Connections
136 * @include: gio/gio.h
138 * The #GDBusConnection type is used for D-Bus connections to remote
139 * peers such as a message buses. It is a low-level API that offers a
140 * lot of flexibility. For instance, it lets you establish a connection
141 * over any transport that can by represented as an #GIOStream.
143 * This class is rarely used directly in D-Bus clients. If you are writing
144 * a D-Bus client, it is often easier to use the g_bus_own_name(),
145 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
147 * As an exception to the usual GLib rule that a particular object must not
148 * be used by two threads at the same time, #GDBusConnection's methods may be
149 * called from any thread. This is so that g_bus_get() and g_bus_get_sync()
150 * can safely return the same #GDBusConnection when called from any thread.
152 * Most of the ways to obtain a #GDBusConnection automatically initialize it
153 * (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
154 * g_bus_get(), and the synchronous versions of those methods, give you an
155 * initialized connection. Language bindings for GIO should use
156 * g_initable_new() or g_async_initable_new_async(), which also initialize the
159 * If you construct an uninitialized #GDBusConnection, such as via
160 * g_object_new(), you must initialize it via g_initable_init() or
161 * g_async_initable_init_async() before using its methods or properties.
162 * Calling methods or accessing properties on a #GDBusConnection that has not
163 * completed initialization successfully is considered to be invalid, and leads
164 * to undefined behaviour. In particular, if initialization fails with a
165 * #GError, the only valid thing you can do with that #GDBusConnection is to
166 * free it with g_object_unref().
168 * ## An example D-Bus server # {#gdbus-server}
170 * Here is an example for a D-Bus server:
171 * [gdbus-example-server.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-server.c)
173 * ## An example for exporting a subtree # {#gdbus-subtree-server}
175 * Here is an example for exporting a subtree:
176 * [gdbus-example-subtree.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-subtree.c)
178 * ## An example for file descriptor passing # {#gdbus-unix-fd-client}
180 * Here is an example for passing UNIX file descriptors:
181 * [gdbus-unix-fd-client.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-unix-fd-client.c)
183 * ## An example for exporting a GObject # {#gdbus-export}
185 * Here is an example for exporting a #GObject:
186 * [gdbus-example-export.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-export.c)
189 /* ---------------------------------------------------------------------------------------------------- */
191 typedef struct _GDBusConnectionClass GDBusConnectionClass;
194 * GDBusConnectionClass:
195 * @closed: Signal class handler for the #GDBusConnection::closed signal.
197 * Class structure for #GDBusConnection.
201 struct _GDBusConnectionClass
204 GObjectClass parent_class;
208 void (*closed) (GDBusConnection *connection,
209 gboolean remote_peer_vanished,
213 G_LOCK_DEFINE_STATIC (message_bus_lock);
215 static GWeakRef the_session_bus;
216 static GWeakRef the_system_bus;
217 static GWeakRef the_user_bus;
218 static GWeakRef the_machine_bus;
220 /* Extra pseudo-member of GDBusSendMessageFlags.
221 * Set by initable_init() to indicate that despite not being initialized yet,
222 * enough of the only-valid-after-init members are set that we can send a
223 * message, and we're being called from its thread, so no memory barrier is
224 * required before accessing them.
226 #define SEND_MESSAGE_FLAGS_INITIALIZING (1<<31)
228 /* Same as SEND_MESSAGE_FLAGS_INITIALIZING, but in GDBusCallFlags */
229 #define CALL_FLAGS_INITIALIZING (1<<31)
231 /* ---------------------------------------------------------------------------------------------------- */
235 GDestroyNotify callback;
237 GMainContext *context;
238 } CallDestroyNotifyData;
241 call_destroy_notify_data_in_idle (gpointer user_data)
243 CallDestroyNotifyData *data = user_data;
244 data->callback (data->user_data);
249 call_destroy_notify_data_free (CallDestroyNotifyData *data)
251 if (data->context != NULL)
252 g_main_context_unref (data->context);
257 * call_destroy_notify: <internal>
258 * @context: (allow-none): A #GMainContext or %NULL.
259 * @callback: (allow-none): A #GDestroyNotify or %NULL.
260 * @user_data: Data to pass to @callback.
262 * Schedules @callback to run in @context.
265 call_destroy_notify (GMainContext *context,
266 GDestroyNotify callback,
269 GSource *idle_source;
270 CallDestroyNotifyData *data;
272 if (callback == NULL)
275 data = g_new0 (CallDestroyNotifyData, 1);
276 data->callback = callback;
277 data->user_data = user_data;
278 data->context = context;
279 if (data->context != NULL)
280 g_main_context_ref (data->context);
282 idle_source = g_idle_source_new ();
283 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
284 g_source_set_callback (idle_source,
285 call_destroy_notify_data_in_idle,
287 (GDestroyNotify) call_destroy_notify_data_free);
288 g_source_set_name (idle_source, "[gio] call_destroy_notify_data_in_idle");
289 g_source_attach (idle_source, data->context);
290 g_source_unref (idle_source);
296 /* ---------------------------------------------------------------------------------------------------- */
299 _g_strv_has_string (const gchar* const *haystack,
304 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
306 if (g_strcmp0 (haystack[n], needle) == 0)
312 /* ---------------------------------------------------------------------------------------------------- */
315 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
317 // TODO: for some reason this doesn't work on Windows
318 #define CONNECTION_ENSURE_LOCK(obj) do { \
319 if (G_UNLIKELY (g_mutex_trylock(&(obj)->lock))) \
321 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
322 "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
327 #define CONNECTION_LOCK(obj) do { \
328 g_mutex_lock (&(obj)->lock); \
331 #define CONNECTION_UNLOCK(obj) do { \
332 g_mutex_unlock (&(obj)->lock); \
335 /* Flags in connection->atomic_flags */
337 FLAG_INITIALIZED = 1 << 0,
338 FLAG_EXIT_ON_CLOSE = 1 << 1,
345 * The #GDBusConnection structure contains only private data and
346 * should only be accessed using the provided API.
350 struct _GDBusConnection
353 GObject parent_instance;
355 /* ------------------------------------------------------------------------ */
356 /* -- General object state ------------------------------------------------ */
357 /* ------------------------------------------------------------------------ */
359 /* General-purpose lock for most fields */
362 /* A lock used in the init() method of the GInitable interface - see comments
363 * in initable_init() for why a separate lock is needed.
365 * If you need both @lock and @init_lock, you must take @init_lock first.
369 /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
370 * someone calls org.freedesktop.DBus.Peer.GetMachineId(). Protected by @lock.
374 /* The underlying stream used for communication
375 * Read-only after initable_init(), so it may be read if you either
376 * hold @init_lock or check for initialization first.
380 /* The object used for authentication (if any).
381 * Read-only after initable_init(), so it may be read if you either
382 * hold @init_lock or check for initialization first.
386 /* Last serial used. Protected by @lock. */
389 /* The object used to send/receive messages.
390 * Read-only after initable_init(), so it may be read if you either
391 * hold @init_lock or check for initialization first.
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 != NULL);
1166 _g_dbus_worker_unfreeze (connection->worker);
1170 * g_dbus_connection_is_closed:
1171 * @connection: a #GDBusConnection
1173 * Gets whether @connection is closed.
1175 * Returns: %TRUE if the connection is closed, %FALSE otherwise
1180 g_dbus_connection_is_closed (GDBusConnection *connection)
1184 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1186 flags = g_atomic_int_get (&connection->atomic_flags);
1188 return (flags & FLAG_CLOSED) ? TRUE : FALSE;
1192 * g_dbus_connection_get_capabilities:
1193 * @connection: a #GDBusConnection
1195 * Gets the capabilities negotiated with the remote peer
1197 * Returns: zero or more flags from the #GDBusCapabilityFlags enumeration
1201 GDBusCapabilityFlags
1202 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1204 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1206 /* do not use g_return_val_if_fail(), we want the memory barrier */
1207 if (!check_initialized (connection))
1208 return G_DBUS_CAPABILITY_FLAGS_NONE;
1210 return connection->capabilities;
1213 /* ---------------------------------------------------------------------------------------------------- */
1215 /* Called in a temporary thread without holding locks. */
1217 flush_in_thread_func (GSimpleAsyncResult *res,
1219 GCancellable *cancellable)
1224 if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
1227 g_simple_async_result_take_error (res, error);
1231 * g_dbus_connection_flush:
1232 * @connection: a #GDBusConnection
1233 * @cancellable: (allow-none): a #GCancellable or %NULL
1234 * @callback: (allow-none): a #GAsyncReadyCallback to call when the
1235 * request is satisfied or %NULL if you don't care about the result
1236 * @user_data: The data to pass to @callback
1238 * Asynchronously flushes @connection, that is, writes all queued
1239 * outgoing message to the transport and then flushes the transport
1240 * (using g_output_stream_flush_async()). This is useful in programs
1241 * that wants to emit a D-Bus signal and then exit immediately. Without
1242 * flushing the connection, there is no guaranteed that the message has
1243 * been sent to the networking buffers in the OS kernel.
1245 * This is an asynchronous method. When the operation is finished,
1246 * @callback will be invoked in the
1247 * [thread-default main context][g-main-context-push-thread-default]
1248 * of the thread you are calling this method from. You can
1249 * then call g_dbus_connection_flush_finish() to get the result of the
1250 * operation. See g_dbus_connection_flush_sync() for the synchronous
1256 g_dbus_connection_flush (GDBusConnection *connection,
1257 GCancellable *cancellable,
1258 GAsyncReadyCallback callback,
1261 GSimpleAsyncResult *simple;
1263 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1265 simple = g_simple_async_result_new (G_OBJECT (connection),
1268 g_dbus_connection_flush);
1269 g_simple_async_result_set_check_cancellable (simple, cancellable);
1270 g_simple_async_result_run_in_thread (simple,
1271 flush_in_thread_func,
1274 g_object_unref (simple);
1278 * g_dbus_connection_flush_finish:
1279 * @connection: a #GDBusConnection
1280 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1281 * to g_dbus_connection_flush()
1282 * @error: return location for error or %NULL
1284 * Finishes an operation started with g_dbus_connection_flush().
1286 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1291 g_dbus_connection_flush_finish (GDBusConnection *connection,
1295 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1300 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1301 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1302 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1304 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
1306 if (g_simple_async_result_propagate_error (simple, error))
1316 * g_dbus_connection_flush_sync:
1317 * @connection: a #GDBusConnection
1318 * @cancellable: (allow-none): a #GCancellable or %NULL
1319 * @error: return location for error or %NULL
1321 * Synchronously flushes @connection. The calling thread is blocked
1322 * until this is done. See g_dbus_connection_flush() for the
1323 * asynchronous version of this method and more details about what it
1326 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1331 g_dbus_connection_flush_sync (GDBusConnection *connection,
1332 GCancellable *cancellable,
1337 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1338 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1342 /* This is only a best-effort attempt to see whether the connection is
1343 * closed, so it doesn't need the lock. If the connection closes just
1344 * after this check, but before scheduling the flush operation, the
1345 * result will be more or less the same as if the connection closed while
1346 * the flush operation was pending - it'll fail with either CLOSED or
1349 if (!check_unclosed (connection, 0, error))
1352 g_assert (connection->worker != NULL);
1354 ret = _g_dbus_worker_flush_sync (connection->worker,
1362 /* ---------------------------------------------------------------------------------------------------- */
1366 GDBusConnection *connection;
1368 gboolean remote_peer_vanished;
1372 emit_closed_data_free (EmitClosedData *data)
1374 g_object_unref (data->connection);
1375 if (data->error != NULL)
1376 g_error_free (data->error);
1380 /* Called in a user thread that has acquired the main context that was
1381 * thread-default when the object was constructed
1384 emit_closed_in_idle (gpointer user_data)
1386 EmitClosedData *data = user_data;
1389 g_object_notify (G_OBJECT (data->connection), "closed");
1390 g_signal_emit (data->connection,
1391 signals[CLOSED_SIGNAL],
1393 data->remote_peer_vanished,
1399 /* Can be called from any thread, must hold lock.
1400 * FLAG_CLOSED must already have been set.
1403 schedule_closed_unlocked (GDBusConnection *connection,
1404 gboolean remote_peer_vanished,
1407 GSource *idle_source;
1408 EmitClosedData *data;
1410 CONNECTION_ENSURE_LOCK (connection);
1412 data = g_new0 (EmitClosedData, 1);
1413 data->connection = g_object_ref (connection);
1414 data->remote_peer_vanished = remote_peer_vanished;
1415 data->error = error != NULL ? g_error_copy (error) : NULL;
1417 idle_source = g_idle_source_new ();
1418 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1419 g_source_set_callback (idle_source,
1420 emit_closed_in_idle,
1422 (GDestroyNotify) emit_closed_data_free);
1423 g_source_set_name (idle_source, "[gio] emit_closed_in_idle");
1424 g_source_attach (idle_source, connection->main_context_at_construction);
1425 g_source_unref (idle_source);
1428 /* ---------------------------------------------------------------------------------------------------- */
1431 * g_dbus_connection_close:
1432 * @connection: a #GDBusConnection
1433 * @cancellable: (allow-none): a #GCancellable or %NULL
1434 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
1435 * satisfied or %NULL if you don't care about the result
1436 * @user_data: The data to pass to @callback
1438 * Closes @connection. Note that this never causes the process to
1439 * exit (this might only happen if the other end of a shared message
1440 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1442 * Once the connection is closed, operations such as sending a message
1443 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1444 * will not automatically flush the connection so queued messages may
1445 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1447 * If @connection is already closed, this method fails with
1448 * %G_IO_ERROR_CLOSED.
1450 * When @connection has been closed, the #GDBusConnection::closed
1451 * signal is emitted in the
1452 * [thread-default main context][g-main-context-push-thread-default]
1453 * of the thread that @connection was constructed in.
1455 * This is an asynchronous method. When the operation is finished,
1456 * @callback will be invoked in the
1457 * [thread-default main context][g-main-context-push-thread-default]
1458 * of the thread you are calling this method from. You can
1459 * then call g_dbus_connection_close_finish() to get the result of the
1460 * operation. See g_dbus_connection_close_sync() for the synchronous
1466 g_dbus_connection_close (GDBusConnection *connection,
1467 GCancellable *cancellable,
1468 GAsyncReadyCallback callback,
1471 GSimpleAsyncResult *simple;
1473 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1475 /* do not use g_return_val_if_fail(), we want the memory barrier */
1476 if (!check_initialized (connection))
1479 g_assert (connection->worker != NULL);
1481 simple = g_simple_async_result_new (G_OBJECT (connection),
1484 g_dbus_connection_close);
1485 g_simple_async_result_set_check_cancellable (simple, cancellable);
1486 _g_dbus_worker_close (connection->worker, cancellable, simple);
1487 g_object_unref (simple);
1491 * g_dbus_connection_close_finish:
1492 * @connection: a #GDBusConnection
1493 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
1494 * to g_dbus_connection_close()
1495 * @error: return location for error or %NULL
1497 * Finishes an operation started with g_dbus_connection_close().
1499 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1504 g_dbus_connection_close_finish (GDBusConnection *connection,
1508 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1513 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1514 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1515 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1517 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
1519 if (g_simple_async_result_propagate_error (simple, error))
1530 GAsyncResult *result;
1533 /* Can be called by any thread, without the connection lock */
1535 sync_close_cb (GObject *source_object,
1539 SyncCloseData *data = user_data;
1541 data->result = g_object_ref (res);
1542 g_main_loop_quit (data->loop);
1546 * g_dbus_connection_close_sync:
1547 * @connection: a #GDBusConnection
1548 * @cancellable: (allow-none): a #GCancellable or %NULL
1549 * @error: return location for error or %NULL
1551 * Synchronously closees @connection. The calling thread is blocked
1552 * until this is done. See g_dbus_connection_close() for the
1553 * asynchronous version of this method and more details about what it
1556 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
1561 g_dbus_connection_close_sync (GDBusConnection *connection,
1562 GCancellable *cancellable,
1567 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1568 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1572 if (check_unclosed (connection, 0, error))
1574 GMainContext *context;
1577 context = g_main_context_new ();
1578 g_main_context_push_thread_default (context);
1579 data.loop = g_main_loop_new (context, TRUE);
1582 g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
1583 g_main_loop_run (data.loop);
1584 ret = g_dbus_connection_close_finish (connection, data.result, error);
1586 g_object_unref (data.result);
1587 g_main_loop_unref (data.loop);
1588 g_main_context_pop_thread_default (context);
1589 g_main_context_unref (context);
1595 /* ---------------------------------------------------------------------------------------------------- */
1598 * g_dbus_get_bus_id:
1599 * @connection: a #GDBusConnection
1600 * @error: return location for error or %NULL
1602 * Synchronously returns the unique ID of the bus.
1604 * The calling thread is blocked until a reply is received.
1606 * Returns: the unique ID of the bus or %NULL if @error is set.
1607 * Free with g_free().
1612 g_dbus_get_bus_id (GDBusConnection *connection,
1618 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1619 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1624 if (G_IS_KDBUS_CONNECTION (connection->stream))
1626 result = _g_kdbus_GetBusId (connection, error);
1630 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1631 "org.freedesktop.DBus", "GetId",
1632 NULL, G_VARIANT_TYPE ("(s)"),
1633 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1638 g_variant_get (result, "(s)", &bus_id);
1639 g_variant_unref (result);
1648 LIST_ACTIVATABLE_NAMES,
1650 } GDBusListNameType;
1653 _g_dbus_get_list_internal (GDBusConnection *connection,
1655 GDBusListNameType list_name_type,
1667 if (list_name_type == LIST_QUEUED_OWNERS)
1669 if (G_IS_KDBUS_CONNECTION (connection->stream))
1670 result = _g_kdbus_GetListQueuedOwners (connection, name, error);
1672 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1673 "org.freedesktop.DBus", "ListQueuedOwners",
1674 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(as)"),
1675 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1681 if (list_name_type == LIST_NAMES)
1682 method_name = "ListNames";
1684 method_name = "ListActivatableNames";
1686 if (G_IS_KDBUS_CONNECTION (connection->stream))
1687 result = _g_kdbus_GetListNames (connection, list_name_type, error);
1689 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1690 "org.freedesktop.DBus", method_name,
1691 NULL, G_VARIANT_TYPE ("(as)"),
1692 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1697 g_variant_get (result, "(as)", &iter);
1698 n = g_variant_iter_n_children (iter);
1699 strv = g_new (gchar *, n + 1);
1702 while (g_variant_iter_loop (iter, "s", &str))
1704 strv[i] = g_strdup (str);
1709 g_variant_iter_free (iter);
1710 g_variant_unref (result);
1717 * g_dbus_get_list_names:
1718 * @connection: a #GDBusConnection
1719 * @error: return location for error or %NULL
1721 * Synchronously returns a list of all currently-owned names on the bus.
1723 * The calling thread is blocked until a reply is received.
1725 * Returns: a list of all currently-owned names on the bus or %NULL if
1726 * @error is set. Free with g_strfreev().
1731 g_dbus_get_list_names (GDBusConnection *connection,
1736 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1737 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1739 strv = _g_dbus_get_list_internal (connection, NULL, LIST_NAMES, error);
1745 * g_dbus_get_list_activatable_names:
1746 * @connection: a #GDBusConnection
1747 * @error: return location for error or %NULL
1749 * Synchronously returns a list of all names that can be activated on the bus.
1751 * The calling thread is blocked until a reply is received.
1753 * Returns: a list of all names that can be activated on the bus or %NULL if
1754 * @error is set. Free with g_strfreev().
1759 g_dbus_get_list_activatable_names (GDBusConnection *connection,
1764 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1765 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1767 strv = _g_dbus_get_list_internal (connection, NULL, LIST_ACTIVATABLE_NAMES, error);
1773 * g_dbus_get_list_queued_names:
1774 * @connection: a #GDBusConnection
1775 * @name: a unique or well-known bus name
1776 * @error: return location for error or %NULL
1778 * Synchronously returns the unique bus names of connections currently queued
1781 * If @name contains a value not compatible with the D-Bus syntax and naming
1782 * conventions for bus names, the operation returns %NULL and @error is set.
1784 * The calling thread is blocked until a reply is received.
1786 * Returns: the unique bus names of connections currently queued for the @name
1787 * or %NULL if @error is set. Free with g_strfreev().
1792 g_dbus_get_list_queued_owners (GDBusConnection *connection,
1798 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1799 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
1800 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1802 strv = _g_dbus_get_list_internal (connection, name, LIST_QUEUED_OWNERS, error);
1808 * g_dbus_get_name_owner:
1809 * @connection: a #GDBusConnection
1810 * @name: well-known bus name to get the owner of
1811 * @error: return location for error or %NULL
1813 * Synchronously returns the unique connection name of the primary owner of
1814 * the name given. If the requested name doesn't have an owner, an @error is
1817 * If @name contains a value not compatible with the D-Bus syntax and naming
1818 * conventions for bus names, the operation returns %NULL and @error is set.
1820 * The calling thread is blocked until a reply is received.
1822 * Returns: the unique connection name of the primary owner of the
1823 * name given. If the requested name doesn't have an owner, function
1824 * returns %NULL and @error is set. Free with g_free().
1829 g_dbus_get_name_owner (GDBusConnection *connection,
1836 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1837 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
1838 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1843 if (G_IS_KDBUS_CONNECTION (connection->stream))
1844 result = _g_kdbus_GetNameOwner (connection, name, error);
1846 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1847 "org.freedesktop.DBus", "GetNameOwner",
1848 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(s)"),
1849 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1852 g_variant_get (result, "(s)", &name_owner);
1853 g_variant_unref (result);
1862 * g_dbus_name_has_owner:
1863 * @connection: a #GDBusConnection
1864 * @name: a unique or well-known bus name
1865 * @error: return location for error or %NULL
1867 * Synchronously checks if the specified name exists (currently has an owner).
1869 * If @name contains a value not compatible with the D-Bus syntax and naming
1870 * conventions for bus names, the operation returns %NULL and @error is set.
1872 * The calling thread is blocked until a reply is received.
1874 * Returns: %TRUE if specified name exists (currently has an owner)
1875 * If the requested name doesn't have an owner or @error is set,
1876 * function returns %FALSE.
1881 g_dbus_name_has_owner (GDBusConnection *connection,
1888 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1889 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
1890 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1894 if (G_IS_KDBUS_CONNECTION (connection->stream))
1895 result = _g_kdbus_NameHasOwner (connection, name, error);
1897 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1898 "org.freedesktop.DBus", "NameHasOwner",
1899 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(b)"),
1900 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1903 g_variant_get (result, "(b)", &ret);
1904 g_variant_unref (result);
1913 * g_dbus_get_connection_pid:
1914 * @connection: a #GDBusConnection
1915 * @name: a unique or well-known bus name of the connection to query
1916 * @error: return location for error or %NULL
1918 * Synchronously returns the Unix process ID of the process connected to the
1919 * bus. If unable to determine it, an @error is returned.
1921 * If @name contains a value not compatible with the D-Bus syntax and naming
1922 * conventions for bus names, the operation returns (guint32) -1 and @error
1925 * The calling thread is blocked until a reply is received.
1927 * Returns: the Unix process ID of the process connected to the bus or
1928 * (guint32) -1 if @error is set.
1933 g_dbus_get_connection_pid (GDBusConnection *connection,
1940 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), -1);
1941 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), -1);
1942 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1947 if (G_IS_KDBUS_CONNECTION (connection->stream))
1948 result = _g_kdbus_GetConnectionUnixProcessID (connection, name, error);
1950 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
1951 "org.freedesktop.DBus", "GetConnectionUnixProcessID",
1952 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
1953 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
1956 g_variant_get (result, "(u)", &pid);
1957 g_variant_unref (result);
1964 * g_dbus_get_connection_uid:
1965 * @connection: a #GDBusConnection
1966 * @name: a unique or well-known bus name of the connection to query
1967 * @error: return location for error or %NULL
1969 * Synchronously returns the Unix user ID of the process connected to the
1970 * bus. If unable to determine it, an @error is returned.
1972 * If @name contains a value not compatible with the D-Bus syntax and naming
1973 * conventions for bus names, the operation returns (guint32) -1 and @error
1976 * The calling thread is blocked until a reply is received.
1978 * Returns: the Unix user ID of the process connected to the bus or
1979 * (guint32) -1 if @error is set.
1984 g_dbus_get_connection_uid (GDBusConnection *connection,
1991 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), -1);
1992 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), -1);
1993 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1998 if (G_IS_KDBUS_CONNECTION (connection->stream))
1999 result = _g_kdbus_GetConnectionUnixUser (connection, name, error);
2001 result = g_dbus_connection_call_sync (connection, "org.freedesktop.DBus", "/",
2002 "org.freedesktop.DBus", "GetConnectionUnixUser",
2003 g_variant_new ("(s)", name), G_VARIANT_TYPE ("(u)"),
2004 G_DBUS_CALL_FLAGS_NONE, -1, NULL, error);
2007 g_variant_get (result, "(u)", &uid);
2008 g_variant_unref (result);
2014 /* ---------------------------------------------------------------------------------------------------- */
2017 * g_dbus_connection_get_last_serial:
2018 * @connection: a #GDBusConnection
2020 * Retrieves the last serial number assigned to a #GDBusMessage on
2021 * the current thread. This includes messages sent via both low-level
2022 * API such as g_dbus_connection_send_message() as well as
2023 * high-level API such as g_dbus_connection_emit_signal(),
2024 * g_dbus_connection_call() or g_dbus_proxy_call().
2026 * Returns: the last used serial or zero when no message has been sent
2027 * within the current thread
2032 g_dbus_connection_get_last_serial (GDBusConnection *connection)
2036 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2038 CONNECTION_LOCK (connection);
2039 ret = GPOINTER_TO_UINT (g_hash_table_lookup (connection->map_thread_to_last_serial,
2041 CONNECTION_UNLOCK (connection);
2046 /* ---------------------------------------------------------------------------------------------------- */
2048 /* Can be called by any thread, with the connection lock held */
2050 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
2051 GDBusMessage *message,
2052 GDBusSendMessageFlags flags,
2053 volatile guint32 *out_serial,
2058 guint32 serial_to_use;
2061 CONNECTION_ENSURE_LOCK (connection);
2063 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2064 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2066 /* TODO: check all necessary headers are present */
2071 if (out_serial != NULL)
2074 /* If we're in initable_init(), don't check for being initialized, to avoid
2075 * chicken-and-egg problems. initable_init() is responsible for setting up
2076 * our prerequisites (mainly connection->worker), and only calling us
2077 * from its own thread (so no memory barrier is needed).
2079 if (!check_unclosed (connection,
2080 (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
2084 blob = g_dbus_message_to_blob (message,
2086 connection->capabilities,
2091 if (flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL)
2092 serial_to_use = g_dbus_message_get_serial (message);
2094 serial_to_use = ++connection->last_serial; /* TODO: handle overflow */
2099 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
2102 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
2105 g_assert_not_reached ();
2110 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
2111 blob_size, serial_to_use, connection);
2112 g_printerr ("----\n");
2113 hexdump (blob, blob_size);
2114 g_printerr ("----\n");
2117 /* TODO: use connection->auth to encode the blob */
2119 if (out_serial != NULL)
2120 *out_serial = serial_to_use;
2122 /* store used serial for the current thread */
2123 /* TODO: watch the thread disposal and remove associated record
2125 * - see https://bugzilla.gnome.org/show_bug.cgi?id=676825#c7
2127 g_hash_table_replace (connection->map_thread_to_last_serial,
2129 GUINT_TO_POINTER (serial_to_use));
2131 if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
2132 g_dbus_message_set_serial (message, serial_to_use);
2134 g_dbus_message_lock (message);
2135 _g_dbus_worker_send_message (connection->worker,
2139 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
2150 * g_dbus_connection_send_message:
2151 * @connection: a #GDBusConnection
2152 * @message: a #GDBusMessage
2153 * @flags: flags affecting how the message is sent
2154 * @out_serial: (out) (allow-none): return location for serial number assigned
2155 * to @message when sending it or %NULL
2156 * @error: Return location for error or %NULL
2158 * Asynchronously sends @message to the peer represented by @connection.
2160 * Unless @flags contain the
2161 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2162 * will be assigned by @connection and set on @message via
2163 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2164 * serial number used will be written to this location prior to
2165 * submitting the message to the underlying transport.
2167 * If @connection is closed then the operation will fail with
2168 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
2169 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2171 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2172 * for an example of how to use this low-level API to send and receive
2173 * UNIX file descriptors.
2175 * Note that @message must be unlocked, unless @flags contain the
2176 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2178 * Returns: %TRUE if the message was well-formed and queued for
2179 * transmission, %FALSE if @error is set
2184 g_dbus_connection_send_message (GDBusConnection *connection,
2185 GDBusMessage *message,
2186 GDBusSendMessageFlags flags,
2187 volatile guint32 *out_serial,
2192 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2193 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2194 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
2195 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
2197 CONNECTION_LOCK (connection);
2198 ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
2199 CONNECTION_UNLOCK (connection);
2203 /* ---------------------------------------------------------------------------------------------------- */
2207 volatile gint ref_count;
2208 GDBusConnection *connection;
2210 GSimpleAsyncResult *simple;
2212 GMainContext *main_context;
2214 GCancellable *cancellable;
2216 gulong cancellable_handler_id;
2218 GSource *timeout_source;
2223 /* Can be called from any thread with or without lock held */
2224 static SendMessageData *
2225 send_message_data_ref (SendMessageData *data)
2227 g_atomic_int_inc (&data->ref_count);
2231 /* Can be called from any thread with or without lock held */
2233 send_message_data_unref (SendMessageData *data)
2235 if (g_atomic_int_dec_and_test (&data->ref_count))
2237 g_assert (data->timeout_source == NULL);
2238 g_assert (data->simple == NULL);
2239 g_assert (data->cancellable_handler_id == 0);
2240 g_object_unref (data->connection);
2241 if (data->cancellable != NULL)
2242 g_object_unref (data->cancellable);
2243 g_main_context_unref (data->main_context);
2248 /* ---------------------------------------------------------------------------------------------------- */
2250 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
2252 send_message_with_reply_deliver (SendMessageData *data, gboolean remove)
2254 CONNECTION_ENSURE_LOCK (data->connection);
2256 g_assert (!data->delivered);
2258 data->delivered = TRUE;
2260 g_simple_async_result_complete_in_idle (data->simple);
2261 g_object_unref (data->simple);
2262 data->simple = NULL;
2264 if (data->timeout_source != NULL)
2266 g_source_destroy (data->timeout_source);
2267 data->timeout_source = NULL;
2269 if (data->cancellable_handler_id > 0)
2271 g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
2272 data->cancellable_handler_id = 0;
2277 g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
2278 GUINT_TO_POINTER (data->serial)));
2281 send_message_data_unref (data);
2284 /* ---------------------------------------------------------------------------------------------------- */
2286 /* Can be called from any thread with lock held */
2288 send_message_data_deliver_reply_unlocked (SendMessageData *data,
2289 GDBusMessage *reply)
2291 if (data->delivered)
2294 g_simple_async_result_set_op_res_gpointer (data->simple,
2295 g_object_ref (reply),
2298 send_message_with_reply_deliver (data, TRUE);
2304 /* ---------------------------------------------------------------------------------------------------- */
2306 /* Called from a user thread, lock is not held */
2308 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
2310 SendMessageData *data = user_data;
2312 CONNECTION_LOCK (data->connection);
2313 if (data->delivered)
2316 g_simple_async_result_set_error (data->simple,
2318 G_IO_ERROR_CANCELLED,
2319 _("Operation was cancelled"));
2321 send_message_with_reply_deliver (data, TRUE);
2324 CONNECTION_UNLOCK (data->connection);
2328 /* Can be called from any thread with or without lock held */
2330 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
2333 SendMessageData *data = user_data;
2334 GSource *idle_source;
2336 /* postpone cancellation to idle handler since we may be called directly
2337 * via g_cancellable_connect() (e.g. holding lock)
2339 idle_source = g_idle_source_new ();
2340 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
2341 g_source_set_callback (idle_source,
2342 send_message_with_reply_cancelled_idle_cb,
2343 send_message_data_ref (data),
2344 (GDestroyNotify) send_message_data_unref);
2345 g_source_set_name (idle_source, "[gio] send_message_with_reply_cancelled_idle_cb");
2346 g_source_attach (idle_source, data->main_context);
2347 g_source_unref (idle_source);
2350 /* ---------------------------------------------------------------------------------------------------- */
2352 /* Called from a user thread, lock is not held */
2354 send_message_with_reply_timeout_cb (gpointer user_data)
2356 SendMessageData *data = user_data;
2358 CONNECTION_LOCK (data->connection);
2359 if (data->delivered)
2362 g_simple_async_result_set_error (data->simple,
2364 G_IO_ERROR_TIMED_OUT,
2365 _("Timeout was reached"));
2367 send_message_with_reply_deliver (data, TRUE);
2370 CONNECTION_UNLOCK (data->connection);
2375 /* ---------------------------------------------------------------------------------------------------- */
2377 /* Called from a user thread, connection's lock is held */
2379 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
2380 GDBusMessage *message,
2381 GDBusSendMessageFlags flags,
2383 volatile guint32 *out_serial,
2384 GCancellable *cancellable,
2385 GAsyncReadyCallback callback,
2388 GSimpleAsyncResult *simple;
2389 SendMessageData *data;
2391 volatile guint32 serial;
2395 if (out_serial == NULL)
2396 out_serial = &serial;
2398 if (timeout_msec == -1)
2399 timeout_msec = 25 * 1000;
2401 simple = g_simple_async_result_new (G_OBJECT (connection),
2404 g_dbus_connection_send_message_with_reply);
2405 g_simple_async_result_set_check_cancellable (simple, cancellable);
2407 if (g_cancellable_is_cancelled (cancellable))
2409 g_simple_async_result_set_error (simple,
2411 G_IO_ERROR_CANCELLED,
2412 _("Operation was cancelled"));
2413 g_simple_async_result_complete_in_idle (simple);
2414 g_object_unref (simple);
2419 if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
2421 g_simple_async_result_take_error (simple, error);
2422 g_simple_async_result_complete_in_idle (simple);
2423 g_object_unref (simple);
2427 data = g_new0 (SendMessageData, 1);
2428 data->ref_count = 1;
2429 data->connection = g_object_ref (connection);
2430 data->simple = simple;
2431 data->serial = *out_serial;
2432 data->main_context = g_main_context_ref_thread_default ();
2434 if (cancellable != NULL)
2436 data->cancellable = g_object_ref (cancellable);
2437 data->cancellable_handler_id = g_cancellable_connect (cancellable,
2438 G_CALLBACK (send_message_with_reply_cancelled_cb),
2439 send_message_data_ref (data),
2440 (GDestroyNotify) send_message_data_unref);
2443 if (timeout_msec != G_MAXINT)
2445 data->timeout_source = g_timeout_source_new (timeout_msec);
2446 g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
2447 g_source_set_callback (data->timeout_source,
2448 send_message_with_reply_timeout_cb,
2449 send_message_data_ref (data),
2450 (GDestroyNotify) send_message_data_unref);
2451 g_source_attach (data->timeout_source, data->main_context);
2452 g_source_unref (data->timeout_source);
2455 g_hash_table_insert (connection->map_method_serial_to_send_message_data,
2456 GUINT_TO_POINTER (*out_serial),
2464 * g_dbus_connection_send_message_with_reply:
2465 * @connection: a #GDBusConnection
2466 * @message: a #GDBusMessage
2467 * @flags: flags affecting how the message is sent
2468 * @timeout_msec: the timeout in milliseconds, -1 to use the default
2469 * timeout or %G_MAXINT for no timeout
2470 * @out_serial: (out) (allow-none): return location for serial number assigned
2471 * to @message when sending it or %NULL
2472 * @cancellable: (allow-none): a #GCancellable or %NULL
2473 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
2474 * is satisfied or %NULL if you don't care about the result
2475 * @user_data: The data to pass to @callback
2477 * Asynchronously sends @message to the peer represented by @connection.
2479 * Unless @flags contain the
2480 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2481 * will be assigned by @connection and set on @message via
2482 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2483 * serial number used will be written to this location prior to
2484 * submitting the message to the underlying transport.
2486 * If @connection is closed then the operation will fail with
2487 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2488 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2489 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2491 * This is an asynchronous method. When the operation is finished, @callback
2492 * will be invoked in the
2493 * [thread-default main context][g-main-context-push-thread-default]
2494 * of the thread you are calling this method from. You can then call
2495 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
2496 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
2498 * Note that @message must be unlocked, unless @flags contain the
2499 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2501 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2502 * for an example of how to use this low-level API to send and receive
2503 * UNIX file descriptors.
2508 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
2509 GDBusMessage *message,
2510 GDBusSendMessageFlags flags,
2512 volatile guint32 *out_serial,
2513 GCancellable *cancellable,
2514 GAsyncReadyCallback callback,
2517 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2518 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2519 g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
2520 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
2522 CONNECTION_LOCK (connection);
2523 g_dbus_connection_send_message_with_reply_unlocked (connection,
2531 CONNECTION_UNLOCK (connection);
2535 * g_dbus_connection_send_message_with_reply_finish:
2536 * @connection: a #GDBusConnection
2537 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
2538 * g_dbus_connection_send_message_with_reply()
2539 * @error: teturn location for error or %NULL
2541 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
2543 * Note that @error is only set if a local in-process error
2544 * occurred. That is to say that the returned #GDBusMessage object may
2545 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2546 * g_dbus_message_to_gerror() to transcode this to a #GError.
2548 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2549 * for an example of how to use this low-level API to send and receive
2550 * UNIX file descriptors.
2552 * Returns: (transfer full): a locked #GDBusMessage or %NULL if @error is set
2557 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
2561 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2562 GDBusMessage *reply;
2564 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2565 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2569 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
2571 if (g_simple_async_result_propagate_error (simple, error))
2574 reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
2580 /* ---------------------------------------------------------------------------------------------------- */
2585 GMainContext *context;
2587 } SendMessageSyncData;
2589 /* Called from a user thread, lock is not held */
2591 send_message_with_reply_sync_cb (GDBusConnection *connection,
2595 SendMessageSyncData *data = user_data;
2596 data->res = g_object_ref (res);
2597 g_main_loop_quit (data->loop);
2601 * g_dbus_connection_send_message_with_reply_sync:
2602 * @connection: a #GDBusConnection
2603 * @message: a #GDBusMessage
2604 * @flags: flags affecting how the message is sent.
2605 * @timeout_msec: the timeout in milliseconds, -1 to use the default
2606 * timeout or %G_MAXINT for no timeout
2607 * @out_serial: (out) (allow-none): return location for serial number
2608 * assigned to @message when sending it or %NULL
2609 * @cancellable: (allow-none): a #GCancellable or %NULL
2610 * @error: return location for error or %NULL
2612 * Synchronously sends @message to the peer represented by @connection
2613 * and blocks the calling thread until a reply is received or the
2614 * timeout is reached. See g_dbus_connection_send_message_with_reply()
2615 * for the asynchronous version of this method.
2617 * Unless @flags contain the
2618 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2619 * will be assigned by @connection and set on @message via
2620 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2621 * serial number used will be written to this location prior to
2622 * submitting the message to the underlying transport.
2624 * If @connection is closed then the operation will fail with
2625 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2626 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2627 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2629 * Note that @error is only set if a local in-process error
2630 * occurred. That is to say that the returned #GDBusMessage object may
2631 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2632 * g_dbus_message_to_gerror() to transcode this to a #GError.
2634 * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
2635 * for an example of how to use this low-level API to send and receive
2636 * UNIX file descriptors.
2638 * Note that @message must be unlocked, unless @flags contain the
2639 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2641 * Returns: (transfer full): a locked #GDBusMessage that is the reply
2642 * to @message or %NULL if @error is set
2647 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
2648 GDBusMessage *message,
2649 GDBusSendMessageFlags flags,
2651 volatile guint32 *out_serial,
2652 GCancellable *cancellable,
2655 SendMessageSyncData *data;
2656 GDBusMessage *reply;
2658 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2659 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2660 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
2661 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2662 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2664 data = g_new0 (SendMessageSyncData, 1);
2665 data->context = g_main_context_new ();
2666 data->loop = g_main_loop_new (data->context, FALSE);
2668 g_main_context_push_thread_default (data->context);
2670 g_dbus_connection_send_message_with_reply (connection,
2676 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2678 g_main_loop_run (data->loop);
2679 reply = g_dbus_connection_send_message_with_reply_finish (connection,
2683 g_main_context_pop_thread_default (data->context);
2685 g_main_context_unref (data->context);
2686 g_main_loop_unref (data->loop);
2687 g_object_unref (data->res);
2693 /* ---------------------------------------------------------------------------------------------------- */
2697 GDBusMessageFilterFunction func;
2704 GDBusMessageFilterFunction filter_function;
2706 GDestroyNotify user_data_free_func;
2709 /* Called in GDBusWorker's thread - we must not block - with no lock held */
2711 on_worker_message_received (GDBusWorker *worker,
2712 GDBusMessage *message,
2715 GDBusConnection *connection;
2716 FilterCallback *filters;
2721 G_LOCK (message_bus_lock);
2722 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2725 G_UNLOCK (message_bus_lock);
2728 connection = G_DBUS_CONNECTION (user_data);
2729 g_object_ref (connection);
2730 G_UNLOCK (message_bus_lock);
2732 //g_debug ("in on_worker_message_received");
2734 g_object_ref (message);
2735 g_dbus_message_lock (message);
2737 //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2739 /* First collect the set of callback functions */
2740 CONNECTION_LOCK (connection);
2741 num_filters = connection->filters->len;
2742 filters = g_new0 (FilterCallback, num_filters);
2743 for (n = 0; n < num_filters; n++)
2745 FilterData *data = connection->filters->pdata[n];
2746 filters[n].func = data->filter_function;
2747 filters[n].user_data = data->user_data;
2749 CONNECTION_UNLOCK (connection);
2751 /* then call the filters in order (without holding the lock) */
2752 for (n = 0; n < num_filters; n++)
2754 message = filters[n].func (connection,
2757 filters[n].user_data);
2758 if (message == NULL)
2760 g_dbus_message_lock (message);
2763 /* Standard dispatch unless the filter ate the message - no need to
2764 * do anything if the message was altered
2766 if (message != NULL)
2768 GDBusMessageType message_type;
2770 message_type = g_dbus_message_get_message_type (message);
2771 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2773 guint32 reply_serial;
2774 SendMessageData *send_message_data;
2776 reply_serial = g_dbus_message_get_reply_serial (message);
2777 CONNECTION_LOCK (connection);
2778 send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
2779 GUINT_TO_POINTER (reply_serial));
2780 if (send_message_data != NULL)
2782 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2783 send_message_data_deliver_reply_unlocked (send_message_data, message);
2787 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2789 CONNECTION_UNLOCK (connection);
2791 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2793 CONNECTION_LOCK (connection);
2794 distribute_signals (connection, message);
2795 CONNECTION_UNLOCK (connection);
2797 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2799 CONNECTION_LOCK (connection);
2800 distribute_method_call (connection, message);
2801 CONNECTION_UNLOCK (connection);
2805 if (message != NULL)
2806 g_object_unref (message);
2807 g_object_unref (connection);
2811 /* Called in GDBusWorker's thread, lock is not held */
2812 static GDBusMessage *
2813 on_worker_message_about_to_be_sent (GDBusWorker *worker,
2814 GDBusMessage *message,
2817 GDBusConnection *connection;
2818 FilterCallback *filters;
2823 G_LOCK (message_bus_lock);
2824 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2827 G_UNLOCK (message_bus_lock);
2830 connection = G_DBUS_CONNECTION (user_data);
2831 g_object_ref (connection);
2832 G_UNLOCK (message_bus_lock);
2834 //g_debug ("in on_worker_message_about_to_be_sent");
2836 /* First collect the set of callback functions */
2837 CONNECTION_LOCK (connection);
2838 num_filters = connection->filters->len;
2839 filters = g_new0 (FilterCallback, num_filters);
2840 for (n = 0; n < num_filters; n++)
2842 FilterData *data = connection->filters->pdata[n];
2843 filters[n].func = data->filter_function;
2844 filters[n].user_data = data->user_data;
2846 CONNECTION_UNLOCK (connection);
2848 /* then call the filters in order (without holding the lock) */
2849 for (n = 0; n < num_filters; n++)
2851 g_dbus_message_lock (message);
2852 message = filters[n].func (connection,
2855 filters[n].user_data);
2856 if (message == NULL)
2860 g_object_unref (connection);
2866 /* called with connection lock held, in GDBusWorker thread */
2868 cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
2870 SendMessageData *data = value;
2872 if (data->delivered)
2875 g_simple_async_result_set_error (data->simple,
2878 _("The connection is closed"));
2880 /* Ask send_message_with_reply_deliver not to remove the element from the
2881 * hash table - we're in the middle of a foreach; that would be unsafe.
2882 * Instead, return TRUE from this function so that it gets removed safely.
2884 send_message_with_reply_deliver (data, FALSE);
2888 /* Called in GDBusWorker's thread - we must not block - without lock held */
2890 on_worker_closed (GDBusWorker *worker,
2891 gboolean remote_peer_vanished,
2895 GDBusConnection *connection;
2897 guint old_atomic_flags;
2899 G_LOCK (message_bus_lock);
2900 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2903 G_UNLOCK (message_bus_lock);
2906 connection = G_DBUS_CONNECTION (user_data);
2907 g_object_ref (connection);
2908 G_UNLOCK (message_bus_lock);
2910 //g_debug ("in on_worker_closed: %s", error->message);
2912 CONNECTION_LOCK (connection);
2913 /* Even though this is atomic, we do it inside the lock to avoid breaking
2914 * assumptions in remove_match_rule(). We'd need the lock in a moment
2915 * anyway, so, no loss.
2917 old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
2919 if (!(old_atomic_flags & FLAG_CLOSED))
2921 g_hash_table_foreach_remove (connection->map_method_serial_to_send_message_data, cancel_method_on_close, NULL);
2922 schedule_closed_unlocked (connection, remote_peer_vanished, error);
2924 CONNECTION_UNLOCK (connection);
2926 g_object_unref (connection);
2929 /* ---------------------------------------------------------------------------------------------------- */
2931 /* Determines the biggest set of capabilities we can support on this
2934 * Called with the init_lock held.
2936 static GDBusCapabilityFlags
2937 get_offered_capabilities_max (GDBusConnection *connection)
2939 GDBusCapabilityFlags ret;
2940 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
2942 if (G_IS_UNIX_CONNECTION (connection->stream))
2943 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
2948 /* Called in a user thread, lock is not held */
2950 initable_init (GInitable *initable,
2951 GCancellable *cancellable,
2954 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
2957 /* This method needs to be idempotent to work with the singleton
2958 * pattern. See the docs for g_initable_init(). We implement this by
2961 * Unfortunately we can't use the main lock since the on_worker_*()
2962 * callbacks above needs the lock during initialization (for message
2963 * bus connections we do a synchronous Hello() call on the bus).
2965 g_mutex_lock (&connection->init_lock);
2969 /* Make this a no-op if we're already initialized (successfully or
2972 if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
2974 ret = (connection->initialization_error == NULL);
2978 /* Because of init_lock, we can't get here twice in different threads */
2979 g_assert (connection->initialization_error == NULL);
2981 /* The user can pass multiple (but mutally exclusive) construct
2984 * - stream (of type GIOStream)
2985 * - address (of type gchar*)
2987 * At the end of the day we end up with a non-NULL GIOStream
2988 * object in connection->stream.
2990 if (connection->address != NULL)
2992 g_assert (connection->stream == NULL);
2994 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
2995 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
2997 g_set_error_literal (&connection->initialization_error,
2999 G_IO_ERROR_INVALID_ARGUMENT,
3000 _("Unsupported flags encountered when constructing a client-side connection"));
3004 connection->stream = g_dbus_address_get_stream_sync (connection->address,
3005 NULL, /* TODO: out_guid */
3007 &connection->initialization_error);
3008 if (connection->stream == NULL)
3011 else if (connection->stream != NULL)
3017 g_assert_not_reached ();
3020 /* [KDBUS] Skip authentication process for kdbus transport */
3021 if (G_IS_KDBUS_CONNECTION (connection->stream))
3026 /* Authenticate the connection */
3027 if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
3029 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
3030 g_assert (connection->guid != NULL);
3031 connection->auth = _g_dbus_auth_new (connection->stream);
3032 if (!_g_dbus_auth_run_server (connection->auth,
3033 connection->authentication_observer,
3035 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
3036 get_offered_capabilities_max (connection),
3037 &connection->capabilities,
3038 &connection->credentials,
3040 &connection->initialization_error))
3043 else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
3045 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
3046 g_assert (connection->guid == NULL);
3047 connection->auth = _g_dbus_auth_new (connection->stream);
3048 connection->guid = _g_dbus_auth_run_client (connection->auth,
3049 connection->authentication_observer,
3050 get_offered_capabilities_max (connection),
3051 &connection->capabilities,
3053 &connection->initialization_error);
3054 if (connection->guid == NULL)
3058 if (connection->authentication_observer != NULL)
3060 g_object_unref (connection->authentication_observer);
3061 connection->authentication_observer = NULL;
3066 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
3068 //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
3071 /* We want all IO operations to be non-blocking since they happen in
3072 * the worker thread which is shared by _all_ connections.
3074 if (G_IS_SOCKET_CONNECTION (connection->stream))
3076 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
3080 G_LOCK (message_bus_lock);
3081 if (alive_connections == NULL)
3082 alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
3083 g_hash_table_insert (alive_connections, connection, connection);
3084 G_UNLOCK (message_bus_lock);
3086 connection->worker = _g_dbus_worker_new (connection->stream,
3087 connection->capabilities,
3088 ((connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0),
3089 on_worker_message_received,
3090 on_worker_message_about_to_be_sent,
3094 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
3095 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3097 GVariant *hello_result;
3099 /* we could lift this restriction by adding code in gdbusprivate.c */
3100 if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
3102 g_set_error_literal (&connection->initialization_error,
3105 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
3109 if (G_IS_KDBUS_CONNECTION (connection->stream))
3111 hello_result = _g_kdbus_Hello (connection->stream, &connection->initialization_error);
3115 hello_result = g_dbus_connection_call_sync (connection,
3116 "org.freedesktop.DBus", /* name */
3117 "/org/freedesktop/DBus", /* path */
3118 "org.freedesktop.DBus", /* interface */
3120 NULL, /* parameters */
3121 G_VARIANT_TYPE ("(s)"),
3122 CALL_FLAGS_INITIALIZING,
3124 NULL, /* TODO: cancellable */
3125 &connection->initialization_error);
3128 if (hello_result == NULL)
3131 g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
3132 g_variant_unref (hello_result);
3133 //g_debug ("unique name is '%s'", connection->bus_unique_name);
3140 g_assert (connection->initialization_error != NULL);
3141 g_propagate_error (error, g_error_copy (connection->initialization_error));
3144 g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
3145 g_mutex_unlock (&connection->init_lock);
3151 initable_iface_init (GInitableIface *initable_iface)
3153 initable_iface->init = initable_init;
3156 /* ---------------------------------------------------------------------------------------------------- */
3159 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
3164 /* ---------------------------------------------------------------------------------------------------- */
3167 * g_dbus_connection_new:
3168 * @stream: a #GIOStream
3169 * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
3170 * @flags: flags describing how to make the connection
3171 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3172 * @cancellable: (allow-none): a #GCancellable or %NULL
3173 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3174 * @user_data: the data to pass to @callback
3176 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
3177 * with the end represented by @stream.
3179 * If @stream is a #GSocketConnection, then the corresponding #GSocket
3180 * will be put into non-blocking mode.
3182 * The D-Bus connection will interact with @stream from a worker thread.
3183 * As a result, the caller should not interact with @stream after this
3184 * method has been called, except by calling g_object_unref() on it.
3186 * If @observer is not %NULL it may be used to control the
3187 * authentication process.
3189 * When the operation is finished, @callback will be invoked. You can
3190 * then call g_dbus_connection_new_finish() to get the result of the
3193 * This is a asynchronous failable constructor. See
3194 * g_dbus_connection_new_sync() for the synchronous
3200 g_dbus_connection_new (GIOStream *stream,
3202 GDBusConnectionFlags flags,
3203 GDBusAuthObserver *observer,
3204 GCancellable *cancellable,
3205 GAsyncReadyCallback callback,
3208 g_return_if_fail (G_IS_IO_STREAM (stream));
3209 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
3217 "authentication-observer", observer,
3222 * g_dbus_connection_new_finish:
3223 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback
3224 * passed to g_dbus_connection_new().
3225 * @error: return location for error or %NULL
3227 * Finishes an operation started with g_dbus_connection_new().
3229 * Returns: a #GDBusConnection or %NULL if @error is set. Free
3230 * with g_object_unref().
3235 g_dbus_connection_new_finish (GAsyncResult *res,
3239 GObject *source_object;
3241 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3242 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3244 source_object = g_async_result_get_source_object (res);
3245 g_assert (source_object != NULL);
3246 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
3249 g_object_unref (source_object);
3251 return G_DBUS_CONNECTION (object);
3257 * g_dbus_connection_new_sync:
3258 * @stream: a #GIOStream
3259 * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
3260 * @flags: flags describing how to make the connection
3261 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3262 * @cancellable: (allow-none): a #GCancellable or %NULL
3263 * @error: return location for error or %NULL
3265 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
3266 * with the end represented by @stream.
3268 * If @stream is a #GSocketConnection, then the corresponding #GSocket
3269 * will be put into non-blocking mode.
3271 * The D-Bus connection will interact with @stream from a worker thread.
3272 * As a result, the caller should not interact with @stream after this
3273 * method has been called, except by calling g_object_unref() on it.
3275 * If @observer is not %NULL it may be used to control the
3276 * authentication process.
3278 * This is a synchronous failable constructor. See
3279 * g_dbus_connection_new() for the asynchronous version.
3281 * Returns: a #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
3286 g_dbus_connection_new_sync (GIOStream *stream,
3288 GDBusConnectionFlags flags,
3289 GDBusAuthObserver *observer,
3290 GCancellable *cancellable,
3293 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
3294 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3295 return g_initable_new (G_TYPE_DBUS_CONNECTION,
3301 "authentication-observer", observer,
3305 /* ---------------------------------------------------------------------------------------------------- */
3308 * g_dbus_connection_new_for_address:
3309 * @address: a D-Bus address
3310 * @flags: flags describing how to make the connection
3311 * @observer: (allow-none): a #GDBusAuthObserver or %NULL
3312 * @cancellable: (allow-none): a #GCancellable or %NULL
3313 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3314 * @user_data: the data to pass to @callback
3316 * Asynchronously connects and sets up a D-Bus client connection for
3317 * exchanging D-Bus messages with an endpoint specified by @address
3318 * which must be in the D-Bus address format.
3320 * This constructor can only be used to initiate client-side
3321 * connections - use g_dbus_connection_new() if you need to act as the
3322 * server. In particular, @flags cannot contain the
3323 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
3324 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
3326 * When the operation is finished, @callback will be invoked. You can
3327 * then call g_dbus_connection_new_finish() to get the result of the
3330 * If @observer is not %NULL it may be used to control the
3331 * authentication process.
3333 * This is a asynchronous failable constructor. See
3334 * g_dbus_connection_new_for_address_sync() for the synchronous
3340 g_dbus_connection_new_for_address (const gchar *address,
3341 GDBusConnectionFlags flags,
3342 GDBusAuthObserver *observer,
3343 GCancellable *cancellable,
3344 GAsyncReadyCallback callback,
3347 g_return_if_fail (address != NULL);
3348 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
3355 "authentication-observer", observer,
3360 * g_dbus_connection_new_for_address_finish:
3361 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
3362 * to g_dbus_connection_new()
3363 * @error: return location for error or %NULL
3365 * Finishes an operation started with g_dbus_connection_new_for_address().
3367 * Returns: a #GDBusConnection or %NULL if @error is set. Free with
3373 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
3377 GObject *source_object;
3379 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3380 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3382 source_object = g_async_result_get_source_object (res);
3383 g_assert (source_object != NULL);
3384 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
3387 g_object_unref (source_object);
3389 return G_DBUS_CONNECTION (object);
3395 * g_dbus_connection_new_for_address_sync:
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 * @error: return location for error or %NULL
3402 * Synchronously connects and sets up a D-Bus client connection for
3403 * exchanging D-Bus messages with an endpoint specified by @address
3404 * which must be in the D-Bus address format.
3406 * This constructor can only be used to initiate client-side
3407 * connections - use g_dbus_connection_new_sync() if you need to act
3408 * as the server. In particular, @flags cannot contain the
3409 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
3410 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
3412 * This is a synchronous failable constructor. See
3413 * g_dbus_connection_new_for_address() for the asynchronous version.
3415 * If @observer is not %NULL it may be used to control the
3416 * authentication process.
3418 * Returns: a #GDBusConnection or %NULL if @error is set. Free with
3424 g_dbus_connection_new_for_address_sync (const gchar *address,
3425 GDBusConnectionFlags flags,
3426 GDBusAuthObserver *observer,
3427 GCancellable *cancellable,
3430 g_return_val_if_fail (address != NULL, NULL);
3431 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3432 return g_initable_new (G_TYPE_DBUS_CONNECTION,
3437 "authentication-observer", observer,
3441 /* ---------------------------------------------------------------------------------------------------- */
3444 * g_dbus_connection_set_exit_on_close:
3445 * @connection: a #GDBusConnection
3446 * @exit_on_close: whether the process should be terminated
3447 * when @connection is closed by the remote peer
3449 * Sets whether the process should be terminated when @connection is
3450 * closed by the remote peer. See #GDBusConnection:exit-on-close for
3453 * Note that this function should be used with care. Most modern UNIX
3454 * desktops tie the notion of a user session the session bus, and expect
3455 * all of a users applications to quit when their bus connection goes away.
3456 * If you are setting @exit_on_close to %FALSE for the shared session
3457 * bus connection, you should make sure that your application exits
3458 * when the user session ends.
3463 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
3464 gboolean exit_on_close)
3466 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3469 g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
3471 g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
3476 * g_dbus_connection_get_exit_on_close:
3477 * @connection: a #GDBusConnection
3479 * Gets whether the process is terminated when @connection is
3480 * closed by the remote peer. See
3481 * #GDBusConnection:exit-on-close for more details.
3483 * Returns: whether the process is terminated when @connection is
3484 * closed by the remote peer
3489 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
3491 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3493 if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
3500 * g_dbus_connection_get_guid:
3501 * @connection: a #GDBusConnection
3503 * The GUID of the peer performing the role of server when
3504 * authenticating. See #GDBusConnection:guid for more details.
3506 * Returns: The GUID. Do not free this string, it is owned by
3512 g_dbus_connection_get_guid (GDBusConnection *connection)
3514 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3515 return connection->guid;
3519 * g_dbus_connection_get_unique_name:
3520 * @connection: a #GDBusConnection
3522 * Gets the unique name of @connection as assigned by the message
3523 * bus. This can also be used to figure out if @connection is a
3524 * message bus connection.
3526 * Returns: the unique name or %NULL if @connection is not a message
3527 * bus connection. Do not free this string, it is owned by
3533 g_dbus_connection_get_unique_name (GDBusConnection *connection)
3535 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3537 /* do not use g_return_val_if_fail(), we want the memory barrier */
3538 if (!check_initialized (connection))
3541 return connection->bus_unique_name;
3545 * g_dbus_connection_get_peer_credentials:
3546 * @connection: a #GDBusConnection
3548 * Gets the credentials of the authenticated peer. This will always
3549 * return %NULL unless @connection acted as a server
3550 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
3551 * when set up and the client passed credentials as part of the
3552 * authentication process.
3554 * In a message bus setup, the message bus is always the server and
3555 * each application is a client. So this method will always return
3556 * %NULL for message bus clients.
3558 * Returns: (transfer none): a #GCredentials or %NULL if not available.
3559 * Do not free this object, it is owned by @connection.
3564 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
3566 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3568 /* do not use g_return_val_if_fail(), we want the memory barrier */
3569 if (!check_initialized (connection))
3572 return connection->credentials;
3575 /* ---------------------------------------------------------------------------------------------------- */
3577 static guint _global_filter_id = 1;
3580 * g_dbus_connection_add_filter:
3581 * @connection: a #GDBusConnection
3582 * @filter_function: a filter function
3583 * @user_data: user data to pass to @filter_function
3584 * @user_data_free_func: function to free @user_data with when filter
3585 * is removed or %NULL
3587 * Adds a message filter. Filters are handlers that are run on all
3588 * incoming and outgoing messages, prior to standard dispatch. Filters
3589 * are run in the order that they were added. The same handler can be
3590 * added as a filter more than once, in which case it will be run more
3591 * than once. Filters added during a filter callback won't be run on
3592 * the message being processed. Filter functions are allowed to modify
3593 * and even drop messages.
3595 * Note that filters are run in a dedicated message handling thread so
3596 * they can't block and, generally, can't do anything but signal a
3597 * worker thread. Also note that filters are rarely needed - use API
3598 * such as g_dbus_connection_send_message_with_reply(),
3599 * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
3601 * If a filter consumes an incoming message the message is not
3602 * dispatched anywhere else - not even the standard dispatch machinery
3603 * (that API such as g_dbus_connection_signal_subscribe() and
3604 * g_dbus_connection_send_message_with_reply() relies on) will see the
3605 * message. Similary, if a filter consumes an outgoing message, the
3606 * message will not be sent to the other peer.
3608 * Returns: a filter identifier that can be used with
3609 * g_dbus_connection_remove_filter()
3614 g_dbus_connection_add_filter (GDBusConnection *connection,
3615 GDBusMessageFilterFunction filter_function,
3617 GDestroyNotify user_data_free_func)
3621 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3622 g_return_val_if_fail (filter_function != NULL, 0);
3623 g_return_val_if_fail (check_initialized (connection), 0);
3625 CONNECTION_LOCK (connection);
3626 data = g_new0 (FilterData, 1);
3627 data->id = _global_filter_id++; /* TODO: overflow etc. */
3628 data->filter_function = filter_function;
3629 data->user_data = user_data;
3630 data->user_data_free_func = user_data_free_func;
3631 g_ptr_array_add (connection->filters, data);
3632 CONNECTION_UNLOCK (connection);
3637 /* only called from finalize(), removes all filters */
3639 purge_all_filters (GDBusConnection *connection)
3642 for (n = 0; n < connection->filters->len; n++)
3644 FilterData *data = connection->filters->pdata[n];
3645 if (data->user_data_free_func != NULL)
3646 data->user_data_free_func (data->user_data);
3652 * g_dbus_connection_remove_filter:
3653 * @connection: a #GDBusConnection
3654 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
3661 g_dbus_connection_remove_filter (GDBusConnection *connection,
3665 FilterData *to_destroy;
3667 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3668 g_return_if_fail (check_initialized (connection));
3670 CONNECTION_LOCK (connection);
3672 for (n = 0; n < connection->filters->len; n++)
3674 FilterData *data = connection->filters->pdata[n];
3675 if (data->id == filter_id)
3677 g_ptr_array_remove_index (connection->filters, n);
3682 CONNECTION_UNLOCK (connection);
3684 /* do free without holding lock */
3685 if (to_destroy != NULL)
3687 if (to_destroy->user_data_free_func != NULL)
3688 to_destroy->user_data_free_func (to_destroy->user_data);
3689 g_free (to_destroy);
3693 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
3697 /* ---------------------------------------------------------------------------------------------------- */
3703 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
3704 gchar *interface_name;
3708 GDBusSignalFlags flags;
3709 GArray *subscribers;
3714 GDBusSignalCallback callback;
3716 GDestroyNotify user_data_free_func;
3718 GMainContext *context;
3722 signal_data_free (SignalData *signal_data)
3724 g_free (signal_data->rule);
3725 g_free (signal_data->sender);
3726 g_free (signal_data->sender_unique_name);
3727 g_free (signal_data->interface_name);
3728 g_free (signal_data->member);
3729 g_free (signal_data->object_path);
3730 g_free (signal_data->arg0);
3731 g_array_free (signal_data->subscribers, TRUE);
3732 g_free (signal_data);
3736 args_to_rule (const gchar *sender,
3737 const gchar *interface_name,
3738 const gchar *member,
3739 const gchar *object_path,
3741 GDBusSignalFlags flags)
3745 rule = g_string_new ("type='signal'");
3746 if (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE)
3747 g_string_prepend_c (rule, '-');
3749 g_string_append_printf (rule, ",sender='%s'", sender);
3750 if (interface_name != NULL)
3751 g_string_append_printf (rule, ",interface='%s'", interface_name);
3753 g_string_append_printf (rule, ",member='%s'", member);
3754 if (object_path != NULL)
3755 g_string_append_printf (rule, ",path='%s'", object_path);
3759 if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
3760 g_string_append_printf (rule, ",arg0path='%s'", arg0);
3761 else if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
3762 g_string_append_printf (rule, ",arg0namespace='%s'", arg0);
3764 g_string_append_printf (rule, ",arg0='%s'", arg0);
3767 return g_string_free (rule, FALSE);
3770 static guint _global_subscriber_id = 1;
3771 static guint _global_registration_id = 1;
3772 static guint _global_subtree_registration_id = 1;
3774 /* ---------------------------------------------------------------------------------------------------- */
3776 /* Called in a user thread, lock is held */
3778 add_match_rule (GDBusConnection *connection,
3779 const gchar *match_rule)
3782 GDBusMessage *message;
3784 if (match_rule[0] == '-')
3787 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3788 "/org/freedesktop/DBus", /* path */
3789 "org.freedesktop.DBus", /* interface */
3791 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3793 if (!g_dbus_connection_send_message_unlocked (connection,
3795 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3799 g_critical ("Error while sending AddMatch() message: %s", error->message);
3800 g_error_free (error);
3802 g_object_unref (message);
3805 /* ---------------------------------------------------------------------------------------------------- */
3807 /* Called in a user thread, lock is held */
3809 remove_match_rule (GDBusConnection *connection,
3810 const gchar *match_rule)
3813 GDBusMessage *message;
3815 if (match_rule[0] == '-')
3818 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3819 "/org/freedesktop/DBus", /* path */
3820 "org.freedesktop.DBus", /* interface */
3822 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3825 if (!g_dbus_connection_send_message_unlocked (connection,
3827 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3831 /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
3832 * critical; but we're holding the lock, and our caller checked whether
3833 * we were already closed, so we can't get that error.
3835 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3836 g_error_free (error);
3838 g_object_unref (message);
3841 /* ---------------------------------------------------------------------------------------------------- */
3844 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3846 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3847 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3848 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3849 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3850 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3853 /* ---------------------------------------------------------------------------------------------------- */
3856 * g_dbus_connection_signal_subscribe:
3857 * @connection: a #GDBusConnection
3858 * @sender: (allow-none): sender name to match on (unique or well-known name)
3859 * or %NULL to listen from all senders
3860 * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
3861 * match on all interfaces
3862 * @member: (allow-none): D-Bus signal name to match on or %NULL to match on
3864 * @object_path: (allow-none): object path to match on or %NULL to match on
3866 * @arg0: (allow-none): contents of first string argument to match on or %NULL
3867 * to match on all kinds of arguments
3868 * @flags: flags describing how to subscribe to the signal (currently unused)
3869 * @callback: callback to invoke when there is a signal matching the requested data
3870 * @user_data: user data to pass to @callback
3871 * @user_data_free_func: (allow-none): function to free @user_data with when
3872 * subscription is removed or %NULL
3874 * Subscribes to signals on @connection and invokes @callback with a whenever
3875 * the signal is received. Note that @callback will be invoked in the
3876 * [thread-default main context][g-main-context-push-thread-default]
3877 * of the thread you are calling this method from.
3879 * If @connection is not a message bus connection, @sender must be
3882 * If @sender is a well-known name note that @callback is invoked with
3883 * the unique name for the owner of @sender, not the well-known name
3884 * as one would expect. This is because the message bus rewrites the
3885 * name. As such, to avoid certain race conditions, users should be
3886 * tracking the name owner of the well-known name and use that when
3887 * processing the received signal.
3889 * If one of %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE or
3890 * %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH are given, @arg0 is
3891 * interpreted as part of a namespace or path. The first argument
3892 * of a signal is matched against that part as specified by D-Bus.
3894 * Returns: a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe()
3899 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
3900 const gchar *sender,
3901 const gchar *interface_name,
3902 const gchar *member,
3903 const gchar *object_path,
3905 GDBusSignalFlags flags,
3906 GDBusSignalCallback callback,
3908 GDestroyNotify user_data_free_func)
3911 SignalData *signal_data;
3912 SignalSubscriber subscriber;
3913 GPtrArray *signal_data_array;
3914 const gchar *sender_unique_name;
3916 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
3917 * an OOM condition. We might want to change that but that would involve making
3918 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
3919 * handle that. And there's really no sensible way of handling this short of retrying
3920 * to add the match rule... and then there's the little thing that, hey, maybe there's
3921 * a reason the bus in an OOM condition.
3923 * Doable, but not really sure it's worth it...
3926 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3927 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
3928 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
3929 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
3930 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
3931 g_return_val_if_fail (callback != NULL, 0);
3932 g_return_val_if_fail (check_initialized (connection), 0);
3933 g_return_val_if_fail (!((flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH) && (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)), 0);
3934 g_return_val_if_fail (!(arg0 == NULL && (flags & (G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH | G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE))), 0);
3936 CONNECTION_LOCK (connection);
3938 /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
3939 * with a '-' character to prefix the rule (which will otherwise be
3942 * This allows us to hash the rule and do our lifecycle tracking in
3943 * the usual way, but the '-' prevents the match rule from ever
3944 * actually being send to the bus (either for add or remove).
3946 rule = args_to_rule (sender, interface_name, member, object_path, arg0, flags);
3948 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
3949 sender_unique_name = sender;
3951 sender_unique_name = "";
3953 subscriber.callback = callback;
3954 subscriber.user_data = user_data;
3955 subscriber.user_data_free_func = user_data_free_func;
3956 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
3957 subscriber.context = g_main_context_ref_thread_default ();
3959 /* see if we've already have this rule */
3960 signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
3961 if (signal_data != NULL)
3963 g_array_append_val (signal_data->subscribers, subscriber);
3968 signal_data = g_new0 (SignalData, 1);
3969 signal_data->rule = rule;
3970 signal_data->sender = g_strdup (sender);
3971 signal_data->sender_unique_name = g_strdup (sender_unique_name);
3972 signal_data->interface_name = g_strdup (interface_name);
3973 signal_data->member = g_strdup (member);
3974 signal_data->object_path = g_strdup (object_path);
3975 signal_data->arg0 = g_strdup (arg0);
3976 signal_data->flags = flags;
3977 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3978 g_array_append_val (signal_data->subscribers, subscriber);
3980 g_hash_table_insert (connection->map_rule_to_signal_data,
3984 /* Add the match rule to the bus...
3986 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
3987 * always send such messages to us.
3989 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3991 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
3992 add_match_rule (connection, signal_data->rule);
3995 if (G_IS_KDBUS_CONNECTION (connection->stream))
3997 if (g_strcmp0 (signal_data->member, "NameAcquired") == 0)
3998 _g_kdbus_subscribe_name_acquired (connection, arg0);
3999 else if (g_strcmp0 (signal_data->member, "NameLost") == 0)
4000 _g_kdbus_subscribe_name_lost (connection, arg0);
4005 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
4006 signal_data->sender_unique_name);
4007 if (signal_data_array == NULL)
4009 signal_data_array = g_ptr_array_new ();
4010 g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
4011 g_strdup (signal_data->sender_unique_name),
4014 g_ptr_array_add (signal_data_array, signal_data);
4017 g_hash_table_insert (connection->map_id_to_signal_data,
4018 GUINT_TO_POINTER (subscriber.id),
4021 CONNECTION_UNLOCK (connection);
4023 return subscriber.id;
4026 /* ---------------------------------------------------------------------------------------------------- */
4028 /* called in any thread */
4029 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
4031 unsubscribe_id_internal (GDBusConnection *connection,
4032 guint subscription_id,
4033 GArray *out_removed_subscribers)
4035 SignalData *signal_data;
4036 GPtrArray *signal_data_array;
4039 signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
4040 GUINT_TO_POINTER (subscription_id));
4041 if (signal_data == NULL)
4043 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
4047 for (n = 0; n < signal_data->subscribers->len; n++)
4049 SignalSubscriber *subscriber;
4051 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
4052 if (subscriber->id != subscription_id)
4055 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
4056 GUINT_TO_POINTER (subscription_id)));
4057 g_array_append_val (out_removed_subscribers, *subscriber);
4058 g_array_remove_index (signal_data->subscribers, n);
4060 if (signal_data->subscribers->len == 0)
4062 g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
4064 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
4065 signal_data->sender_unique_name);
4066 g_warn_if_fail (signal_data_array != NULL);
4067 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
4069 if (signal_data_array->len == 0)
4071 g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
4072 signal_data->sender_unique_name));
4075 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
4076 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
4077 !is_signal_data_for_name_lost_or_acquired (signal_data) &&
4078 !g_dbus_connection_is_closed (connection) &&
4079 !connection->finalizing)
4081 /* The check for g_dbus_connection_is_closed() means that
4082 * sending the RemoveMatch message can't fail with
4083 * G_IO_ERROR_CLOSED, because we're holding the lock,
4084 * so on_worker_closed() can't happen between the check we just
4085 * did, and releasing the lock later.
4087 remove_match_rule (connection, signal_data->rule);
4091 if (G_IS_KDBUS_CONNECTION (connection->stream))
4093 //_g_kdbus_unsubscribe_name_lost_and_acquired (connection, arg0);
4097 signal_data_free (signal_data);
4103 g_assert_not_reached ();
4110 * g_dbus_connection_signal_unsubscribe:
4111 * @connection: a #GDBusConnection
4112 * @subscription_id: a subscription id obtained from
4113 * g_dbus_connection_signal_subscribe()
4115 * Unsubscribes from signals.
4120 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
4121 guint subscription_id)
4123 GArray *subscribers;
4126 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
4127 g_return_if_fail (check_initialized (connection));
4129 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4131 CONNECTION_LOCK (connection);
4132 unsubscribe_id_internal (connection,
4135 CONNECTION_UNLOCK (connection);
4138 g_assert (subscribers->len == 0 || subscribers->len == 1);
4140 /* call GDestroyNotify without lock held */
4141 for (n = 0; n < subscribers->len; n++)
4143 SignalSubscriber *subscriber;
4144 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
4145 call_destroy_notify (subscriber->context,
4146 subscriber->user_data_free_func,
4147 subscriber->user_data);
4148 g_main_context_unref (subscriber->context);
4151 g_array_free (subscribers, TRUE);
4154 /* ---------------------------------------------------------------------------------------------------- */
4158 guint subscription_id;
4159 GDBusSignalCallback callback;
4161 GDBusMessage *message;
4162 GDBusConnection *connection;
4163 const gchar *sender;
4165 const gchar *interface;
4166 const gchar *member;
4169 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
4173 emit_signal_instance_in_idle_cb (gpointer data)
4175 SignalInstance *signal_instance = data;
4176 GVariant *parameters;
4177 gboolean has_subscription;
4179 parameters = g_dbus_message_get_body (signal_instance->message);
4180 if (parameters == NULL)
4182 parameters = g_variant_new ("()");
4183 g_variant_ref_sink (parameters);
4187 g_variant_ref (parameters);
4191 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
4192 signal_instance->subscription_id,
4193 signal_instance->sender,
4194 signal_instance->path,
4195 signal_instance->interface,
4196 signal_instance->member,
4197 g_variant_print (parameters, TRUE));
4200 /* Careful here, don't do the callback if we no longer has the subscription */
4201 CONNECTION_LOCK (signal_instance->connection);
4202 has_subscription = FALSE;
4203 if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
4204 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
4205 has_subscription = TRUE;
4206 CONNECTION_UNLOCK (signal_instance->connection);
4208 if (has_subscription)
4209 signal_instance->callback (signal_instance->connection,
4210 signal_instance->sender,
4211 signal_instance->path,
4212 signal_instance->interface,
4213 signal_instance->member,
4215 signal_instance->user_data);
4217 g_variant_unref (parameters);
4223 signal_instance_free (SignalInstance *signal_instance)
4225 g_object_unref (signal_instance->message);
4226 g_object_unref (signal_instance->connection);
4227 g_free (signal_instance);
4231 namespace_rule_matches (const gchar *namespace,
4237 len_namespace = strlen (namespace);
4238 len_name = strlen (name);
4240 if (len_name < len_namespace)
4243 if (memcmp (namespace, name, len_namespace) != 0)
4246 return len_namespace == len_name || name[len_namespace] == '.';
4250 path_rule_matches (const gchar *path_a,
4251 const gchar *path_b)
4255 len_a = strlen (path_a);
4256 len_b = strlen (path_b);
4258 if (len_a < len_b && path_a[len_a - 1] != '/')
4261 if (len_b < len_a && path_b[len_b - 1] != '/')
4264 return memcmp (path_a, path_b, MIN (len_a, len_b)) == 0;
4267 /* called in GDBusWorker thread WITH lock held */
4269 schedule_callbacks (GDBusConnection *connection,
4270 GPtrArray *signal_data_array,
4271 GDBusMessage *message,
4272 const gchar *sender)
4275 const gchar *interface;
4276 const gchar *member;
4285 interface = g_dbus_message_get_interface (message);
4286 member = g_dbus_message_get_member (message);
4287 path = g_dbus_message_get_path (message);
4288 arg0 = g_dbus_message_get_arg0 (message);
4291 g_print ("In schedule_callbacks:\n"
4293 " interface = '%s'\n"
4304 /* TODO: if this is slow, then we can change signal_data_array into
4305 * map_object_path_to_signal_data_array or something.
4307 for (n = 0; n < signal_data_array->len; n++)
4309 SignalData *signal_data = signal_data_array->pdata[n];
4311 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
4314 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
4317 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
4320 if (signal_data->arg0 != NULL)
4325 if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
4327 if (!namespace_rule_matches (signal_data->arg0, arg0))
4330 else if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
4332 if (!path_rule_matches (signal_data->arg0, arg0))
4335 else if (!g_str_equal (signal_data->arg0, arg0))
4339 for (m = 0; m < signal_data->subscribers->len; m++)
4341 SignalSubscriber *subscriber;
4342 GSource *idle_source;
4343 SignalInstance *signal_instance;
4345 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
4347 signal_instance = g_new0 (SignalInstance, 1);
4348 signal_instance->subscription_id = subscriber->id;
4349 signal_instance->callback = subscriber->callback;
4350 signal_instance->user_data = subscriber->user_data;
4351 signal_instance->message = g_object_ref (message);
4352 signal_instance->connection = g_object_ref (connection);
4353 signal_instance->sender = sender;
4354 signal_instance->path = path;
4355 signal_instance->interface = interface;
4356 signal_instance->member = member;
4358 idle_source = g_idle_source_new ();
4359 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4360 g_source_set_callback (idle_source,
4361 emit_signal_instance_in_idle_cb,
4363 (GDestroyNotify) signal_instance_free);
4364 g_source_set_name (idle_source, "[gio] emit_signal_instance_in_idle_cb");
4365 g_source_attach (idle_source, subscriber->context);
4366 g_source_unref (idle_source);
4371 /* called in GDBusWorker thread with lock held */
4373 distribute_signals (GDBusConnection *connection,
4374 GDBusMessage *message)
4376 GPtrArray *signal_data_array;
4377 const gchar *sender;
4379 sender = g_dbus_message_get_sender (message);
4381 if (G_UNLIKELY (_g_dbus_debug_signal ()))
4383 _g_dbus_debug_print_lock ();
4384 g_print ("========================================================================\n"
4385 "GDBus-debug:Signal:\n"
4386 " <<<< RECEIVED SIGNAL %s.%s\n"
4388 " sent by name %s\n",
4389 g_dbus_message_get_interface (message),
4390 g_dbus_message_get_member (message),
4391 g_dbus_message_get_path (message),
4392 sender != NULL ? sender : "(none)");
4393 _g_dbus_debug_print_unlock ();
4396 /* collect subscribers that match on sender */
4399 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
4400 if (signal_data_array != NULL)
4401 schedule_callbacks (connection, signal_data_array, message, sender);
4404 /* collect subscribers not matching on sender */
4405 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
4406 if (signal_data_array != NULL)
4407 schedule_callbacks (connection, signal_data_array, message, sender);
4410 /* ---------------------------------------------------------------------------------------------------- */
4412 /* only called from finalize(), removes all subscriptions */
4414 purge_all_signal_subscriptions (GDBusConnection *connection)
4416 GHashTableIter iter;
4419 GArray *subscribers;
4422 ids = g_array_new (FALSE, FALSE, sizeof (guint));
4423 g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
4424 while (g_hash_table_iter_next (&iter, &key, NULL))
4426 guint subscription_id = GPOINTER_TO_UINT (key);
4427 g_array_append_val (ids, subscription_id);
4430 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
4431 for (n = 0; n < ids->len; n++)
4433 guint subscription_id = g_array_index (ids, guint, n);
4434 unsubscribe_id_internal (connection,
4438 g_array_free (ids, TRUE);
4440 /* call GDestroyNotify without lock held */
4441 for (n = 0; n < subscribers->len; n++)
4443 SignalSubscriber *subscriber;
4444 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
4445 call_destroy_notify (subscriber->context,
4446 subscriber->user_data_free_func,
4447 subscriber->user_data);
4448 g_main_context_unref (subscriber->context);
4451 g_array_free (subscribers, TRUE);
4454 /* ---------------------------------------------------------------------------------------------------- */
4456 static GDBusInterfaceVTable *
4457 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
4459 /* Don't waste memory by copying padding - remember to update this
4460 * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
4462 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
4466 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
4471 /* ---------------------------------------------------------------------------------------------------- */
4473 static GDBusSubtreeVTable *
4474 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
4476 /* Don't waste memory by copying padding - remember to update this
4477 * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
4479 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
4483 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
4488 /* ---------------------------------------------------------------------------------------------------- */
4490 struct ExportedObject
4493 GDBusConnection *connection;
4495 /* maps gchar* -> ExportedInterface* */
4496 GHashTable *map_if_name_to_ei;
4499 /* only called with lock held */
4501 exported_object_free (ExportedObject *eo)
4503 g_free (eo->object_path);
4504 g_hash_table_unref (eo->map_if_name_to_ei);
4513 gchar *interface_name;
4514 GDBusInterfaceVTable *vtable;
4515 GDBusInterfaceInfo *interface_info;
4517 GMainContext *context;
4519 GDestroyNotify user_data_free_func;
4520 } ExportedInterface;
4522 /* called with lock held */
4524 exported_interface_free (ExportedInterface *ei)
4526 g_dbus_interface_info_cache_release (ei->interface_info);
4527 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
4529 call_destroy_notify (ei->context,
4530 ei->user_data_free_func,
4533 g_main_context_unref (ei->context);
4535 g_free (ei->interface_name);
4536 _g_dbus_interface_vtable_free (ei->vtable);
4540 /* ---------------------------------------------------------------------------------------------------- */
4542 /* Convenience function to check if @registration_id (if not zero) or
4543 * @subtree_registration_id (if not zero) has been unregistered. If
4544 * so, returns %TRUE.
4546 * May be called by any thread. Caller must *not* hold lock.
4549 has_object_been_unregistered (GDBusConnection *connection,
4550 guint registration_id,
4551 guint subtree_registration_id)
4555 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4559 CONNECTION_LOCK (connection);
4560 if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
4561 GUINT_TO_POINTER (registration_id)) == NULL)
4565 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
4566 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
4570 CONNECTION_UNLOCK (connection);
4575 /* ---------------------------------------------------------------------------------------------------- */
4579 GDBusConnection *connection;
4580 GDBusMessage *message;
4582 const gchar *property_name;
4583 const GDBusInterfaceVTable *vtable;
4584 GDBusInterfaceInfo *interface_info;
4585 const GDBusPropertyInfo *property_info;
4586 guint registration_id;
4587 guint subtree_registration_id;
4591 property_data_free (PropertyData *data)
4593 g_object_unref (data->connection);
4594 g_object_unref (data->message);
4598 /* called in thread where object was registered - no locks held */
4600 invoke_get_property_in_idle_cb (gpointer _data)
4602 PropertyData *data = _data;
4605 GDBusMessage *reply;
4607 if (has_object_been_unregistered (data->connection,
4608 data->registration_id,
4609 data->subtree_registration_id))
4611 reply = g_dbus_message_new_method_error (data->message,
4612 "org.freedesktop.DBus.Error.UnknownMethod",
4613 _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
4614 g_dbus_message_get_path (data->message));
4615 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4616 g_object_unref (reply);
4621 value = data->vtable->get_property (data->connection,
4622 g_dbus_message_get_sender (data->message),
4623 g_dbus_message_get_path (data->message),
4624 data->interface_info->name,
4625 data->property_name,
4632 g_assert_no_error (error);
4634 g_variant_take_ref (value);
4635 reply = g_dbus_message_new_method_reply (data->message);
4636 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
4637 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4638 g_variant_unref (value);
4639 g_object_unref (reply);
4643 gchar *dbus_error_name;
4644 g_assert (error != NULL);
4645 dbus_error_name = g_dbus_error_encode_gerror (error);
4646 reply = g_dbus_message_new_method_error_literal (data->message,
4649 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4650 g_free (dbus_error_name);
4651 g_error_free (error);
4652 g_object_unref (reply);
4659 /* called in thread where object was registered - no locks held */
4661 invoke_set_property_in_idle_cb (gpointer _data)
4663 PropertyData *data = _data;
4665 GDBusMessage *reply;
4671 g_variant_get (g_dbus_message_get_body (data->message),
4677 if (!data->vtable->set_property (data->connection,
4678 g_dbus_message_get_sender (data->message),
4679 g_dbus_message_get_path (data->message),
4680 data->interface_info->name,
4681 data->property_name,
4686 gchar *dbus_error_name;
4687 g_assert (error != NULL);
4688 dbus_error_name = g_dbus_error_encode_gerror (error);
4689 reply = g_dbus_message_new_method_error_literal (data->message,
4692 g_free (dbus_error_name);
4693 g_error_free (error);
4697 reply = g_dbus_message_new_method_reply (data->message);
4700 g_assert (reply != NULL);
4701 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4702 g_object_unref (reply);
4703 g_variant_unref (value);
4708 /* called in any thread with connection's lock held */
4710 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
4711 GDBusMessage *message,
4712 guint registration_id,
4713 guint subtree_registration_id,
4715 GDBusInterfaceInfo *interface_info,
4716 const GDBusInterfaceVTable *vtable,
4717 GMainContext *main_context,
4721 const char *interface_name;
4722 const char *property_name;
4723 const GDBusPropertyInfo *property_info;
4724 GSource *idle_source;
4725 PropertyData *property_data;
4726 GDBusMessage *reply;
4731 g_variant_get (g_dbus_message_get_body (message),
4736 g_variant_get (g_dbus_message_get_body (message),
4745 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
4747 property_info = NULL;
4749 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4750 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
4751 if (property_info == NULL)
4753 reply = g_dbus_message_new_method_error (message,
4754 "org.freedesktop.DBus.Error.InvalidArgs",
4755 _("No such property '%s'"),
4757 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4758 g_object_unref (reply);
4763 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4765 reply = g_dbus_message_new_method_error (message,
4766 "org.freedesktop.DBus.Error.InvalidArgs",
4767 _("Property '%s' is not readable"),
4769 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4770 g_object_unref (reply);
4774 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
4776 reply = g_dbus_message_new_method_error (message,
4777 "org.freedesktop.DBus.Error.InvalidArgs",
4778 _("Property '%s' is not writable"),
4780 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4781 g_object_unref (reply);
4790 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
4791 * of the given value is wrong
4793 g_variant_get_child (g_dbus_message_get_body (message), 2, "v", &value);
4794 if (g_strcmp0 (g_variant_get_type_string (value), property_info->signature) != 0)
4796 reply = g_dbus_message_new_method_error (message,
4797 "org.freedesktop.DBus.Error.InvalidArgs",
4798 _("Error setting property '%s': Expected type '%s' but got '%s'"),
4799 property_name, property_info->signature,
4800 g_variant_get_type_string (value));
4801 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4802 g_variant_unref (value);
4803 g_object_unref (reply);
4808 g_variant_unref (value);
4811 /* If the vtable pointer for get_property() resp. set_property() is
4812 * NULL then dispatch the call via the method_call() handler.
4816 if (vtable->get_property == NULL)
4818 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4819 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4820 vtable, main_context, user_data);
4827 if (vtable->set_property == NULL)
4829 schedule_method_call (connection, message, registration_id, subtree_registration_id,
4830 interface_info, NULL, property_info, g_dbus_message_get_body (message),
4831 vtable, main_context, user_data);
4837 /* ok, got the property info - call user code in an idle handler */
4838 property_data = g_new0 (PropertyData, 1);
4839 property_data->connection = g_object_ref (connection);
4840 property_data->message = g_object_ref (message);
4841 property_data->user_data = user_data;
4842 property_data->property_name = property_name;
4843 property_data->vtable = vtable;
4844 property_data->interface_info = interface_info;
4845 property_data->property_info = property_info;
4846 property_data->registration_id = registration_id;
4847 property_data->subtree_registration_id = subtree_registration_id;
4849 idle_source = g_idle_source_new ();
4850 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4851 g_source_set_callback (idle_source,
4852 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
4854 (GDestroyNotify) property_data_free);
4856 g_source_set_name (idle_source, "[gio] invoke_get_property_in_idle_cb");
4858 g_source_set_name (idle_source, "[gio] invoke_set_property_in_idle_cb");
4859 g_source_attach (idle_source, main_context);
4860 g_source_unref (idle_source);
4868 /* called in GDBusWorker thread with connection's lock held */
4870 handle_getset_property (GDBusConnection *connection,
4872 GDBusMessage *message,
4875 ExportedInterface *ei;
4877 const char *interface_name;
4878 const char *property_name;
4883 g_variant_get (g_dbus_message_get_body (message),
4888 g_variant_get (g_dbus_message_get_body (message),
4894 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4895 * no such interface registered
4897 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4900 GDBusMessage *reply;
4901 reply = g_dbus_message_new_method_error (message,
4902 "org.freedesktop.DBus.Error.InvalidArgs",
4903 _("No such interface '%s'"),
4905 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4906 g_object_unref (reply);
4911 handled = validate_and_maybe_schedule_property_getset (eo->connection,
4924 /* ---------------------------------------------------------------------------------------------------- */
4928 GDBusConnection *connection;
4929 GDBusMessage *message;
4931 const GDBusInterfaceVTable *vtable;
4932 GDBusInterfaceInfo *interface_info;
4933 guint registration_id;
4934 guint subtree_registration_id;
4935 } PropertyGetAllData;
4938 property_get_all_data_free (PropertyData *data)
4940 g_object_unref (data->connection);
4941 g_object_unref (data->message);
4945 /* called in thread where object was registered - no locks held */
4947 invoke_get_all_properties_in_idle_cb (gpointer _data)
4949 PropertyGetAllData *data = _data;
4950 GVariantBuilder builder;
4951 GDBusMessage *reply;
4954 if (has_object_been_unregistered (data->connection,
4955 data->registration_id,
4956 data->subtree_registration_id))
4958 reply = g_dbus_message_new_method_error (data->message,
4959 "org.freedesktop.DBus.Error.UnknownMethod",
4960 _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
4961 g_dbus_message_get_path (data->message));
4962 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4963 g_object_unref (reply);
4967 /* TODO: Right now we never fail this call - we just omit values if
4968 * a get_property() call is failing.
4970 * We could fail the whole call if just a single get_property() call
4971 * returns an error. We need clarification in the D-Bus spec about this.
4973 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
4974 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
4975 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
4977 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
4980 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4983 value = data->vtable->get_property (data->connection,
4984 g_dbus_message_get_sender (data->message),
4985 g_dbus_message_get_path (data->message),
4986 data->interface_info->name,
4987 property_info->name,
4994 g_variant_take_ref (value);
4995 g_variant_builder_add (&builder,
4997 property_info->name,
4999 g_variant_unref (value);
5001 g_variant_builder_close (&builder);
5003 reply = g_dbus_message_new_method_reply (data->message);
5004 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
5005 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5006 g_object_unref (reply);
5013 interface_has_readable_properties (GDBusInterfaceInfo *interface_info)
5017 if (!interface_info->properties)
5020 for (i = 0; interface_info->properties[i]; i++)
5021 if (interface_info->properties[i]->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)
5027 /* called in any thread with connection's lock held */
5029 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
5030 GDBusMessage *message,
5031 guint registration_id,
5032 guint subtree_registration_id,
5033 GDBusInterfaceInfo *interface_info,
5034 const GDBusInterfaceVTable *vtable,
5035 GMainContext *main_context,
5039 GSource *idle_source;
5040 PropertyGetAllData *property_get_all_data;
5047 /* If the vtable pointer for get_property() is NULL but we have a
5048 * non-zero number of readable properties, then dispatch the call via
5049 * the method_call() handler.
5051 if (vtable->get_property == NULL && interface_has_readable_properties (interface_info))
5053 schedule_method_call (connection, message, registration_id, subtree_registration_id,
5054 interface_info, NULL, NULL, g_dbus_message_get_body (message),
5055 vtable, main_context, user_data);
5060 /* ok, got the property info - call user in an idle handler */
5061 property_get_all_data = g_new0 (PropertyGetAllData, 1);
5062 property_get_all_data->connection = g_object_ref (connection);
5063 property_get_all_data->message = g_object_ref (message);
5064 property_get_all_data->user_data = user_data;
5065 property_get_all_data->vtable = vtable;
5066 property_get_all_data->interface_info = interface_info;
5067 property_get_all_data->registration_id = registration_id;
5068 property_get_all_data->subtree_registration_id = subtree_registration_id;
5070 idle_source = g_idle_source_new ();
5071 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
5072 g_source_set_callback (idle_source,
5073 invoke_get_all_properties_in_idle_cb,
5074 property_get_all_data,
5075 (GDestroyNotify) property_get_all_data_free);
5076 g_source_set_name (idle_source, "[gio] invoke_get_all_properties_in_idle_cb");
5077 g_source_attach (idle_source, main_context);
5078 g_source_unref (idle_source);
5086 /* called in GDBusWorker thread with connection's lock held */
5088 handle_get_all_properties (GDBusConnection *connection,
5090 GDBusMessage *message)
5092 ExportedInterface *ei;
5094 const char *interface_name;
5098 g_variant_get (g_dbus_message_get_body (message),
5102 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
5103 * no such interface registered
5105 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
5108 GDBusMessage *reply;
5109 reply = g_dbus_message_new_method_error (message,
5110 "org.freedesktop.DBus.Error.InvalidArgs",
5111 _("No such interface"),
5113 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5114 g_object_unref (reply);
5119 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
5131 /* ---------------------------------------------------------------------------------------------------- */
5133 static const gchar introspect_header[] =
5134 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
5135 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
5136 "<!-- GDBus " PACKAGE_VERSION " -->\n"
5139 static const gchar introspect_tail[] =
5142 static const gchar introspect_properties_interface[] =
5143 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
5144 " <method name=\"Get\">\n"
5145 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5146 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
5147 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
5149 " <method name=\"GetAll\">\n"
5150 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5151 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
5153 " <method name=\"Set\">\n"
5154 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
5155 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
5156 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
5158 " <signal name=\"PropertiesChanged\">\n"
5159 " <arg type=\"s\" name=\"interface_name\"/>\n"
5160 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
5161 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
5165 static const gchar introspect_introspectable_interface[] =
5166 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
5167 " <method name=\"Introspect\">\n"
5168 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
5171 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
5172 " <method name=\"Ping\"/>\n"
5173 " <method name=\"GetMachineId\">\n"
5174 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
5179 introspect_append_header (GString *s)
5181 g_string_append (s, introspect_header);
5185 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
5187 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
5193 begin = object_path + path_len;
5194 end = strchr (begin, '/');
5196 s = g_strndup (begin, end - begin);
5198 s = g_strdup (begin);
5200 if (g_hash_table_lookup (set, s) == NULL)
5201 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
5207 /* TODO: we want a nicer public interface for this */
5208 /* called in any thread with connection's lock held */
5210 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
5215 GHashTableIter hash_iter;
5216 const gchar *object_path;
5222 CONNECTION_ENSURE_LOCK (connection);
5224 path_len = strlen (path);
5228 set = g_hash_table_new (g_str_hash, g_str_equal);
5230 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
5231 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
5232 maybe_add_path (path, path_len, object_path, set);
5234 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
5235 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
5236 maybe_add_path (path, path_len, object_path, set);
5238 p = g_ptr_array_new ();
5239 keys = g_hash_table_get_keys (set);
5240 for (l = keys; l != NULL; l = l->next)
5241 g_ptr_array_add (p, l->data);
5242 g_hash_table_unref (set);
5245 g_ptr_array_add (p, NULL);
5246 ret = (gchar **) g_ptr_array_free (p, FALSE);
5250 /* called in any thread with connection's lock not held */
5252 g_dbus_connection_list_registered (GDBusConnection *connection,
5256 CONNECTION_LOCK (connection);
5257 ret = g_dbus_connection_list_registered_unlocked (connection, path);
5258 CONNECTION_UNLOCK (connection);
5262 /* called in GDBusWorker thread with connection's lock held */
5264 handle_introspect (GDBusConnection *connection,
5266 GDBusMessage *message)
5270 GDBusMessage *reply;
5271 GHashTableIter hash_iter;
5272 ExportedInterface *ei;
5275 /* first the header with the standard interfaces */
5276 s = g_string_sized_new (sizeof (introspect_header) +
5277 sizeof (introspect_properties_interface) +
5278 sizeof (introspect_introspectable_interface) +
5279 sizeof (introspect_tail));
5280 introspect_append_header (s);
5281 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
5282 "org.freedesktop.DBus.Properties"))
5283 g_string_append (s, introspect_properties_interface);
5285 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
5286 "org.freedesktop.DBus.Introspectable"))
5287 g_string_append (s, introspect_introspectable_interface);
5289 /* then include the registered interfaces */
5290 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
5291 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
5292 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
5294 /* finally include nodes registered below us */
5295 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
5296 for (n = 0; registered != NULL && registered[n] != NULL; n++)
5297 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
5298 g_strfreev (registered);
5299 g_string_append (s, introspect_tail);
5301 reply = g_dbus_message_new_method_reply (message);
5302 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5303 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5304 g_object_unref (reply);
5305 g_string_free (s, TRUE);
5310 /* called in thread where object was registered - no locks held */
5312 call_in_idle_cb (gpointer user_data)
5314 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
5315 GDBusInterfaceVTable *vtable;
5316 guint registration_id;
5317 guint subtree_registration_id;
5319 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
5320 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
5322 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
5324 subtree_registration_id))
5326 GDBusMessage *reply;
5327 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
5328 "org.freedesktop.DBus.Error.UnknownMethod",
5329 _("No such interface '%s' on object at path %s"),
5330 g_dbus_method_invocation_get_interface_name (invocation),
5331 g_dbus_method_invocation_get_object_path (invocation));
5332 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5333 g_object_unref (reply);
5337 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
5338 g_assert (vtable != NULL && vtable->method_call != NULL);
5340 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
5341 g_dbus_method_invocation_get_sender (invocation),
5342 g_dbus_method_invocation_get_object_path (invocation),
5343 g_dbus_method_invocation_get_interface_name (invocation),
5344 g_dbus_method_invocation_get_method_name (invocation),
5345 g_dbus_method_invocation_get_parameters (invocation),
5346 g_object_ref (invocation),
5347 g_dbus_method_invocation_get_user_data (invocation));
5353 /* called in GDBusWorker thread with connection's lock held */
5355 schedule_method_call (GDBusConnection *connection,
5356 GDBusMessage *message,
5357 guint registration_id,
5358 guint subtree_registration_id,
5359 const GDBusInterfaceInfo *interface_info,
5360 const GDBusMethodInfo *method_info,
5361 const GDBusPropertyInfo *property_info,
5362 GVariant *parameters,
5363 const GDBusInterfaceVTable *vtable,
5364 GMainContext *main_context,
5367 GDBusMethodInvocation *invocation;
5368 GSource *idle_source;
5370 invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
5371 g_dbus_message_get_path (message),
5372 g_dbus_message_get_interface (message),
5373 g_dbus_message_get_member (message),
5381 /* TODO: would be nicer with a real MethodData like we already
5382 * have PropertyData and PropertyGetAllData... */
5383 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
5384 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
5385 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
5387 idle_source = g_idle_source_new ();
5388 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
5389 g_source_set_callback (idle_source,
5393 g_source_set_name (idle_source, "[gio] call_in_idle_cb");
5394 g_source_attach (idle_source, main_context);
5395 g_source_unref (idle_source);
5398 /* called in GDBusWorker thread with connection's lock held */
5400 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
5401 GDBusMessage *message,
5402 guint registration_id,
5403 guint subtree_registration_id,
5404 GDBusInterfaceInfo *interface_info,
5405 const GDBusInterfaceVTable *vtable,
5406 GMainContext *main_context,
5409 GDBusMethodInfo *method_info;
5410 GDBusMessage *reply;
5411 GVariant *parameters;
5413 GVariantType *in_type;
5417 /* TODO: the cost of this is O(n) - it might be worth caching the result */
5418 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
5420 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
5421 * error to the caller
5423 if (method_info == NULL)
5425 reply = g_dbus_message_new_method_error (message,
5426 "org.freedesktop.DBus.Error.UnknownMethod",
5427 _("No such method '%s'"),
5428 g_dbus_message_get_member (message));
5429 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5430 g_object_unref (reply);
5435 parameters = g_dbus_message_get_body (message);
5436 if (parameters == NULL)
5438 parameters = g_variant_new ("()");
5439 g_variant_ref_sink (parameters);
5443 g_variant_ref (parameters);
5446 /* Check that the incoming args are of the right type - if they are not, return
5447 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
5449 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
5450 if (!g_variant_is_of_type (parameters, in_type))
5454 type_string = g_variant_type_dup_string (in_type);
5456 reply = g_dbus_message_new_method_error (message,
5457 "org.freedesktop.DBus.Error.InvalidArgs",
5458 _("Type of message, '%s', does not match expected type '%s'"),
5459 g_variant_get_type_string (parameters),
5461 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5462 g_variant_type_free (in_type);
5463 g_variant_unref (parameters);
5464 g_object_unref (reply);
5465 g_free (type_string);
5469 g_variant_type_free (in_type);
5471 /* schedule the call in idle */
5472 schedule_method_call (connection, message, registration_id, subtree_registration_id,
5473 interface_info, method_info, NULL, parameters,
5474 vtable, main_context, user_data);
5475 g_variant_unref (parameters);
5482 /* ---------------------------------------------------------------------------------------------------- */
5484 /* called in GDBusWorker thread with connection's lock held */
5486 obj_message_func (GDBusConnection *connection,
5488 GDBusMessage *message)
5490 const gchar *interface_name;
5491 const gchar *member;
5492 const gchar *signature;
5497 interface_name = g_dbus_message_get_interface (message);
5498 member = g_dbus_message_get_member (message);
5499 signature = g_dbus_message_get_signature (message);
5501 /* see if we have an interface for handling this call */
5502 if (interface_name != NULL)
5504 ExportedInterface *ei;
5505 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
5508 /* we do - invoke the handler in idle in the right thread */
5510 /* handle no vtable or handler being present */
5511 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
5514 handled = validate_and_maybe_schedule_method_call (connection,
5526 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
5527 g_strcmp0 (member, "Introspect") == 0 &&
5528 g_strcmp0 (signature, "") == 0)
5530 handled = handle_introspect (connection, eo, message);
5533 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5534 g_strcmp0 (member, "Get") == 0 &&
5535 g_strcmp0 (signature, "ss") == 0)
5537 handled = handle_getset_property (connection, eo, message, TRUE);
5540 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5541 g_strcmp0 (member, "Set") == 0 &&
5542 g_strcmp0 (signature, "ssv") == 0)
5544 handled = handle_getset_property (connection, eo, message, FALSE);
5547 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
5548 g_strcmp0 (member, "GetAll") == 0 &&
5549 g_strcmp0 (signature, "s") == 0)
5551 handled = handle_get_all_properties (connection, eo, message);
5560 * g_dbus_connection_register_object:
5561 * @connection: a #GDBusConnection
5562 * @object_path: the object path to register at
5563 * @interface_info: introspection data for the interface
5564 * @vtable: (allow-none): a #GDBusInterfaceVTable to call into or %NULL
5565 * @user_data: (allow-none): data to pass to functions in @vtable
5566 * @user_data_free_func: function to call when the object path is unregistered
5567 * @error: return location for error or %NULL
5569 * Registers callbacks for exported objects at @object_path with the
5570 * D-Bus interface that is described in @interface_info.
5572 * Calls to functions in @vtable (and @user_data_free_func) will happen
5574 * [thread-default main context][g-main-context-push-thread-default]
5575 * of the thread you are calling this method from.
5577 * Note that all #GVariant values passed to functions in @vtable will match
5578 * the signature given in @interface_info - if a remote caller passes
5579 * incorrect values, the `org.freedesktop.DBus.Error.InvalidArgs`
5580 * is returned to the remote caller.
5582 * Additionally, if the remote caller attempts to invoke methods or
5583 * access properties not mentioned in @interface_info the
5584 * `org.freedesktop.DBus.Error.UnknownMethod` resp.
5585 * `org.freedesktop.DBus.Error.InvalidArgs` errors
5586 * are returned to the caller.
5588 * It is considered a programming error if the
5589 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
5590 * #GVariant of incorrect type.
5592 * If an existing callback is already registered at @object_path and
5593 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
5595 * GDBus automatically implements the standard D-Bus interfaces
5596 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
5597 * and org.freedesktop.Peer, so you don't have to implement those for the
5598 * objects you export. You can implement org.freedesktop.DBus.Properties
5599 * yourself, e.g. to handle getting and setting of properties asynchronously.
5601 * Note that the reference count on @interface_info will be
5602 * incremented by 1 (unless allocated statically, e.g. if the
5603 * reference count is -1, see g_dbus_interface_info_ref()) for as long
5604 * as the object is exported. Also note that @vtable will be copied.
5606 * See this [server][gdbus-server] for an example of how to use this method.
5608 * Returns: 0 if @error is set, otherwise a registration id (never 0)
5609 * that can be used with g_dbus_connection_unregister_object()
5614 g_dbus_connection_register_object (GDBusConnection *connection,
5615 const gchar *object_path,
5616 GDBusInterfaceInfo *interface_info,
5617 const GDBusInterfaceVTable *vtable,
5619 GDestroyNotify user_data_free_func,
5623 ExportedInterface *ei;
5626 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
5627 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
5628 g_return_val_if_fail (interface_info != NULL, 0);
5629 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
5630 g_return_val_if_fail (error == NULL || *error == NULL, 0);
5631 g_return_val_if_fail (check_initialized (connection), 0);
5635 CONNECTION_LOCK (connection);
5637 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
5640 eo = g_new0 (ExportedObject, 1);
5641 eo->object_path = g_strdup (object_path);
5642 eo->connection = connection;
5643 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
5646 (GDestroyNotify) exported_interface_free);
5647 g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
5650 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
5656 _("An object is already exported for the interface %s at %s"),
5657 interface_info->name,
5662 ei = g_new0 (ExportedInterface, 1);
5663 ei->id = _global_registration_id++; /* TODO: overflow etc. */
5665 ei->user_data = user_data;
5666 ei->user_data_free_func = user_data_free_func;
5667 ei->vtable = _g_dbus_interface_vtable_copy (vtable);
5668 ei->interface_info = g_dbus_interface_info_ref (interface_info);
5669 g_dbus_interface_info_cache_build (ei->interface_info);
5670 ei->interface_name = g_strdup (interface_info->name);
5671 ei->context = g_main_context_ref_thread_default ();
5673 g_hash_table_insert (eo->map_if_name_to_ei,
5674 (gpointer) ei->interface_name,
5676 g_hash_table_insert (connection->map_id_to_ei,
5677 GUINT_TO_POINTER (ei->id),
5683 CONNECTION_UNLOCK (connection);
5689 * g_dbus_connection_unregister_object:
5690 * @connection: a #GDBusConnection
5691 * @registration_id: a registration id obtained from
5692 * g_dbus_connection_register_object()
5694 * Unregisters an object.
5696 * Returns: %TRUE if the object was unregistered, %FALSE otherwise
5701 g_dbus_connection_unregister_object (GDBusConnection *connection,
5702 guint registration_id)
5704 ExportedInterface *ei;
5708 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5709 g_return_val_if_fail (check_initialized (connection), FALSE);
5713 CONNECTION_LOCK (connection);
5715 ei = g_hash_table_lookup (connection->map_id_to_ei,
5716 GUINT_TO_POINTER (registration_id));
5722 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
5723 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
5724 /* unregister object path if we have no more exported interfaces */
5725 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
5726 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
5732 CONNECTION_UNLOCK (connection);
5737 /* ---------------------------------------------------------------------------------------------------- */
5740 * g_dbus_connection_emit_signal:
5741 * @connection: a #GDBusConnection
5742 * @destination_bus_name: (allow-none): the unique bus name for the destination
5743 * for the signal or %NULL to emit to all listeners
5744 * @object_path: path of remote object
5745 * @interface_name: D-Bus interface to emit a signal on
5746 * @signal_name: the name of the signal to emit
5747 * @parameters: (allow-none): a #GVariant tuple with parameters for the signal
5748 * or %NULL if not passing parameters
5749 * @error: Return location for error or %NULL
5753 * If the parameters GVariant is floating, it is consumed.
5755 * This can only fail if @parameters is not compatible with the D-Bus protocol.
5757 * Returns: %TRUE unless @error is set
5762 g_dbus_connection_emit_signal (GDBusConnection *connection,
5763 const gchar *destination_bus_name,
5764 const gchar *object_path,
5765 const gchar *interface_name,
5766 const gchar *signal_name,
5767 GVariant *parameters,
5770 GDBusMessage *message;
5776 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5777 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
5778 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
5779 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
5780 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
5781 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
5782 g_return_val_if_fail (check_initialized (connection), FALSE);
5784 if (G_UNLIKELY (_g_dbus_debug_emission ()))
5786 _g_dbus_debug_print_lock ();
5787 g_print ("========================================================================\n"
5788 "GDBus-debug:Emission:\n"
5789 " >>>> SIGNAL EMISSION %s.%s()\n"
5791 " destination %s\n",
5792 interface_name, signal_name,
5794 destination_bus_name != NULL ? destination_bus_name : "(none)");
5795 _g_dbus_debug_print_unlock ();
5798 message = g_dbus_message_new_signal (object_path,
5802 if (destination_bus_name != NULL)
5803 g_dbus_message_set_header (message,
5804 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
5805 g_variant_new_string (destination_bus_name));
5807 if (parameters != NULL)
5808 g_dbus_message_set_body (message, parameters);
5810 ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
5811 g_object_unref (message);
5817 add_call_flags (GDBusMessage *message,
5818 GDBusCallFlags flags)
5820 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
5821 g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
5825 decode_method_reply (GDBusMessage *reply,
5826 const gchar *method_name,
5827 const GVariantType *reply_type,
5828 GUnixFDList **out_fd_list,
5834 switch (g_dbus_message_get_message_type (reply))
5836 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
5837 result = g_dbus_message_get_body (reply);
5840 result = g_variant_new ("()");
5841 g_variant_ref_sink (result);
5845 g_variant_ref (result);
5848 if (!g_variant_is_of_type (result, reply_type))
5850 gchar *type_string = g_variant_type_dup_string (reply_type);
5854 G_IO_ERROR_INVALID_ARGUMENT,
5855 _("Method '%s' returned type '%s', but expected '%s'"),
5856 method_name, g_variant_get_type_string (result), type_string);
5858 g_variant_unref (result);
5859 g_free (type_string);
5866 if (out_fd_list != NULL)
5868 *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
5869 if (*out_fd_list != NULL)
5870 g_object_ref (*out_fd_list);
5876 case G_DBUS_MESSAGE_TYPE_ERROR:
5877 g_dbus_message_to_gerror (reply, error);
5881 g_assert_not_reached ();
5891 GSimpleAsyncResult *simple;
5892 GVariantType *reply_type;
5893 gchar *method_name; /* for error message */
5897 GUnixFDList *fd_list;
5901 call_state_free (CallState *state)
5903 g_variant_type_free (state->reply_type);
5904 g_free (state->method_name);
5906 if (state->value != NULL)
5907 g_variant_unref (state->value);
5908 if (state->fd_list != NULL)
5909 g_object_unref (state->fd_list);
5910 g_slice_free (CallState, state);
5913 /* called in any thread, with the connection's lock not held */
5915 g_dbus_connection_call_done (GObject *source,
5916 GAsyncResult *result,
5919 GSimpleAsyncResult *simple;
5920 GDBusConnection *connection = G_DBUS_CONNECTION (source);
5921 CallState *state = user_data;
5923 GDBusMessage *reply;
5926 reply = g_dbus_connection_send_message_with_reply_finish (connection,
5930 if (G_UNLIKELY (_g_dbus_debug_call ()))
5932 _g_dbus_debug_print_lock ();
5933 g_print ("========================================================================\n"
5934 "GDBus-debug:Call:\n"
5935 " <<<< ASYNC COMPLETE %s() (serial %d)\n"
5941 g_print ("SUCCESS\n");
5945 g_print ("FAILED: %s\n",
5948 _g_dbus_debug_print_unlock ();
5952 state->value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
5954 simple = state->simple; /* why? because state is freed before we unref simple.. */
5957 g_simple_async_result_take_error (state->simple, error);
5958 g_simple_async_result_complete (state->simple);
5959 call_state_free (state);
5963 g_simple_async_result_set_op_res_gpointer (state->simple, state, (GDestroyNotify) call_state_free);
5964 g_simple_async_result_complete (state->simple);
5966 g_clear_object (&reply);
5967 g_object_unref (simple);
5970 /* called in any thread, with the connection's lock not held */
5972 g_dbus_connection_call_internal (GDBusConnection *connection,
5973 const gchar *bus_name,
5974 const gchar *object_path,
5975 const gchar *interface_name,
5976 const gchar *method_name,
5977 GVariant *parameters,
5978 const GVariantType *reply_type,
5979 GDBusCallFlags flags,
5981 GUnixFDList *fd_list,
5982 GCancellable *cancellable,
5983 GAsyncReadyCallback callback,
5986 GDBusMessage *message;
5989 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
5990 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
5991 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
5992 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
5993 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
5994 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
5995 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
5996 g_return_if_fail (check_initialized (connection));
5998 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
6000 g_return_if_fail (fd_list == NULL);
6003 message = g_dbus_message_new_method_call (bus_name,
6007 add_call_flags (message, flags);
6008 if (parameters != NULL)
6009 g_dbus_message_set_body (message, parameters);
6012 if (fd_list != NULL)
6013 g_dbus_message_set_unix_fd_list (message, fd_list);
6016 /* If the user has no callback then we can just send the message with
6017 * the G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set and skip all
6018 * the logic for processing the reply. If the service sends the reply
6019 * anyway then it will just be ignored.
6021 if (callback != NULL)
6025 state = g_slice_new0 (CallState);
6026 state->simple = g_simple_async_result_new (G_OBJECT (connection),
6027 callback, user_data,
6028 g_dbus_connection_call_internal);
6029 g_simple_async_result_set_check_cancellable (state->simple, cancellable);
6030 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
6032 if (reply_type == NULL)
6033 reply_type = G_VARIANT_TYPE_ANY;
6035 state->reply_type = g_variant_type_copy (reply_type);
6037 g_dbus_connection_send_message_with_reply (connection,
6039 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
6043 g_dbus_connection_call_done,
6045 serial = state->serial;
6049 GDBusMessageFlags flags;
6051 flags = g_dbus_message_get_flags (message);
6052 flags |= G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
6053 g_dbus_message_set_flags (message, flags);
6055 g_dbus_connection_send_message (connection,
6057 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
6061 if (G_UNLIKELY (_g_dbus_debug_call ()))
6063 _g_dbus_debug_print_lock ();
6064 g_print ("========================================================================\n"
6065 "GDBus-debug:Call:\n"
6066 " >>>> ASYNC %s.%s()\n"
6068 " owned by name %s (serial %d)\n",
6072 bus_name != NULL ? bus_name : "(none)",
6074 _g_dbus_debug_print_unlock ();
6077 if (message != NULL)
6078 g_object_unref (message);
6081 /* called in any thread, with the connection's lock not held */
6083 g_dbus_connection_call_finish_internal (GDBusConnection *connection,
6084 GUnixFDList **out_fd_list,
6088 GSimpleAsyncResult *simple;
6091 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
6092 g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
6093 g_dbus_connection_call_internal), NULL);
6094 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6096 simple = G_SIMPLE_ASYNC_RESULT (res);
6098 if (g_simple_async_result_propagate_error (simple, error))
6101 state = g_simple_async_result_get_op_res_gpointer (simple);
6102 if (out_fd_list != NULL)
6103 *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
6104 return g_variant_ref (state->value);
6107 /* called in any user thread, with the connection's lock not held */
6109 g_dbus_connection_call_sync_internal (GDBusConnection *connection,
6110 const gchar *bus_name,
6111 const gchar *object_path,
6112 const gchar *interface_name,
6113 const gchar *method_name,
6114 GVariant *parameters,
6115 const GVariantType *reply_type,
6116 GDBusCallFlags flags,
6118 GUnixFDList *fd_list,
6119 GUnixFDList **out_fd_list,
6120 GCancellable *cancellable,
6123 GDBusMessage *message;
6124 GDBusMessage *reply;
6126 GError *local_error;
6127 GDBusSendMessageFlags send_flags;
6133 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
6134 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
6135 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
6136 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
6137 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
6138 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
6139 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
6141 g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
6143 g_return_val_if_fail (fd_list == NULL, NULL);
6145 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6147 if (!(flags & CALL_FLAGS_INITIALIZING))
6148 g_return_val_if_fail (check_initialized (connection), FALSE);
6150 if (reply_type == NULL)
6151 reply_type = G_VARIANT_TYPE_ANY;
6153 message = g_dbus_message_new_method_call (bus_name,
6157 add_call_flags (message, flags);
6158 if (parameters != NULL)
6159 g_dbus_message_set_body (message, parameters);
6162 if (fd_list != NULL)
6163 g_dbus_message_set_unix_fd_list (message, fd_list);
6166 if (G_UNLIKELY (_g_dbus_debug_call ()))
6168 _g_dbus_debug_print_lock ();
6169 g_print ("========================================================================\n"
6170 "GDBus-debug:Call:\n"
6171 " >>>> SYNC %s.%s()\n"
6173 " owned by name %s\n",
6177 bus_name != NULL ? bus_name : "(none)");
6178 _g_dbus_debug_print_unlock ();
6183 send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
6185 /* translate from one flavour of flags to another... */
6186 if (flags & CALL_FLAGS_INITIALIZING)
6187 send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
6189 reply = g_dbus_connection_send_message_with_reply_sync (connection,
6193 NULL, /* volatile guint32 *out_serial */
6197 if (G_UNLIKELY (_g_dbus_debug_call ()))
6199 _g_dbus_debug_print_lock ();
6200 g_print ("========================================================================\n"
6201 "GDBus-debug:Call:\n"
6202 " <<<< SYNC COMPLETE %s.%s()\n"
6208 g_print ("SUCCESS\n");
6212 g_print ("FAILED: %s\n",
6213 local_error->message);
6215 _g_dbus_debug_print_unlock ();
6221 *error = local_error;
6223 g_error_free (local_error);
6227 result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
6230 if (message != NULL)
6231 g_object_unref (message);
6233 g_object_unref (reply);
6238 /* ---------------------------------------------------------------------------------------------------- */
6241 * g_dbus_connection_call:
6242 * @connection: a #GDBusConnection
6243 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6244 * @connection is not a message bus connection
6245 * @object_path: path of remote object
6246 * @interface_name: D-Bus interface to invoke method on
6247 * @method_name: the name of the method to invoke
6248 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6249 * or %NULL if not passing parameters
6250 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6251 * @flags: flags from the #GDBusCallFlags enumeration
6252 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6253 * timeout or %G_MAXINT for no timeout
6254 * @cancellable: (allow-none): a #GCancellable or %NULL
6255 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
6256 * is satisfied or %NULL if you don't care about the result of the
6258 * @user_data: the data to pass to @callback
6260 * Asynchronously invokes the @method_name method on the
6261 * @interface_name D-Bus interface on the remote object at
6262 * @object_path owned by @bus_name.
6264 * If @connection is closed then the operation will fail with
6265 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
6266 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
6267 * not compatible with the D-Bus protocol, the operation fails with
6268 * %G_IO_ERROR_INVALID_ARGUMENT.
6270 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
6271 * error will be raised if it does not match. Said another way, if you give a @reply_type
6272 * then any non-%NULL return value will be of this type.
6274 * If the @parameters #GVariant is floating, it is consumed. This allows
6275 * convenient 'inline' use of g_variant_new(), e.g.:
6276 * |[<!-- language="C" -->
6277 * g_dbus_connection_call (connection,
6278 * "org.freedesktop.StringThings",
6279 * "/org/freedesktop/StringThings",
6280 * "org.freedesktop.StringThings",
6282 * g_variant_new ("(ss)",
6286 * G_DBUS_CALL_FLAGS_NONE,
6289 * (GAsyncReadyCallback) two_strings_done,
6293 * This is an asynchronous method. When the operation is finished,
6294 * @callback will be invoked in the
6295 * [thread-default main context][g-main-context-push-thread-default]
6296 * of the thread you are calling this method from. You can then call
6297 * g_dbus_connection_call_finish() to get the result of the operation.
6298 * See g_dbus_connection_call_sync() for the synchronous version of this
6301 * If @callback is %NULL then the D-Bus method call message will be sent with
6302 * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
6307 g_dbus_connection_call (GDBusConnection *connection,
6308 const gchar *bus_name,
6309 const gchar *object_path,
6310 const gchar *interface_name,
6311 const gchar *method_name,
6312 GVariant *parameters,
6313 const GVariantType *reply_type,
6314 GDBusCallFlags flags,
6316 GCancellable *cancellable,
6317 GAsyncReadyCallback callback,
6320 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);
6324 * g_dbus_connection_call_finish:
6325 * @connection: a #GDBusConnection
6326 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call()
6327 * @error: return location for error or %NULL
6329 * Finishes an operation started with g_dbus_connection_call().
6331 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6332 * return values. Free with g_variant_unref().
6337 g_dbus_connection_call_finish (GDBusConnection *connection,
6341 return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
6345 * g_dbus_connection_call_sync:
6346 * @connection: a #GDBusConnection
6347 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6348 * @connection is not a message bus connection
6349 * @object_path: path of remote object
6350 * @interface_name: D-Bus interface to invoke method on
6351 * @method_name: the name of the method to invoke
6352 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6353 * or %NULL if not passing parameters
6354 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6355 * @flags: flags from the #GDBusCallFlags enumeration
6356 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6357 * timeout or %G_MAXINT for no timeout
6358 * @cancellable: (allow-none): a #GCancellable or %NULL
6359 * @error: return location for error or %NULL
6361 * Synchronously invokes the @method_name method on the
6362 * @interface_name D-Bus interface on the remote object at
6363 * @object_path owned by @bus_name.
6365 * If @connection is closed then the operation will fail with
6366 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
6367 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
6368 * contains a value not compatible with the D-Bus protocol, the operation
6369 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
6371 * If @reply_type is non-%NULL then the reply will be checked for having
6372 * this type and an error will be raised if it does not match. Said
6373 * another way, if you give a @reply_type then any non-%NULL return
6374 * value will be of this type.
6376 * If the @parameters #GVariant is floating, it is consumed.
6377 * This allows convenient 'inline' use of g_variant_new(), e.g.:
6378 * |[<!-- language="C" -->
6379 * g_dbus_connection_call_sync (connection,
6380 * "org.freedesktop.StringThings",
6381 * "/org/freedesktop/StringThings",
6382 * "org.freedesktop.StringThings",
6384 * g_variant_new ("(ss)",
6388 * G_DBUS_CALL_FLAGS_NONE,
6394 * The calling thread is blocked until a reply is received. See
6395 * g_dbus_connection_call() for the asynchronous version of
6398 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6399 * return values. Free with g_variant_unref().
6404 g_dbus_connection_call_sync (GDBusConnection *connection,
6405 const gchar *bus_name,
6406 const gchar *object_path,
6407 const gchar *interface_name,
6408 const gchar *method_name,
6409 GVariant *parameters,
6410 const GVariantType *reply_type,
6411 GDBusCallFlags flags,
6413 GCancellable *cancellable,
6416 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);
6419 /* ---------------------------------------------------------------------------------------------------- */
6424 * g_dbus_connection_call_with_unix_fd_list:
6425 * @connection: a #GDBusConnection
6426 * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
6427 * @connection is not a message bus connection
6428 * @object_path: path of remote object
6429 * @interface_name: D-Bus interface to invoke method on
6430 * @method_name: the name of the method to invoke
6431 * @parameters: (allow-none): a #GVariant tuple with parameters for the method
6432 * or %NULL if not passing parameters
6433 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6434 * @flags: flags from the #GDBusCallFlags enumeration
6435 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6436 * timeout or %G_MAXINT for no timeout
6437 * @fd_list: (allow-none): a #GUnixFDList or %NULL
6438 * @cancellable: (allow-none): a #GCancellable or %NULL
6439 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
6440 * satisfied or %NULL if you don't * care about the result of the
6442 * @user_data: The data to pass to @callback.
6444 * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
6446 * This method is only available on UNIX.
6451 g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
6452 const gchar *bus_name,
6453 const gchar *object_path,
6454 const gchar *interface_name,
6455 const gchar *method_name,
6456 GVariant *parameters,
6457 const GVariantType *reply_type,
6458 GDBusCallFlags flags,
6460 GUnixFDList *fd_list,
6461 GCancellable *cancellable,
6462 GAsyncReadyCallback callback,
6465 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);
6469 * g_dbus_connection_call_with_unix_fd_list_finish:
6470 * @connection: a #GDBusConnection
6471 * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
6472 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
6473 * g_dbus_connection_call_with_unix_fd_list()
6474 * @error: return location for error or %NULL
6476 * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
6478 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6479 * return values. Free with g_variant_unref().
6484 g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
6485 GUnixFDList **out_fd_list,
6489 return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
6493 * g_dbus_connection_call_with_unix_fd_list_sync:
6494 * @connection: a #GDBusConnection
6495 * @bus_name: (allow-none): a unique or well-known bus name or %NULL
6496 * if @connection is not a message bus connection
6497 * @object_path: path of remote object
6498 * @interface_name: D-Bus interface to invoke method on
6499 * @method_name: the name of the method to invoke
6500 * @parameters: (allow-none): a #GVariant tuple with parameters for
6501 * the method or %NULL if not passing parameters
6502 * @reply_type: (allow-none): the expected type of the reply, or %NULL
6503 * @flags: flags from the #GDBusCallFlags enumeration
6504 * @timeout_msec: the timeout in milliseconds, -1 to use the default
6505 * timeout or %G_MAXINT for no timeout
6506 * @fd_list: (allow-none): a #GUnixFDList or %NULL
6507 * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
6508 * @cancellable: (allow-none): a #GCancellable or %NULL
6509 * @error: return location for error or %NULL
6511 * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
6513 * This method is only available on UNIX.
6515 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
6516 * return values. Free with g_variant_unref().
6521 g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
6522 const gchar *bus_name,
6523 const gchar *object_path,
6524 const gchar *interface_name,
6525 const gchar *method_name,
6526 GVariant *parameters,
6527 const GVariantType *reply_type,
6528 GDBusCallFlags flags,
6530 GUnixFDList *fd_list,
6531 GUnixFDList **out_fd_list,
6532 GCancellable *cancellable,
6535 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);
6538 #endif /* G_OS_UNIX */
6540 /* ---------------------------------------------------------------------------------------------------- */
6542 struct ExportedSubtree
6546 GDBusConnection *connection;
6547 GDBusSubtreeVTable *vtable;
6548 GDBusSubtreeFlags flags;
6550 GMainContext *context;
6552 GDestroyNotify user_data_free_func;
6556 exported_subtree_free (ExportedSubtree *es)
6558 call_destroy_notify (es->context,
6559 es->user_data_free_func,
6562 g_main_context_unref (es->context);
6564 _g_dbus_subtree_vtable_free (es->vtable);
6565 g_free (es->object_path);
6569 /* called without lock held in the thread where the caller registered
6573 handle_subtree_introspect (GDBusConnection *connection,
6574 ExportedSubtree *es,
6575 GDBusMessage *message)
6579 GDBusMessage *reply;
6582 const gchar *sender;
6583 const gchar *requested_object_path;
6584 const gchar *requested_node;
6585 GDBusInterfaceInfo **interfaces;
6587 gchar **subnode_paths;
6588 gboolean has_properties_interface;
6589 gboolean has_introspectable_interface;
6593 requested_object_path = g_dbus_message_get_path (message);
6594 sender = g_dbus_message_get_sender (message);
6595 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6597 s = g_string_new (NULL);
6598 introspect_append_header (s);
6600 /* Strictly we don't need the children in dynamic mode, but we avoid the
6601 * conditionals to preserve code clarity
6603 children = es->vtable->enumerate (es->connection,
6610 requested_node = strrchr (requested_object_path, '/') + 1;
6612 /* Assert existence of object if we are not dynamic */
6613 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
6614 !_g_strv_has_string ((const gchar * const *) children, requested_node))
6619 requested_node = NULL;
6622 interfaces = es->vtable->introspect (es->connection,
6627 if (interfaces != NULL)
6629 has_properties_interface = FALSE;
6630 has_introspectable_interface = FALSE;
6632 for (n = 0; interfaces[n] != NULL; n++)
6634 if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
6635 has_properties_interface = TRUE;
6636 else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
6637 has_introspectable_interface = TRUE;
6639 if (!has_properties_interface)
6640 g_string_append (s, introspect_properties_interface);
6641 if (!has_introspectable_interface)
6642 g_string_append (s, introspect_introspectable_interface);
6644 for (n = 0; interfaces[n] != NULL; n++)
6646 g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
6647 g_dbus_interface_info_unref (interfaces[n]);
6649 g_free (interfaces);
6652 /* then include <node> entries from the Subtree for the root */
6655 for (n = 0; children != NULL && children[n] != NULL; n++)
6656 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
6659 /* finally include nodes registered below us */
6660 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
6661 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
6662 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
6663 g_strfreev (subnode_paths);
6665 g_string_append (s, "</node>\n");
6667 reply = g_dbus_message_new_method_reply (message);
6668 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6669 g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6670 g_object_unref (reply);
6675 g_string_free (s, TRUE);
6676 g_strfreev (children);
6680 /* called without lock held in the thread where the caller registered
6684 handle_subtree_method_invocation (GDBusConnection *connection,
6685 ExportedSubtree *es,
6686 GDBusMessage *message)
6689 const gchar *sender;
6690 const gchar *interface_name;
6691 const gchar *member;
6692 const gchar *signature;
6693 const gchar *requested_object_path;
6694 const gchar *requested_node;
6696 GDBusInterfaceInfo *interface_info;
6697 const GDBusInterfaceVTable *interface_vtable;
6698 gpointer interface_user_data;
6700 GDBusInterfaceInfo **interfaces;
6701 gboolean is_property_get;
6702 gboolean is_property_set;
6703 gboolean is_property_get_all;
6708 requested_object_path = g_dbus_message_get_path (message);
6709 sender = g_dbus_message_get_sender (message);
6710 interface_name = g_dbus_message_get_interface (message);
6711 member = g_dbus_message_get_member (message);
6712 signature = g_dbus_message_get_signature (message);
6713 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6715 is_property_get = FALSE;
6716 is_property_set = FALSE;
6717 is_property_get_all = FALSE;
6718 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
6720 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
6721 is_property_get = TRUE;
6722 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
6723 is_property_set = TRUE;
6724 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
6725 is_property_get_all = TRUE;
6730 requested_node = strrchr (requested_object_path, '/') + 1;
6732 if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
6734 /* We don't want to dispatch to unenumerated
6735 * nodes, so ensure that the child exists.
6740 children = es->vtable->enumerate (es->connection,
6745 exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
6746 g_strfreev (children);
6754 requested_node = NULL;
6757 /* get introspection data for the node */
6758 interfaces = es->vtable->introspect (es->connection,
6760 requested_object_path,
6764 if (interfaces == NULL)
6767 interface_info = NULL;
6768 for (n = 0; interfaces[n] != NULL; n++)
6770 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6771 interface_info = interfaces[n];
6774 /* dispatch the call if the user wants to handle it */
6775 if (interface_info != NULL)
6777 /* figure out where to dispatch the method call */
6778 interface_user_data = NULL;
6779 interface_vtable = es->vtable->dispatch (es->connection,
6784 &interface_user_data,
6786 if (interface_vtable == NULL)
6789 CONNECTION_LOCK (connection);
6790 handled = validate_and_maybe_schedule_method_call (es->connection,
6797 interface_user_data);
6798 CONNECTION_UNLOCK (connection);
6800 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
6801 else if (is_property_get || is_property_set || is_property_get_all)
6803 if (is_property_get)
6804 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
6805 else if (is_property_set)
6806 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
6807 else if (is_property_get_all)
6808 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
6810 g_assert_not_reached ();
6812 /* see if the object supports this interface at all */
6813 for (n = 0; interfaces[n] != NULL; n++)
6815 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6816 interface_info = interfaces[n];
6819 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
6820 * claims it won't support the interface
6822 if (interface_info == NULL)
6824 GDBusMessage *reply;
6825 reply = g_dbus_message_new_method_error (message,
6826 "org.freedesktop.DBus.Error.InvalidArgs",
6827 _("No such interface '%s'"),
6829 g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6830 g_object_unref (reply);
6835 /* figure out where to dispatch the property get/set/getall calls */
6836 interface_user_data = NULL;
6837 interface_vtable = es->vtable->dispatch (es->connection,
6842 &interface_user_data,
6844 if (interface_vtable == NULL)
6846 g_warning ("The subtree introspection function indicates that '%s' "
6847 "is a valid interface name, but calling the dispatch "
6848 "function on that interface gave us NULL", interface_name);
6852 if (is_property_get || is_property_set)
6854 CONNECTION_LOCK (connection);
6855 handled = validate_and_maybe_schedule_property_getset (es->connection,
6863 interface_user_data);
6864 CONNECTION_UNLOCK (connection);
6866 else if (is_property_get_all)
6868 CONNECTION_LOCK (connection);
6869 handled = validate_and_maybe_schedule_property_get_all (es->connection,
6876 interface_user_data);
6877 CONNECTION_UNLOCK (connection);
6882 if (interfaces != NULL)
6884 for (n = 0; interfaces[n] != NULL; n++)
6885 g_dbus_interface_info_unref (interfaces[n]);
6886 g_free (interfaces);
6894 GDBusMessage *message;
6895 ExportedSubtree *es;
6896 } SubtreeDeferredData;
6899 subtree_deferred_data_free (SubtreeDeferredData *data)
6901 g_object_unref (data->message);
6905 /* called without lock held in the thread where the caller registered the subtree */
6907 process_subtree_vtable_message_in_idle_cb (gpointer _data)
6909 SubtreeDeferredData *data = _data;
6914 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
6915 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
6916 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
6917 handled = handle_subtree_introspect (data->es->connection,
6921 handled = handle_subtree_method_invocation (data->es->connection,
6927 CONNECTION_LOCK (data->es->connection);
6928 handled = handle_generic_unlocked (data->es->connection, data->message);
6929 CONNECTION_UNLOCK (data->es->connection);
6932 /* if we couldn't handle the request, just bail with the UnknownMethod error */
6935 GDBusMessage *reply;
6936 reply = g_dbus_message_new_method_error (data->message,
6937 "org.freedesktop.DBus.Error.UnknownMethod",
6938 _("Method '%s' on interface '%s' with signature '%s' does not exist"),
6939 g_dbus_message_get_member (data->message),
6940 g_dbus_message_get_interface (data->message),
6941 g_dbus_message_get_signature (data->message));
6942 g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6943 g_object_unref (reply);
6949 /* called in GDBusWorker thread with connection's lock held */
6951 subtree_message_func (GDBusConnection *connection,
6952 ExportedSubtree *es,
6953 GDBusMessage *message)
6955 GSource *idle_source;
6956 SubtreeDeferredData *data;
6958 data = g_new0 (SubtreeDeferredData, 1);
6959 data->message = g_object_ref (message);
6962 /* defer this call to an idle handler in the right thread */
6963 idle_source = g_idle_source_new ();
6964 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
6965 g_source_set_callback (idle_source,
6966 process_subtree_vtable_message_in_idle_cb,
6968 (GDestroyNotify) subtree_deferred_data_free);
6969 g_source_set_name (idle_source, "[gio] process_subtree_vtable_message_in_idle_cb");
6970 g_source_attach (idle_source, es->context);
6971 g_source_unref (idle_source);
6973 /* since we own the entire subtree, handlers for objects not in the subtree have been
6974 * tried already by libdbus-1 - so we just need to ensure that we're always going
6975 * to reply to the message
6981 * g_dbus_connection_register_subtree:
6982 * @connection: a #GDBusConnection
6983 * @object_path: the object path to register the subtree at
6984 * @vtable: a #GDBusSubtreeVTable to enumerate, introspect and
6985 * dispatch nodes in the subtree
6986 * @flags: flags used to fine tune the behavior of the subtree
6987 * @user_data: data to pass to functions in @vtable
6988 * @user_data_free_func: function to call when the subtree is unregistered
6989 * @error: return location for error or %NULL
6991 * Registers a whole subtree of dynamic objects.
6993 * The @enumerate and @introspection functions in @vtable are used to
6994 * convey, to remote callers, what nodes exist in the subtree rooted
6997 * When handling remote calls into any node in the subtree, first the
6998 * @enumerate function is used to check if the node exists. If the node exists
6999 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
7000 * the @introspection function is used to check if the node supports the
7001 * requested method. If so, the @dispatch function is used to determine
7002 * where to dispatch the call. The collected #GDBusInterfaceVTable and
7003 * #gpointer will be used to call into the interface vtable for processing
7006 * All calls into user-provided code will be invoked in the
7007 * [thread-default main context][g-main-context-push-thread-default]
7008 * of the thread you are calling this method from.
7010 * If an existing subtree is already registered at @object_path or
7011 * then @error is set to #G_IO_ERROR_EXISTS.
7013 * Note that it is valid to register regular objects (using
7014 * g_dbus_connection_register_object()) in a subtree registered with
7015 * g_dbus_connection_register_subtree() - if so, the subtree handler
7016 * is tried as the last resort. One way to think about a subtree
7017 * handler is to consider it a fallback handler for object paths not
7018 * registered via g_dbus_connection_register_object() or other bindings.
7020 * Note that @vtable will be copied so you cannot change it after
7023 * See this [server][gdbus-subtree-server] for an example of how to use
7026 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
7027 * that can be used with g_dbus_connection_unregister_subtree() .
7032 g_dbus_connection_register_subtree (GDBusConnection *connection,
7033 const gchar *object_path,
7034 const GDBusSubtreeVTable *vtable,
7035 GDBusSubtreeFlags flags,
7037 GDestroyNotify user_data_free_func,
7041 ExportedSubtree *es;
7043 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
7044 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
7045 g_return_val_if_fail (vtable != NULL, 0);
7046 g_return_val_if_fail (error == NULL || *error == NULL, 0);
7047 g_return_val_if_fail (check_initialized (connection), 0);
7051 CONNECTION_LOCK (connection);
7053 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
7059 _("A subtree is already exported for %s"),
7064 es = g_new0 (ExportedSubtree, 1);
7065 es->object_path = g_strdup (object_path);
7066 es->connection = connection;
7068 es->vtable = _g_dbus_subtree_vtable_copy (vtable);
7070 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
7071 es->user_data = user_data;
7072 es->user_data_free_func = user_data_free_func;
7073 es->context = g_main_context_ref_thread_default ();
7075 g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
7076 g_hash_table_insert (connection->map_id_to_es,
7077 GUINT_TO_POINTER (es->id),
7083 CONNECTION_UNLOCK (connection);
7088 /* ---------------------------------------------------------------------------------------------------- */
7091 * g_dbus_connection_unregister_subtree:
7092 * @connection: a #GDBusConnection
7093 * @registration_id: a subtree registration id obtained from
7094 * g_dbus_connection_register_subtree()
7096 * Unregisters a subtree.
7098 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise
7103 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
7104 guint registration_id)
7106 ExportedSubtree *es;
7109 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
7110 g_return_val_if_fail (check_initialized (connection), FALSE);
7114 CONNECTION_LOCK (connection);
7116 es = g_hash_table_lookup (connection->map_id_to_es,
7117 GUINT_TO_POINTER (registration_id));
7121 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
7122 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
7127 CONNECTION_UNLOCK (connection);
7132 /* ---------------------------------------------------------------------------------------------------- */
7134 /* may be called in any thread, with connection's lock held */
7136 handle_generic_ping_unlocked (GDBusConnection *connection,
7137 const gchar *object_path,
7138 GDBusMessage *message)
7140 GDBusMessage *reply;
7141 reply = g_dbus_message_new_method_reply (message);
7142 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7143 g_object_unref (reply);
7146 /* may be called in any thread, with connection's lock held */
7148 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
7149 const gchar *object_path,
7150 GDBusMessage *message)
7152 GDBusMessage *reply;
7155 if (connection->machine_id == NULL)
7160 connection->machine_id = _g_dbus_get_machine_id (&error);
7161 if (connection->machine_id == NULL)
7163 reply = g_dbus_message_new_method_error_literal (message,
7164 "org.freedesktop.DBus.Error.Failed",
7166 g_error_free (error);
7172 reply = g_dbus_message_new_method_reply (message);
7173 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
7175 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7176 g_object_unref (reply);
7179 /* may be called in any thread, with connection's lock held */
7181 handle_generic_introspect_unlocked (GDBusConnection *connection,
7182 const gchar *object_path,
7183 GDBusMessage *message)
7188 GDBusMessage *reply;
7190 /* first the header */
7191 s = g_string_new (NULL);
7192 introspect_append_header (s);
7194 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
7195 for (n = 0; registered != NULL && registered[n] != NULL; n++)
7196 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
7197 g_strfreev (registered);
7198 g_string_append (s, "</node>\n");
7200 reply = g_dbus_message_new_method_reply (message);
7201 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
7202 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7203 g_object_unref (reply);
7204 g_string_free (s, TRUE);
7207 /* may be called in any thread, with connection's lock held */
7209 handle_generic_unlocked (GDBusConnection *connection,
7210 GDBusMessage *message)
7213 const gchar *interface_name;
7214 const gchar *member;
7215 const gchar *signature;
7218 CONNECTION_ENSURE_LOCK (connection);
7222 interface_name = g_dbus_message_get_interface (message);
7223 member = g_dbus_message_get_member (message);
7224 signature = g_dbus_message_get_signature (message);
7225 path = g_dbus_message_get_path (message);
7227 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
7228 g_strcmp0 (member, "Introspect") == 0 &&
7229 g_strcmp0 (signature, "") == 0)
7231 handle_generic_introspect_unlocked (connection, path, message);
7234 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
7235 g_strcmp0 (member, "Ping") == 0 &&
7236 g_strcmp0 (signature, "") == 0)
7238 handle_generic_ping_unlocked (connection, path, message);
7241 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
7242 g_strcmp0 (member, "GetMachineId") == 0 &&
7243 g_strcmp0 (signature, "") == 0)
7245 handle_generic_get_machine_id_unlocked (connection, path, message);
7252 /* ---------------------------------------------------------------------------------------------------- */
7254 /* called in GDBusWorker thread with connection's lock held */
7256 distribute_method_call (GDBusConnection *connection,
7257 GDBusMessage *message)
7259 GDBusMessage *reply;
7261 ExportedSubtree *es;
7262 const gchar *object_path;
7263 const gchar *interface_name;
7264 const gchar *member;
7266 gchar *subtree_path;
7269 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
7271 interface_name = g_dbus_message_get_interface (message);
7272 member = g_dbus_message_get_member (message);
7273 path = g_dbus_message_get_path (message);
7274 subtree_path = g_strdup (path);
7275 needle = strrchr (subtree_path, '/');
7276 if (needle != NULL && needle != subtree_path)
7282 g_free (subtree_path);
7283 subtree_path = NULL;
7287 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
7289 _g_dbus_debug_print_lock ();
7290 g_print ("========================================================================\n"
7291 "GDBus-debug:Incoming:\n"
7292 " <<<< METHOD INVOCATION %s.%s()\n"
7294 " invoked by name %s\n"
7296 interface_name, member,
7298 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
7299 g_dbus_message_get_serial (message));
7300 _g_dbus_debug_print_unlock ();
7303 object_path = g_dbus_message_get_path (message);
7304 g_assert (object_path != NULL);
7306 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
7309 if (obj_message_func (connection, eo, message))
7313 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
7316 if (subtree_message_func (connection, es, message))
7320 if (subtree_path != NULL)
7322 es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
7325 if (subtree_message_func (connection, es, message))
7330 if (handle_generic_unlocked (connection, message))
7333 /* if we end up here, the message has not been not handled - so return an error saying this */
7334 reply = g_dbus_message_new_method_error (message,
7335 "org.freedesktop.DBus.Error.UnknownMethod",
7336 _("No such interface '%s' on object at path %s"),
7339 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
7340 g_object_unref (reply);
7343 g_free (subtree_path);
7346 /* ---------------------------------------------------------------------------------------------------- */
7348 /* Called in any user thread, with the message_bus_lock held. */
7350 message_bus_get_singleton (GBusType bus_type,
7354 const gchar *starter_bus;
7360 case G_BUS_TYPE_SESSION:
7361 ret = &the_session_bus;
7364 case G_BUS_TYPE_SYSTEM:
7365 ret = &the_system_bus;
7368 case G_BUS_TYPE_USER:
7369 ret = &the_user_bus;
7372 case G_BUS_TYPE_MACHINE:
7373 ret = &the_machine_bus;
7376 case G_BUS_TYPE_STARTER:
7377 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
7378 if (g_strcmp0 (starter_bus, "session") == 0)
7380 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
7383 else if (g_strcmp0 (starter_bus, "system") == 0)
7385 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
7390 if (starter_bus != NULL)
7394 G_IO_ERROR_INVALID_ARGUMENT,
7395 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
7396 " - unknown value '%s'"),
7401 g_set_error_literal (error,
7403 G_IO_ERROR_INVALID_ARGUMENT,
7404 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
7405 "variable is not set"));
7411 g_assert_not_reached ();
7419 /* Called in any user thread, without holding locks. */
7420 static GDBusConnection *
7421 get_uninitialized_connection (GBusType bus_type,
7422 GCancellable *cancellable,
7425 GWeakRef *singleton;
7426 GDBusConnection *ret;
7430 G_LOCK (message_bus_lock);
7431 singleton = message_bus_get_singleton (bus_type, error);
7432 if (singleton == NULL)
7435 ret = g_weak_ref_get (singleton);
7440 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
7441 if (address == NULL)
7443 ret = g_object_new (G_TYPE_DBUS_CONNECTION,
7445 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
7446 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
7447 "exit-on-close", TRUE,
7450 g_weak_ref_set (singleton, ret);
7454 g_assert (ret != NULL);
7457 G_UNLOCK (message_bus_lock);
7461 /* May be called from any thread. Must not hold message_bus_lock. */
7463 _g_bus_get_singleton_if_exists (GBusType bus_type)
7465 GWeakRef *singleton;
7466 GDBusConnection *ret = NULL;
7468 G_LOCK (message_bus_lock);
7469 singleton = message_bus_get_singleton (bus_type, NULL);
7470 if (singleton == NULL)
7473 ret = g_weak_ref_get (singleton);
7476 G_UNLOCK (message_bus_lock);
7482 * @bus_type: a #GBusType
7483 * @cancellable: (allow-none): a #GCancellable or %NULL
7484 * @error: return location for error or %NULL
7486 * Synchronously connects to the message bus specified by @bus_type.
7487 * Note that the returned object may shared with other callers,
7488 * e.g. if two separate parts of a process calls this function with
7489 * the same @bus_type, they will share the same object.
7491 * This is a synchronous failable function. See g_bus_get() and
7492 * g_bus_get_finish() for the asynchronous version.
7494 * The returned object is a singleton, that is, shared with other
7495 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7496 * event that you need a private message bus connection, use
7497 * g_dbus_address_get_for_bus_sync() and
7498 * g_dbus_connection_new_for_address().
7500 * Note that the returned #GDBusConnection object will (usually) have
7501 * the #GDBusConnection:exit-on-close property set to %TRUE.
7503 * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
7504 * Free with g_object_unref().
7509 g_bus_get_sync (GBusType bus_type,
7510 GCancellable *cancellable,
7513 GDBusConnection *connection;
7515 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7517 connection = get_uninitialized_connection (bus_type, cancellable, error);
7518 if (connection == NULL)
7521 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
7523 g_object_unref (connection);
7532 bus_get_async_initable_cb (GObject *source_object,
7536 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
7540 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
7544 g_assert (error != NULL);
7545 g_simple_async_result_take_error (simple, error);
7546 g_object_unref (source_object);
7550 g_simple_async_result_set_op_res_gpointer (simple,
7554 g_simple_async_result_complete_in_idle (simple);
7555 g_object_unref (simple);
7560 * @bus_type: a #GBusType
7561 * @cancellable: (allow-none): a #GCancellable or %NULL
7562 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7563 * @user_data: the data to pass to @callback
7565 * Asynchronously connects to the message bus specified by @bus_type.
7567 * When the operation is finished, @callback will be invoked. You can
7568 * then call g_bus_get_finish() to get the result of the operation.
7570 * This is a asynchronous failable function. See g_bus_get_sync() for
7571 * the synchronous version.
7576 g_bus_get (GBusType bus_type,
7577 GCancellable *cancellable,
7578 GAsyncReadyCallback callback,
7581 GDBusConnection *connection;
7582 GSimpleAsyncResult *simple;
7585 simple = g_simple_async_result_new (NULL,
7589 g_simple_async_result_set_check_cancellable (simple, cancellable);
7592 connection = get_uninitialized_connection (bus_type, cancellable, &error);
7593 if (connection == NULL)
7595 g_assert (error != NULL);
7596 g_simple_async_result_take_error (simple, error);
7597 g_simple_async_result_complete_in_idle (simple);
7598 g_object_unref (simple);
7602 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
7605 bus_get_async_initable_cb,
7612 * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
7614 * @error: return location for error or %NULL
7616 * Finishes an operation started with g_bus_get().
7618 * The returned object is a singleton, that is, shared with other
7619 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
7620 * event that you need a private message bus connection, use
7621 * g_dbus_address_get_for_bus_sync() and
7622 * g_dbus_connection_new_for_address().
7624 * Note that the returned #GDBusConnection object will (usually) have
7625 * the #GDBusConnection:exit-on-close property set to %TRUE.
7627 * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
7628 * Free with g_object_unref().
7633 g_bus_get_finish (GAsyncResult *res,
7636 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
7638 GDBusConnection *ret;
7640 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
7642 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
7646 if (g_simple_async_result_propagate_error (simple, error))
7649 object = g_simple_async_result_get_op_res_gpointer (simple);
7650 g_assert (object != NULL);
7651 ret = g_object_ref (G_DBUS_CONNECTION (object));
7657 /* ---------------------------------------------------------------------------------------------------- */