1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: David Zeuthen <davidz@redhat.com>
26 * - would be nice to expose GDBusAuthMechanism and an extension point
28 * - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
29 * the mechanism VFuncs need to be able to set an error.
31 * - Need to document other mechanisms/sources for determining the D-Bus
32 * address of a well-known bus.
34 * - e.g. on Win32 we need code like from here
36 * http://cgit.freedesktop.org/~david/gdbus-standalone/tree/gdbus/gdbusaddress.c#n900
38 * that was never copied over here because it originally was copy-paste
39 * from the GPLv2 / AFL 2.1 libdbus sources.
41 * - on OS X we need to look in launchd for the address
43 * https://bugs.freedesktop.org/show_bug.cgi?id=14259
45 * - on X11 we need to look in a X11 property on the X server
46 * - (we can also just use dbus-launch(1) from the D-Bus
49 * - (ideally) this requires D-Bus spec work because none of
50 * this has never really been specced out properly (except
53 * - Related to the above, we also need to be able to launch a message bus
54 * instance.... Since we don't want to write our own bus daemon we should
55 * launch dbus-daemon(1) (thus: Win32 and OS X need to bundle it)
57 * - probably want a G_DBUS_NONCE_TCP_TMPDIR environment variable
58 * to specify where the nonce is stored. This will allow people to use
59 * G_DBUS_NONCE_TCP_TMPDIR=/mnt/secure.company.server/dbus-nonce-dir
60 * to easily achieve secure RPC via nonce-tcp.
62 * - need to expose an extension point for resolving D-Bus address and
63 * turning them into GIOStream objects. This will allow us to implement
64 * e.g. X11 D-Bus transports without dlopen()'ing or linking against
66 * - see g_dbus_address_connect() in gdbusaddress.c
68 * - would be cute to use kernel-specific APIs to resolve fds for
69 * debug output when using G_DBUS_DEBUG=message, e.g. in addition to
71 * fd 21: dev=8:1,mode=0100644,ino=1171231,uid=0,gid=0,rdev=0:0,size=234,atime=1273070640,mtime=1267126160,ctime=1267126160
73 * maybe we can show more information about what fd 21 really is.
74 * Ryan suggests looking in /proc/self/fd for clues / symlinks!
75 * Initial experiments on Linux 2.6 suggests that the symlink looks
80 * e.g. not of much use.
82 * - GDBus High-Level docs
83 * - Proxy: properties, signals...
84 * - Connection: IOStream based, ::close, connection setup steps
85 * mainloop integration, threading
86 * - Differences from libdbus (extend "Migrating from")
87 * - the message handling thread
88 * - Using GVariant instead of GValue
89 * - Explain why the high-level API is a good thing and what
90 * kind of pitfalls it avoids
91 * - Export objects before claiming names
92 * - Talk about auto-starting services (cf. GBusNameWatcherFlags)
94 * - use abstract sockets in test code
95 * - right now it doesn't work, dbus-daemon(1) fails with
97 * /gdbus/connection/filter: Failed to start message bus: Failed to bind
98 * socket "/tmp/g-dbus-tests-pid-28531": Address already in use
99 * ** WARNING **: Error reading address from dbus daemon, 0 bytes read
108 #include <sys/types.h>
113 #include "gdbusauth.h"
114 #include "gdbusutils.h"
115 #include "gdbusaddress.h"
116 #include "gdbusmessage.h"
117 #include "gdbusconnection.h"
118 #include "gdbuserror.h"
119 #include "gioenumtypes.h"
120 #include "gdbusintrospection.h"
121 #include "gdbusmethodinvocation.h"
122 #include "gdbusprivate.h"
123 #include "gdbusauthobserver.h"
124 #include "ginitable.h"
125 #include "gasyncinitable.h"
126 #include "giostream.h"
127 #include "gasyncresult.h"
128 #include "gsimpleasyncresult.h"
131 #include "gunixconnection.h"
132 #include "gunixfdmessage.h"
135 #include "glibintl.h"
138 * SECTION:gdbusconnection
139 * @short_description: D-Bus Connections
140 * @include: gio/gio.h
142 * The #GDBusConnection type is used for D-Bus connections to remote
143 * peers such as a message buses. It is a low-level API that offers a
144 * lot of flexibility. For instance, it lets you establish a connection
145 * over any transport that can by represented as an #GIOStream.
147 * This class is rarely used directly in D-Bus clients. If you are writing
148 * an D-Bus client, it is often easier to use the g_bus_own_name(),
149 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
151 * As an exception to the usual GLib rule that a particular object must not be
152 * used by two threads at the same time, #GDBusConnection's methods may be
153 * called from any thread<footnote>
155 * This is so that g_bus_get() and g_bus_get_sync() can safely return the
156 * same #GDBusConnection when called from any thread.
160 * Most of the ways to obtain a #GDBusConnection automatically initialize it
161 * (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
162 * g_bus_get(), and the synchronous versions of those methods, give you an
163 * initialized connection. Language bindings for GIO should use
164 * g_initable_new() or g_async_initable_new_async(), which also initialize the
167 * If you construct an uninitialized #GDBusConnection, such as via
168 * g_object_new(), you must initialize it via g_initable_init() or
169 * g_async_initable_init_async() before using its methods or properties.
170 * Calling methods or accessing properties on a #GDBusConnection that has not
171 * completed initialization successfully is considered to be invalid, and leads
172 * to undefined behaviour. In particular, if initialization fails with a
173 * #GError, the only valid thing you can do with that #GDBusConnection is to
174 * free it with g_object_unref().
176 * <example id="gdbus-server"><title>D-Bus server example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-server.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
178 * <example id="gdbus-subtree-server"><title>D-Bus subtree example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-subtree.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
180 * <example id="gdbus-unix-fd-client"><title>D-Bus UNIX File Descriptor example</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-unix-fd-client.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
182 * <example id="gdbus-export"><title>Exporting a GObject</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-export.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
185 /* ---------------------------------------------------------------------------------------------------- */
187 typedef struct _GDBusConnectionClass GDBusConnectionClass;
190 * GDBusConnectionClass:
191 * @closed: Signal class handler for the #GDBusConnection::closed signal.
193 * Class structure for #GDBusConnection.
197 struct _GDBusConnectionClass
200 GObjectClass parent_class;
204 void (*closed) (GDBusConnection *connection,
205 gboolean remote_peer_vanished,
209 G_LOCK_DEFINE_STATIC (message_bus_lock);
211 static GWeakRef the_session_bus;
212 static GWeakRef the_system_bus;
214 /* Extra pseudo-member of GDBusSendMessageFlags.
215 * Set by initable_init() to indicate that despite not being initialized yet,
216 * enough of the only-valid-after-init members are set that we can send a
217 * message, and we're being called from its thread, so no memory barrier is
218 * required before accessing them.
220 #define SEND_MESSAGE_FLAGS_INITIALIZING (1<<31)
222 /* Same as SEND_MESSAGE_FLAGS_INITIALIZING, but in GDBusCallFlags */
223 #define CALL_FLAGS_INITIALIZING (1<<31)
225 /* ---------------------------------------------------------------------------------------------------- */
229 GDestroyNotify callback;
231 GMainContext *context;
232 } CallDestroyNotifyData;
235 call_destroy_notify_data_in_idle (gpointer user_data)
237 CallDestroyNotifyData *data = user_data;
238 data->callback (data->user_data);
243 call_destroy_notify_data_free (CallDestroyNotifyData *data)
245 if (data->context != NULL)
246 g_main_context_unref (data->context);
251 * call_destroy_notify: <internal>
252 * @context: A #GMainContext or %NULL.
253 * @callback: A #GDestroyNotify or %NULL.
254 * @user_data: Data to pass to @callback.
256 * Schedules @callback to run in @context.
259 call_destroy_notify (GMainContext *context,
260 GDestroyNotify callback,
263 GSource *idle_source;
264 CallDestroyNotifyData *data;
266 if (callback == NULL)
269 data = g_new0 (CallDestroyNotifyData, 1);
270 data->callback = callback;
271 data->user_data = user_data;
272 data->context = context;
273 if (data->context != NULL)
274 g_main_context_ref (data->context);
276 idle_source = g_idle_source_new ();
277 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
278 g_source_set_callback (idle_source,
279 call_destroy_notify_data_in_idle,
281 (GDestroyNotify) call_destroy_notify_data_free);
282 g_source_attach (idle_source, data->context);
283 g_source_unref (idle_source);
289 /* ---------------------------------------------------------------------------------------------------- */
292 _g_strv_has_string (const gchar* const *haystack,
297 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
299 if (g_strcmp0 (haystack[n], needle) == 0)
305 /* ---------------------------------------------------------------------------------------------------- */
308 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
310 // TODO: for some reason this doesn't work on Windows
311 #define CONNECTION_ENSURE_LOCK(obj) do { \
312 if (G_UNLIKELY (g_mutex_trylock(&(obj)->lock))) \
314 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
315 "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
320 #define CONNECTION_LOCK(obj) do { \
321 g_mutex_lock (&(obj)->lock); \
324 #define CONNECTION_UNLOCK(obj) do { \
325 g_mutex_unlock (&(obj)->lock); \
328 /* Flags in connection->atomic_flags */
330 FLAG_INITIALIZED = 1 << 0,
331 FLAG_EXIT_ON_CLOSE = 1 << 1,
338 * The #GDBusConnection structure contains only private data and
339 * should only be accessed using the provided API.
343 struct _GDBusConnection
346 GObject parent_instance;
348 /* ------------------------------------------------------------------------ */
349 /* -- General object state ------------------------------------------------ */
350 /* ------------------------------------------------------------------------ */
352 /* General-purpose lock for most fields */
355 /* A lock used in the init() method of the GInitable interface - see comments
356 * in initable_init() for why a separate lock is needed.
358 * If you need both @lock and @init_lock, you must take @init_lock first.
362 /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
363 * someone calls org.freedesktop.DBus.GetMachineId(). Protected by @lock.
367 /* The underlying stream used for communication
368 * Read-only after initable_init(), so it may be read if you either
369 * hold @init_lock or check for initialization first.
373 /* The object used for authentication (if any).
374 * Read-only after initable_init(), so it may be read if you either
375 * hold @init_lock or check for initialization first.
379 /* Last serial used. Protected by @lock. */
382 /* The object used to send/receive messages.
383 * Read-only after initable_init(), so it may be read if you either
384 * hold @init_lock or check for initialization first.
388 /* If connected to a message bus, this contains the unique name assigned to
389 * us by the bus (e.g. ":1.42").
390 * Read-only after initable_init(), so it may be read if you either
391 * hold @init_lock or check for initialization first.
393 gchar *bus_unique_name;
395 /* The GUID returned by the other side if we authenticed as a client or
396 * the GUID to use if authenticating as a server.
397 * Read-only after initable_init(), so it may be read if you either
398 * hold @init_lock or check for initialization first.
402 /* FLAG_INITIALIZED is set exactly when initable_init() has finished running.
403 * Inspect @initialization_error to see whether it succeeded or failed.
405 * FLAG_EXIT_ON_CLOSE is the exit-on-close property.
407 * FLAG_CLOSED is the closed property. It may be read at any time, but
408 * may only be written while holding @lock.
410 volatile gint atomic_flags;
412 /* If the connection could not be established during initable_init(),
413 * this GError will be set.
414 * Read-only after initable_init(), so it may be read if you either
415 * hold @init_lock or check for initialization first.
417 GError *initialization_error;
419 /* The result of g_main_context_ref_thread_default() when the object
420 * was created (the GObject _init() function) - this is used for delivery
421 * of the :closed GObject signal.
423 * Only set in the GObject init function, so no locks are needed.
425 GMainContext *main_context_at_construction;
427 /* Read-only construct properties, no locks needed */
429 GDBusConnectionFlags flags;
431 /* Map used for managing method replies, protected by @lock */
432 GHashTable *map_method_serial_to_send_message_data; /* guint32 -> SendMessageData* */
434 /* Maps used for managing signal subscription, protected by @lock */
435 GHashTable *map_rule_to_signal_data; /* match rule (gchar*) -> SignalData */
436 GHashTable *map_id_to_signal_data; /* id (guint) -> SignalData */
437 GHashTable *map_sender_unique_name_to_signal_data_array; /* unique sender (gchar*) -> GPtrArray* of SignalData */
439 /* Maps used for managing exported objects and subtrees,
442 GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
443 GHashTable *map_id_to_ei; /* guint -> ExportedInterface* */
444 GHashTable *map_object_path_to_es; /* gchar* -> ExportedSubtree* */
445 GHashTable *map_id_to_es; /* guint -> ExportedSubtree* */
447 /* Structure used for message filters, protected by @lock */
450 /* Capabilities negotiated during authentication
451 * Read-only after initable_init(), so it may be read without holding a
452 * lock, if you check for initialization first.
454 GDBusCapabilityFlags capabilities;
456 /* Protected by @init_lock */
457 GDBusAuthObserver *authentication_observer;
459 /* Read-only after initable_init(), so it may be read if you either
460 * hold @init_lock or check for initialization first.
462 GCredentials *credentials;
464 /* set to TRUE when finalizing */
468 typedef struct ExportedObject ExportedObject;
469 static void exported_object_free (ExportedObject *eo);
471 typedef struct ExportedSubtree ExportedSubtree;
472 static void exported_subtree_free (ExportedSubtree *es);
490 PROP_CAPABILITY_FLAGS,
491 PROP_AUTHENTICATION_OBSERVER,
494 static void distribute_signals (GDBusConnection *connection,
495 GDBusMessage *message);
497 static void distribute_method_call (GDBusConnection *connection,
498 GDBusMessage *message);
500 static gboolean handle_generic_unlocked (GDBusConnection *connection,
501 GDBusMessage *message);
504 static void purge_all_signal_subscriptions (GDBusConnection *connection);
505 static void purge_all_filters (GDBusConnection *connection);
507 #define _G_ENSURE_LOCK(name) do { \
508 if (G_UNLIKELY (G_TRYLOCK(name))) \
510 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
511 "_G_ENSURE_LOCK: Lock `" #name "' is not locked"); \
515 static guint signals[LAST_SIGNAL] = { 0 };
517 static void initable_iface_init (GInitableIface *initable_iface);
518 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
520 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
521 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
522 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
526 * Check that all members of @connection that can only be accessed after
527 * the connection is initialized can safely be accessed. If not,
528 * log a critical warning. This function is a memory barrier.
530 * Returns: %TRUE if initialized
533 check_initialized (GDBusConnection *connection)
535 /* The access to @atomic_flags isn't conditional, so that this function
536 * provides a memory barrier for thread-safety even if checks are disabled.
537 * (If you don't want this stricter guarantee, you can call
538 * g_return_if_fail (check_initialized (c)).)
540 * This isn't strictly necessary now that we've decided use of an
541 * uninitialized GDBusConnection is undefined behaviour, but it seems
542 * better to be as deterministic as is feasible.
544 * (Anything that could suffer a crash from seeing undefined values
545 * must have a race condition - thread A initializes the connection while
546 * thread B calls a method without initialization, hoping that thread A will
547 * win the race - so its behaviour is undefined anyway.)
549 gint flags = g_atomic_int_get (&connection->atomic_flags);
551 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
553 /* We can safely access this, due to the memory barrier above */
554 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
560 MAY_BE_UNINITIALIZED = (1<<1)
561 } CheckUnclosedFlags;
564 * Check the same thing as check_initialized(), and also that the
565 * connection is not closed. If the connection is uninitialized,
566 * raise a critical warning (it's programmer error); if it's closed,
567 * raise a recoverable GError (it's a runtime error).
569 * This function is a memory barrier.
571 * Returns: %TRUE if initialized and not closed
574 check_unclosed (GDBusConnection *connection,
575 CheckUnclosedFlags check,
578 /* check_initialized() is effectively inlined, so we don't waste time
579 * doing two memory barriers
581 gint flags = g_atomic_int_get (&connection->atomic_flags);
583 if (!(check & MAY_BE_UNINITIALIZED))
585 g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
586 g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
589 if (flags & FLAG_CLOSED)
591 g_set_error_literal (error,
594 _("The connection is closed"));
601 static GHashTable *alive_connections = NULL;
604 g_dbus_connection_dispose (GObject *object)
606 GDBusConnection *connection = G_DBUS_CONNECTION (object);
608 G_LOCK (message_bus_lock);
609 CONNECTION_LOCK (connection);
610 if (connection->worker != NULL)
612 _g_dbus_worker_stop (connection->worker);
613 connection->worker = NULL;
614 if (alive_connections != NULL)
615 g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
619 if (alive_connections != NULL)
620 g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
622 CONNECTION_UNLOCK (connection);
623 G_UNLOCK (message_bus_lock);
625 if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
626 G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
630 g_dbus_connection_finalize (GObject *object)
632 GDBusConnection *connection = G_DBUS_CONNECTION (object);
634 connection->finalizing = TRUE;
636 purge_all_signal_subscriptions (connection);
638 purge_all_filters (connection);
639 g_ptr_array_unref (connection->filters);
641 if (connection->authentication_observer != NULL)
642 g_object_unref (connection->authentication_observer);
644 if (connection->auth != NULL)
645 g_object_unref (connection->auth);
647 if (connection->credentials)
648 g_object_unref (connection->credentials);
650 if (connection->stream != NULL)
652 g_object_unref (connection->stream);
653 connection->stream = NULL;
656 g_free (connection->address);
658 g_free (connection->guid);
659 g_free (connection->bus_unique_name);
661 if (connection->initialization_error != NULL)
662 g_error_free (connection->initialization_error);
664 g_hash_table_unref (connection->map_method_serial_to_send_message_data);
666 g_hash_table_unref (connection->map_rule_to_signal_data);
667 g_hash_table_unref (connection->map_id_to_signal_data);
668 g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
670 g_hash_table_unref (connection->map_id_to_ei);
671 g_hash_table_unref (connection->map_object_path_to_eo);
672 g_hash_table_unref (connection->map_id_to_es);
673 g_hash_table_unref (connection->map_object_path_to_es);
675 g_main_context_unref (connection->main_context_at_construction);
677 g_free (connection->machine_id);
679 g_mutex_clear (&connection->init_lock);
680 g_mutex_clear (&connection->lock);
682 G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
685 /* called in any user thread, with the connection's lock not held */
687 g_dbus_connection_get_property (GObject *object,
692 GDBusConnection *connection = G_DBUS_CONNECTION (object);
697 g_value_set_object (value, g_dbus_connection_get_stream (connection));
701 g_value_set_string (value, g_dbus_connection_get_guid (connection));
704 case PROP_UNIQUE_NAME:
705 g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
709 g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
712 case PROP_EXIT_ON_CLOSE:
713 g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
716 case PROP_CAPABILITY_FLAGS:
717 g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
721 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
726 /* called in any user thread, with the connection's lock not held */
728 g_dbus_connection_set_property (GObject *object,
733 GDBusConnection *connection = G_DBUS_CONNECTION (object);
738 connection->stream = g_value_dup_object (value);
742 connection->guid = g_value_dup_string (value);
746 connection->address = g_value_dup_string (value);
750 connection->flags = g_value_get_flags (value);
753 case PROP_EXIT_ON_CLOSE:
754 g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
757 case PROP_AUTHENTICATION_OBSERVER:
758 connection->authentication_observer = g_value_dup_object (value);
762 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
767 /* Base-class implementation of GDBusConnection::closed.
769 * Called in a user thread, by the main context that was thread-default when
770 * the object was constructed.
773 g_dbus_connection_real_closed (GDBusConnection *connection,
774 gboolean remote_peer_vanished,
777 gint flags = g_atomic_int_get (&connection->atomic_flags);
779 /* Because atomic int access is a memory barrier, we can safely read
780 * initialization_error without a lock, as long as we do it afterwards.
782 if (remote_peer_vanished &&
783 (flags & FLAG_EXIT_ON_CLOSE) != 0 &&
784 (flags & FLAG_INITIALIZED) != 0 &&
785 connection->initialization_error == NULL)
789 g_print ("%s: Remote peer vanished with error: %s (%s, %d). Exiting.\n",
792 g_quark_to_string (error->domain), error->code);
796 g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
803 g_dbus_connection_class_init (GDBusConnectionClass *klass)
805 GObjectClass *gobject_class;
807 gobject_class = G_OBJECT_CLASS (klass);
809 gobject_class->finalize = g_dbus_connection_finalize;
810 gobject_class->dispose = g_dbus_connection_dispose;
811 gobject_class->set_property = g_dbus_connection_set_property;
812 gobject_class->get_property = g_dbus_connection_get_property;
814 klass->closed = g_dbus_connection_real_closed;
817 * GDBusConnection:stream:
819 * The underlying #GIOStream used for I/O.
821 * If this is passed on construction and is a #GSocketConnection,
822 * then the corresponding #GSocket will be put into non-blocking mode.
824 * While the #GDBusConnection is active, it will interact with this
825 * stream from a worker thread, so it is not safe to interact with
826 * the stream directly.
830 g_object_class_install_property (gobject_class,
832 g_param_spec_object ("stream",
834 P_("The underlying streams used for I/O"),
838 G_PARAM_CONSTRUCT_ONLY |
839 G_PARAM_STATIC_NAME |
840 G_PARAM_STATIC_BLURB |
841 G_PARAM_STATIC_NICK));
844 * GDBusConnection:address:
846 * A D-Bus address specifying potential endpoints that can be used
847 * when establishing the connection.
851 g_object_class_install_property (gobject_class,
853 g_param_spec_string ("address",
855 P_("D-Bus address specifying potential socket endpoints"),
858 G_PARAM_CONSTRUCT_ONLY |
859 G_PARAM_STATIC_NAME |
860 G_PARAM_STATIC_BLURB |
861 G_PARAM_STATIC_NICK));
864 * GDBusConnection:flags:
866 * Flags from the #GDBusConnectionFlags enumeration.
870 g_object_class_install_property (gobject_class,
872 g_param_spec_flags ("flags",
875 G_TYPE_DBUS_CONNECTION_FLAGS,
876 G_DBUS_CONNECTION_FLAGS_NONE,
878 G_PARAM_CONSTRUCT_ONLY |
879 G_PARAM_STATIC_NAME |
880 G_PARAM_STATIC_BLURB |
881 G_PARAM_STATIC_NICK));
884 * GDBusConnection:guid:
886 * The GUID of the peer performing the role of server when
889 * If you are constructing a #GDBusConnection and pass
890 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
891 * #GDBusConnection:flags property then you MUST also set this
892 * property to a valid guid.
894 * If you are constructing a #GDBusConnection and pass
895 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
896 * #GDBusConnection:flags property you will be able to read the GUID
897 * of the other peer here after the connection has been successfully
902 g_object_class_install_property (gobject_class,
904 g_param_spec_string ("guid",
906 P_("GUID of the server peer"),
910 G_PARAM_CONSTRUCT_ONLY |
911 G_PARAM_STATIC_NAME |
912 G_PARAM_STATIC_BLURB |
913 G_PARAM_STATIC_NICK));
916 * GDBusConnection:unique-name:
918 * The unique name as assigned by the message bus or %NULL if the
919 * connection is not open or not a message bus connection.
923 g_object_class_install_property (gobject_class,
925 g_param_spec_string ("unique-name",
927 P_("Unique name of bus connection"),
930 G_PARAM_STATIC_NAME |
931 G_PARAM_STATIC_BLURB |
932 G_PARAM_STATIC_NICK));
935 * GDBusConnection:closed:
937 * A boolean specifying whether the connection has been closed.
941 g_object_class_install_property (gobject_class,
943 g_param_spec_boolean ("closed",
945 P_("Whether the connection is closed"),
948 G_PARAM_STATIC_NAME |
949 G_PARAM_STATIC_BLURB |
950 G_PARAM_STATIC_NICK));
953 * GDBusConnection:exit-on-close:
955 * A boolean specifying whether the process will be terminated (by
956 * calling <literal>raise(SIGTERM)</literal>) if the connection
957 * is closed by the remote peer.
959 * Note that #GDBusConnection objects returned by g_bus_get_finish() and
960 * g_bus_get_sync() will (usually) have this property set to %TRUE.
964 g_object_class_install_property (gobject_class,
966 g_param_spec_boolean ("exit-on-close",
968 P_("Whether the process is terminated when the connection is closed"),
972 G_PARAM_STATIC_NAME |
973 G_PARAM_STATIC_BLURB |
974 G_PARAM_STATIC_NICK));
977 * GDBusConnection:capabilities:
979 * Flags from the #GDBusCapabilityFlags enumeration
980 * representing connection features negotiated with the other peer.
984 g_object_class_install_property (gobject_class,
985 PROP_CAPABILITY_FLAGS,
986 g_param_spec_flags ("capabilities",
989 G_TYPE_DBUS_CAPABILITY_FLAGS,
990 G_DBUS_CAPABILITY_FLAGS_NONE,
992 G_PARAM_STATIC_NAME |
993 G_PARAM_STATIC_BLURB |
994 G_PARAM_STATIC_NICK));
997 * GDBusConnection:authentication-observer:
999 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
1003 g_object_class_install_property (gobject_class,
1004 PROP_AUTHENTICATION_OBSERVER,
1005 g_param_spec_object ("authentication-observer",
1006 P_("Authentication Observer"),
1007 P_("Object used to assist in the authentication process"),
1008 G_TYPE_DBUS_AUTH_OBSERVER,
1010 G_PARAM_CONSTRUCT_ONLY |
1011 G_PARAM_STATIC_NAME |
1012 G_PARAM_STATIC_BLURB |
1013 G_PARAM_STATIC_NICK));
1016 * GDBusConnection::closed:
1017 * @connection: The #GDBusConnection emitting the signal.
1018 * @remote_peer_vanished: %TRUE if @connection is closed because the
1019 * remote peer closed its end of the connection.
1020 * @error: A #GError with more details about the event or %NULL.
1022 * Emitted when the connection is closed.
1024 * The cause of this event can be
1027 * If g_dbus_connection_close() is called. In this case
1028 * @remote_peer_vanished is set to %FALSE and @error is %NULL.
1029 * </para></listitem>
1031 * If the remote peer closes the connection. In this case
1032 * @remote_peer_vanished is set to %TRUE and @error is set.
1033 * </para></listitem>
1035 * If the remote peer sends invalid or malformed data. In this
1036 * case @remote_peer_vanished is set to %FALSE and @error
1038 * </para></listitem>
1041 * Upon receiving this signal, you should give up your reference to
1042 * @connection. You are guaranteed that this signal is emitted only
1047 signals[CLOSED_SIGNAL] = g_signal_new ("closed",
1048 G_TYPE_DBUS_CONNECTION,
1050 G_STRUCT_OFFSET (GDBusConnectionClass, closed),
1061 g_dbus_connection_init (GDBusConnection *connection)
1063 g_mutex_init (&connection->lock);
1064 g_mutex_init (&connection->init_lock);
1066 connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
1068 connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
1070 connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
1072 connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
1075 (GDestroyNotify) g_ptr_array_unref);
1077 connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
1080 (GDestroyNotify) exported_object_free);
1082 connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
1085 connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
1088 (GDestroyNotify) exported_subtree_free);
1090 connection->map_id_to_es = g_hash_table_new (g_direct_hash,
1093 connection->main_context_at_construction = g_main_context_ref_thread_default ();
1095 connection->filters = g_ptr_array_new ();
1099 * g_dbus_connection_get_stream:
1100 * @connection: a #GDBusConnection
1102 * Gets the underlying stream used for IO.
1104 * While the #GDBusConnection is active, it will interact with this
1105 * stream from a worker thread, so it is not safe to interact with
1106 * the stream directly.
1108 * Returns: (transfer none): the stream used for IO
1113 g_dbus_connection_get_stream (GDBusConnection *connection)
1115 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1117 /* do not use g_return_val_if_fail(), we want the memory barrier */
1118 if (!check_initialized (connection))
1121 return connection->stream;
1125 * g_dbus_connection_start_message_processing:
1126 * @connection: A #GDBusConnection.
1128 * If @connection was created with
1129 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
1130 * starts processing messages. Does nothing on if @connection wasn't
1131 * created with this flag or if the method has already been called.
1136 g_dbus_connection_start_message_processing (GDBusConnection *connection)
1138 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1140 /* do not use g_return_val_if_fail(), we want the memory barrier */
1141 if (!check_initialized (connection))
1144 g_assert (connection->worker != NULL);
1145 _g_dbus_worker_unfreeze (connection->worker);
1149 * g_dbus_connection_is_closed:
1150 * @connection: A #GDBusConnection.
1152 * Gets whether @connection is closed.
1154 * Returns: %TRUE if the connection is closed, %FALSE otherwise.
1159 g_dbus_connection_is_closed (GDBusConnection *connection)
1163 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1165 flags = g_atomic_int_get (&connection->atomic_flags);
1167 return (flags & FLAG_CLOSED) ? TRUE : FALSE;
1171 * g_dbus_connection_get_capabilities:
1172 * @connection: A #GDBusConnection.
1174 * Gets the capabilities negotiated with the remote peer
1176 * Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration.
1180 GDBusCapabilityFlags
1181 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1183 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1185 /* do not use g_return_val_if_fail(), we want the memory barrier */
1186 if (!check_initialized (connection))
1187 return G_DBUS_CAPABILITY_FLAGS_NONE;
1189 return connection->capabilities;
1192 /* ---------------------------------------------------------------------------------------------------- */
1194 /* Called in a temporary thread without holding locks. */
1196 flush_in_thread_func (GSimpleAsyncResult *res,
1198 GCancellable *cancellable)
1203 if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
1206 g_simple_async_result_take_error (res, error);
1210 * g_dbus_connection_flush:
1211 * @connection: A #GDBusConnection.
1212 * @cancellable: A #GCancellable or %NULL.
1213 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1214 * satisfied or %NULL if you don't care about the result.
1215 * @user_data: The data to pass to @callback.
1217 * Asynchronously flushes @connection, that is, writes all queued
1218 * outgoing message to the transport and then flushes the transport
1219 * (using g_output_stream_flush_async()). This is useful in programs
1220 * that wants to emit a D-Bus signal and then exit
1221 * immediately. Without flushing the connection, there is no guarantee
1222 * that the message has been sent to the networking buffers in the OS
1225 * This is an asynchronous method. When the operation is finished,
1226 * @callback will be invoked in the <link
1227 * linkend="g-main-context-push-thread-default">thread-default main
1228 * loop</link> of the thread you are calling this method from. You can
1229 * then call g_dbus_connection_flush_finish() to get the result of the
1230 * operation. See g_dbus_connection_flush_sync() for the synchronous
1236 g_dbus_connection_flush (GDBusConnection *connection,
1237 GCancellable *cancellable,
1238 GAsyncReadyCallback callback,
1241 GSimpleAsyncResult *simple;
1243 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1245 simple = g_simple_async_result_new (G_OBJECT (connection),
1248 g_dbus_connection_flush);
1249 g_simple_async_result_set_check_cancellable (simple, cancellable);
1250 g_simple_async_result_run_in_thread (simple,
1251 flush_in_thread_func,
1254 g_object_unref (simple);
1258 * g_dbus_connection_flush_finish:
1259 * @connection: A #GDBusConnection.
1260 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush().
1261 * @error: Return location for error or %NULL.
1263 * Finishes an operation started with g_dbus_connection_flush().
1265 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1270 g_dbus_connection_flush_finish (GDBusConnection *connection,
1274 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1279 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1280 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1281 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1283 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
1285 if (g_simple_async_result_propagate_error (simple, error))
1295 * g_dbus_connection_flush_sync:
1296 * @connection: A #GDBusConnection.
1297 * @cancellable: A #GCancellable or %NULL.
1298 * @error: Return location for error or %NULL.
1300 * Synchronously flushes @connection. The calling thread is blocked
1301 * until this is done. See g_dbus_connection_flush() for the
1302 * asynchronous version of this method and more details about what it
1305 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1310 g_dbus_connection_flush_sync (GDBusConnection *connection,
1311 GCancellable *cancellable,
1316 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1317 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1321 /* This is only a best-effort attempt to see whether the connection is
1322 * closed, so it doesn't need the lock. If the connection closes just
1323 * after this check, but before scheduling the flush operation, the
1324 * result will be more or less the same as if the connection closed while
1325 * the flush operation was pending - it'll fail with either CLOSED or
1328 if (!check_unclosed (connection, 0, error))
1331 g_assert (connection->worker != NULL);
1333 ret = _g_dbus_worker_flush_sync (connection->worker,
1341 /* ---------------------------------------------------------------------------------------------------- */
1345 GDBusConnection *connection;
1347 gboolean remote_peer_vanished;
1351 emit_closed_data_free (EmitClosedData *data)
1353 g_object_unref (data->connection);
1354 if (data->error != NULL)
1355 g_error_free (data->error);
1359 /* Called in a user thread that has acquired the main context that was
1360 * thread-default when the object was constructed
1363 emit_closed_in_idle (gpointer user_data)
1365 EmitClosedData *data = user_data;
1368 g_object_notify (G_OBJECT (data->connection), "closed");
1369 g_signal_emit (data->connection,
1370 signals[CLOSED_SIGNAL],
1372 data->remote_peer_vanished,
1378 /* Can be called from any thread, must hold lock.
1379 * FLAG_CLOSED must already have been set.
1382 schedule_closed_unlocked (GDBusConnection *connection,
1383 gboolean remote_peer_vanished,
1386 GSource *idle_source;
1387 EmitClosedData *data;
1389 CONNECTION_ENSURE_LOCK (connection);
1391 data = g_new0 (EmitClosedData, 1);
1392 data->connection = g_object_ref (connection);
1393 data->remote_peer_vanished = remote_peer_vanished;
1394 data->error = error != NULL ? g_error_copy (error) : NULL;
1396 idle_source = g_idle_source_new ();
1397 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1398 g_source_set_callback (idle_source,
1399 emit_closed_in_idle,
1401 (GDestroyNotify) emit_closed_data_free);
1402 g_source_attach (idle_source, connection->main_context_at_construction);
1403 g_source_unref (idle_source);
1406 /* ---------------------------------------------------------------------------------------------------- */
1409 * g_dbus_connection_close:
1410 * @connection: A #GDBusConnection.
1411 * @cancellable: A #GCancellable or %NULL.
1412 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1413 * satisfied or %NULL if you don't care about the result.
1414 * @user_data: The data to pass to @callback.
1416 * Closes @connection. Note that this never causes the process to
1417 * exit (this might only happen if the other end of a shared message
1418 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1420 * Once the connection is closed, operations such as sending a message
1421 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1422 * will not automatically flush the connection so queued messages may
1423 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1425 * If @connection is already closed, this method fails with
1426 * %G_IO_ERROR_CLOSED.
1428 * When @connection has been closed, the #GDBusConnection::closed
1429 * signal is emitted in the <link
1430 * linkend="g-main-context-push-thread-default">thread-default main
1431 * loop</link> of the thread that @connection was constructed in.
1433 * This is an asynchronous method. When the operation is finished,
1434 * @callback will be invoked in the <link
1435 * linkend="g-main-context-push-thread-default">thread-default main
1436 * loop</link> of the thread you are calling this method from. You can
1437 * then call g_dbus_connection_close_finish() to get the result of the
1438 * operation. See g_dbus_connection_close_sync() for the synchronous
1444 g_dbus_connection_close (GDBusConnection *connection,
1445 GCancellable *cancellable,
1446 GAsyncReadyCallback callback,
1449 GSimpleAsyncResult *simple;
1451 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1453 /* do not use g_return_val_if_fail(), we want the memory barrier */
1454 if (!check_initialized (connection))
1457 g_assert (connection->worker != NULL);
1459 simple = g_simple_async_result_new (G_OBJECT (connection),
1462 g_dbus_connection_close);
1463 g_simple_async_result_set_check_cancellable (simple, cancellable);
1464 _g_dbus_worker_close (connection->worker, cancellable, simple);
1465 g_object_unref (simple);
1469 * g_dbus_connection_close_finish:
1470 * @connection: A #GDBusConnection.
1471 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close().
1472 * @error: Return location for error or %NULL.
1474 * Finishes an operation started with g_dbus_connection_close().
1476 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1481 g_dbus_connection_close_finish (GDBusConnection *connection,
1485 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1490 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1491 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1492 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1494 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
1496 if (g_simple_async_result_propagate_error (simple, error))
1507 GAsyncResult *result;
1510 /* Can be called by any thread, without the connection lock */
1512 sync_close_cb (GObject *source_object,
1516 SyncCloseData *data = user_data;
1518 data->result = g_object_ref (res);
1519 g_main_loop_quit (data->loop);
1523 * g_dbus_connection_close_sync:
1524 * @connection: A #GDBusConnection.
1525 * @cancellable: A #GCancellable or %NULL.
1526 * @error: Return location for error or %NULL.
1528 * Synchronously closees @connection. The calling thread is blocked
1529 * until this is done. See g_dbus_connection_close() for the
1530 * asynchronous version of this method and more details about what it
1533 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1538 g_dbus_connection_close_sync (GDBusConnection *connection,
1539 GCancellable *cancellable,
1544 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1545 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1549 if (check_unclosed (connection, 0, error))
1551 GMainContext *context;
1554 context = g_main_context_new ();
1555 g_main_context_push_thread_default (context);
1556 data.loop = g_main_loop_new (context, TRUE);
1559 g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
1560 g_main_loop_run (data.loop);
1561 ret = g_dbus_connection_close_finish (connection, data.result, error);
1563 g_object_unref (data.result);
1564 g_main_loop_unref (data.loop);
1565 g_main_context_pop_thread_default (context);
1566 g_main_context_unref (context);
1572 /* ---------------------------------------------------------------------------------------------------- */
1574 /* Can be called by any thread, with the connection lock held */
1576 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
1577 GDBusMessage *message,
1578 GDBusSendMessageFlags flags,
1579 volatile guint32 *out_serial,
1584 guint32 serial_to_use;
1587 CONNECTION_ENSURE_LOCK (connection);
1589 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1590 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1592 /* TODO: check all necessary headers are present */
1597 if (out_serial != NULL)
1600 /* If we're in initable_init(), don't check for being initialized, to avoid
1601 * chicken-and-egg problems. initable_init() is responsible for setting up
1602 * our prerequisites (mainly connection->worker), and only calling us
1603 * from its own thread (so no memory barrier is needed).
1605 if (!check_unclosed (connection,
1606 (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
1610 blob = g_dbus_message_to_blob (message,
1612 connection->capabilities,
1617 if (flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL)
1618 serial_to_use = g_dbus_message_get_serial (message);
1620 serial_to_use = ++connection->last_serial; /* TODO: handle overflow */
1625 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
1628 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
1631 g_assert_not_reached ();
1636 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
1637 blob_size, serial_to_use, connection);
1638 g_printerr ("----\n");
1639 hexdump (blob, blob_size);
1640 g_printerr ("----\n");
1643 /* TODO: use connection->auth to encode the blob */
1645 if (out_serial != NULL)
1646 *out_serial = serial_to_use;
1648 if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
1649 g_dbus_message_set_serial (message, serial_to_use);
1651 g_dbus_message_lock (message);
1652 _g_dbus_worker_send_message (connection->worker,
1656 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
1667 * g_dbus_connection_send_message:
1668 * @connection: A #GDBusConnection.
1669 * @message: A #GDBusMessage
1670 * @flags: Flags affecting how the message is sent.
1671 * @out_serial: (out) (allow-none): Return location for serial number assigned
1672 * to @message when sending it or %NULL.
1673 * @error: Return location for error or %NULL.
1675 * Asynchronously sends @message to the peer represented by @connection.
1677 * Unless @flags contain the
1678 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1679 * will be assigned by @connection and set on @message via
1680 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1681 * serial number used will be written to this location prior to
1682 * submitting the message to the underlying transport.
1684 * If @connection is closed then the operation will fail with
1685 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
1686 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1688 * See <xref linkend="gdbus-server"/> and <xref
1689 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1690 * low-level API to send and receive UNIX file descriptors.
1692 * Note that @message must be unlocked, unless @flags contain the
1693 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1695 * Returns: %TRUE if the message was well-formed and queued for
1696 * transmission, %FALSE if @error is set.
1701 g_dbus_connection_send_message (GDBusConnection *connection,
1702 GDBusMessage *message,
1703 GDBusSendMessageFlags flags,
1704 volatile guint32 *out_serial,
1709 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1710 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1711 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
1712 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1714 CONNECTION_LOCK (connection);
1715 ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
1716 CONNECTION_UNLOCK (connection);
1720 /* ---------------------------------------------------------------------------------------------------- */
1724 volatile gint ref_count;
1725 GDBusConnection *connection;
1727 GSimpleAsyncResult *simple;
1729 GMainContext *main_context;
1731 GCancellable *cancellable;
1733 gulong cancellable_handler_id;
1735 GSource *timeout_source;
1740 /* Can be called from any thread with or without lock held */
1741 static SendMessageData *
1742 send_message_data_ref (SendMessageData *data)
1744 g_atomic_int_inc (&data->ref_count);
1748 /* Can be called from any thread with or without lock held */
1750 send_message_data_unref (SendMessageData *data)
1752 if (g_atomic_int_dec_and_test (&data->ref_count))
1754 g_assert (data->timeout_source == NULL);
1755 g_assert (data->simple == NULL);
1756 g_assert (data->cancellable_handler_id == 0);
1757 g_object_unref (data->connection);
1758 if (data->cancellable != NULL)
1759 g_object_unref (data->cancellable);
1760 g_main_context_unref (data->main_context);
1765 /* ---------------------------------------------------------------------------------------------------- */
1767 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
1769 send_message_with_reply_deliver (SendMessageData *data, gboolean remove)
1771 CONNECTION_ENSURE_LOCK (data->connection);
1773 g_assert (!data->delivered);
1775 data->delivered = TRUE;
1777 g_simple_async_result_complete_in_idle (data->simple);
1778 g_object_unref (data->simple);
1779 data->simple = NULL;
1781 if (data->timeout_source != NULL)
1783 g_source_destroy (data->timeout_source);
1784 data->timeout_source = NULL;
1786 if (data->cancellable_handler_id > 0)
1788 g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
1789 data->cancellable_handler_id = 0;
1794 g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
1795 GUINT_TO_POINTER (data->serial)));
1798 send_message_data_unref (data);
1801 /* ---------------------------------------------------------------------------------------------------- */
1803 /* Can be called from any thread with lock held */
1805 send_message_data_deliver_reply_unlocked (SendMessageData *data,
1806 GDBusMessage *reply)
1808 if (data->delivered)
1811 g_simple_async_result_set_op_res_gpointer (data->simple,
1812 g_object_ref (reply),
1815 send_message_with_reply_deliver (data, TRUE);
1821 /* ---------------------------------------------------------------------------------------------------- */
1823 /* Called from a user thread, lock is not held */
1825 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
1827 SendMessageData *data = user_data;
1829 CONNECTION_LOCK (data->connection);
1830 if (data->delivered)
1833 g_simple_async_result_set_error (data->simple,
1835 G_IO_ERROR_CANCELLED,
1836 _("Operation was cancelled"));
1838 send_message_with_reply_deliver (data, TRUE);
1841 CONNECTION_UNLOCK (data->connection);
1845 /* Can be called from any thread with or without lock held */
1847 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
1850 SendMessageData *data = user_data;
1851 GSource *idle_source;
1853 /* postpone cancellation to idle handler since we may be called directly
1854 * via g_cancellable_connect() (e.g. holding lock)
1856 idle_source = g_idle_source_new ();
1857 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1858 g_source_set_callback (idle_source,
1859 send_message_with_reply_cancelled_idle_cb,
1860 send_message_data_ref (data),
1861 (GDestroyNotify) send_message_data_unref);
1862 g_source_attach (idle_source, data->main_context);
1863 g_source_unref (idle_source);
1866 /* ---------------------------------------------------------------------------------------------------- */
1868 /* Called from a user thread, lock is not held */
1870 send_message_with_reply_timeout_cb (gpointer user_data)
1872 SendMessageData *data = user_data;
1874 CONNECTION_LOCK (data->connection);
1875 if (data->delivered)
1878 g_simple_async_result_set_error (data->simple,
1880 G_IO_ERROR_TIMED_OUT,
1881 _("Timeout was reached"));
1883 send_message_with_reply_deliver (data, TRUE);
1886 CONNECTION_UNLOCK (data->connection);
1891 /* ---------------------------------------------------------------------------------------------------- */
1893 /* Called from a user thread, connection's lock is held */
1895 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
1896 GDBusMessage *message,
1897 GDBusSendMessageFlags flags,
1899 volatile guint32 *out_serial,
1900 GCancellable *cancellable,
1901 GAsyncReadyCallback callback,
1904 GSimpleAsyncResult *simple;
1905 SendMessageData *data;
1907 volatile guint32 serial;
1911 if (out_serial == NULL)
1912 out_serial = &serial;
1914 if (timeout_msec == -1)
1915 timeout_msec = 25 * 1000;
1917 simple = g_simple_async_result_new (G_OBJECT (connection),
1920 g_dbus_connection_send_message_with_reply);
1921 g_simple_async_result_set_check_cancellable (simple, cancellable);
1923 if (g_cancellable_is_cancelled (cancellable))
1925 g_simple_async_result_set_error (simple,
1927 G_IO_ERROR_CANCELLED,
1928 _("Operation was cancelled"));
1929 g_simple_async_result_complete_in_idle (simple);
1930 g_object_unref (simple);
1935 if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
1937 g_simple_async_result_take_error (simple, error);
1938 g_simple_async_result_complete_in_idle (simple);
1939 g_object_unref (simple);
1943 data = g_new0 (SendMessageData, 1);
1944 data->ref_count = 1;
1945 data->connection = g_object_ref (connection);
1946 data->simple = simple;
1947 data->serial = *out_serial;
1948 data->main_context = g_main_context_ref_thread_default ();
1950 if (cancellable != NULL)
1952 data->cancellable = g_object_ref (cancellable);
1953 data->cancellable_handler_id = g_cancellable_connect (cancellable,
1954 G_CALLBACK (send_message_with_reply_cancelled_cb),
1955 send_message_data_ref (data),
1956 (GDestroyNotify) send_message_data_unref);
1959 if (timeout_msec != G_MAXINT)
1961 data->timeout_source = g_timeout_source_new (timeout_msec);
1962 g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
1963 g_source_set_callback (data->timeout_source,
1964 send_message_with_reply_timeout_cb,
1965 send_message_data_ref (data),
1966 (GDestroyNotify) send_message_data_unref);
1967 g_source_attach (data->timeout_source, data->main_context);
1968 g_source_unref (data->timeout_source);
1971 g_hash_table_insert (connection->map_method_serial_to_send_message_data,
1972 GUINT_TO_POINTER (*out_serial),
1980 * g_dbus_connection_send_message_with_reply:
1981 * @connection: A #GDBusConnection.
1982 * @message: A #GDBusMessage.
1983 * @flags: Flags affecting how the message is sent.
1984 * @timeout_msec: The timeout in milliseconds, -1 to use the default
1985 * timeout or %G_MAXINT for no timeout.
1986 * @out_serial: (out) (allow-none): Return location for serial number assigned
1987 * to @message when sending it or %NULL.
1988 * @cancellable: A #GCancellable or %NULL.
1989 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
1990 * satisfied or %NULL if you don't care about the result.
1991 * @user_data: The data to pass to @callback.
1993 * Asynchronously sends @message to the peer represented by @connection.
1995 * Unless @flags contain the
1996 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1997 * will be assigned by @connection and set on @message via
1998 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1999 * serial number used will be written to this location prior to
2000 * submitting the message to the underlying transport.
2002 * If @connection is closed then the operation will fail with
2003 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2004 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2005 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2007 * This is an asynchronous method. When the operation is finished, @callback will be invoked
2008 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
2009 * of the thread you are calling this method from. You can then call
2010 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
2011 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
2013 * Note that @message must be unlocked, unless @flags contain the
2014 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2016 * See <xref linkend="gdbus-server"/> and <xref
2017 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2018 * low-level API to send and receive UNIX file descriptors.
2023 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
2024 GDBusMessage *message,
2025 GDBusSendMessageFlags flags,
2027 volatile guint32 *out_serial,
2028 GCancellable *cancellable,
2029 GAsyncReadyCallback callback,
2032 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2033 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2034 g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
2035 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
2037 CONNECTION_LOCK (connection);
2038 g_dbus_connection_send_message_with_reply_unlocked (connection,
2046 CONNECTION_UNLOCK (connection);
2050 * g_dbus_connection_send_message_with_reply_finish:
2051 * @connection: a #GDBusConnection
2052 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
2053 * @error: Return location for error or %NULL.
2055 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
2057 * Note that @error is only set if a local in-process error
2058 * occurred. That is to say that the returned #GDBusMessage object may
2059 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2060 * g_dbus_message_to_gerror() to transcode this to a #GError.
2062 * See <xref linkend="gdbus-server"/> and <xref
2063 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2064 * low-level API to send and receive UNIX file descriptors.
2066 * Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set.
2071 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
2075 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2076 GDBusMessage *reply;
2078 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2079 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2083 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
2085 if (g_simple_async_result_propagate_error (simple, error))
2088 reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
2094 /* ---------------------------------------------------------------------------------------------------- */
2099 GMainContext *context;
2101 } SendMessageSyncData;
2103 /* Called from a user thread, lock is not held */
2105 send_message_with_reply_sync_cb (GDBusConnection *connection,
2109 SendMessageSyncData *data = user_data;
2110 data->res = g_object_ref (res);
2111 g_main_loop_quit (data->loop);
2115 * g_dbus_connection_send_message_with_reply_sync:
2116 * @connection: A #GDBusConnection.
2117 * @message: A #GDBusMessage.
2118 * @flags: Flags affecting how the message is sent.
2119 * @timeout_msec: The timeout in milliseconds, -1 to use the default
2120 * timeout or %G_MAXINT for no timeout.
2121 * @out_serial: (out) (allow-none): Return location for serial number assigned
2122 * to @message when sending it or %NULL.
2123 * @cancellable: A #GCancellable or %NULL.
2124 * @error: Return location for error or %NULL.
2126 * Synchronously sends @message to the peer represented by @connection
2127 * and blocks the calling thread until a reply is received or the
2128 * timeout is reached. See g_dbus_connection_send_message_with_reply()
2129 * for the asynchronous version of this method.
2131 * Unless @flags contain the
2132 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
2133 * will be assigned by @connection and set on @message via
2134 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
2135 * serial number used will be written to this location prior to
2136 * submitting the message to the underlying transport.
2138 * If @connection is closed then the operation will fail with
2139 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
2140 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
2141 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
2143 * Note that @error is only set if a local in-process error
2144 * occurred. That is to say that the returned #GDBusMessage object may
2145 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
2146 * g_dbus_message_to_gerror() to transcode this to a #GError.
2148 * See <xref linkend="gdbus-server"/> and <xref
2149 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
2150 * low-level API to send and receive UNIX file descriptors.
2152 * Note that @message must be unlocked, unless @flags contain the
2153 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
2155 * Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.
2160 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
2161 GDBusMessage *message,
2162 GDBusSendMessageFlags flags,
2164 volatile guint32 *out_serial,
2165 GCancellable *cancellable,
2168 SendMessageSyncData *data;
2169 GDBusMessage *reply;
2171 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2172 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2173 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
2174 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2175 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2177 data = g_new0 (SendMessageSyncData, 1);
2178 data->context = g_main_context_new ();
2179 data->loop = g_main_loop_new (data->context, FALSE);
2181 g_main_context_push_thread_default (data->context);
2183 g_dbus_connection_send_message_with_reply (connection,
2189 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2191 g_main_loop_run (data->loop);
2192 reply = g_dbus_connection_send_message_with_reply_finish (connection,
2196 g_main_context_pop_thread_default (data->context);
2198 g_main_context_unref (data->context);
2199 g_main_loop_unref (data->loop);
2200 g_object_unref (data->res);
2206 /* ---------------------------------------------------------------------------------------------------- */
2210 GDBusMessageFilterFunction func;
2217 GDBusMessageFilterFunction filter_function;
2219 GDestroyNotify user_data_free_func;
2222 /* Called in GDBusWorker's thread - we must not block - with no lock held */
2224 on_worker_message_received (GDBusWorker *worker,
2225 GDBusMessage *message,
2228 GDBusConnection *connection;
2229 FilterCallback *filters;
2234 G_LOCK (message_bus_lock);
2235 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2238 G_UNLOCK (message_bus_lock);
2241 connection = G_DBUS_CONNECTION (user_data);
2242 g_object_ref (connection);
2243 G_UNLOCK (message_bus_lock);
2245 //g_debug ("in on_worker_message_received");
2247 g_object_ref (message);
2248 g_dbus_message_lock (message);
2250 //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2252 /* First collect the set of callback functions */
2253 CONNECTION_LOCK (connection);
2254 num_filters = connection->filters->len;
2255 filters = g_new0 (FilterCallback, num_filters);
2256 for (n = 0; n < num_filters; n++)
2258 FilterData *data = connection->filters->pdata[n];
2259 filters[n].func = data->filter_function;
2260 filters[n].user_data = data->user_data;
2262 CONNECTION_UNLOCK (connection);
2264 /* then call the filters in order (without holding the lock) */
2265 for (n = 0; n < num_filters; n++)
2267 message = filters[n].func (connection,
2270 filters[n].user_data);
2271 if (message == NULL)
2273 g_dbus_message_lock (message);
2276 /* Standard dispatch unless the filter ate the message - no need to
2277 * do anything if the message was altered
2279 if (message != NULL)
2281 GDBusMessageType message_type;
2283 message_type = g_dbus_message_get_message_type (message);
2284 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2286 guint32 reply_serial;
2287 SendMessageData *send_message_data;
2289 reply_serial = g_dbus_message_get_reply_serial (message);
2290 CONNECTION_LOCK (connection);
2291 send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
2292 GUINT_TO_POINTER (reply_serial));
2293 if (send_message_data != NULL)
2295 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2296 send_message_data_deliver_reply_unlocked (send_message_data, message);
2300 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2302 CONNECTION_UNLOCK (connection);
2304 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2306 CONNECTION_LOCK (connection);
2307 distribute_signals (connection, message);
2308 CONNECTION_UNLOCK (connection);
2310 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2312 CONNECTION_LOCK (connection);
2313 distribute_method_call (connection, message);
2314 CONNECTION_UNLOCK (connection);
2318 if (message != NULL)
2319 g_object_unref (message);
2320 g_object_unref (connection);
2324 /* Called in GDBusWorker's thread, lock is not held */
2325 static GDBusMessage *
2326 on_worker_message_about_to_be_sent (GDBusWorker *worker,
2327 GDBusMessage *message,
2330 GDBusConnection *connection;
2331 FilterCallback *filters;
2336 G_LOCK (message_bus_lock);
2337 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2340 G_UNLOCK (message_bus_lock);
2343 connection = G_DBUS_CONNECTION (user_data);
2344 g_object_ref (connection);
2345 G_UNLOCK (message_bus_lock);
2347 //g_debug ("in on_worker_message_about_to_be_sent");
2349 /* First collect the set of callback functions */
2350 CONNECTION_LOCK (connection);
2351 num_filters = connection->filters->len;
2352 filters = g_new0 (FilterCallback, num_filters);
2353 for (n = 0; n < num_filters; n++)
2355 FilterData *data = connection->filters->pdata[n];
2356 filters[n].func = data->filter_function;
2357 filters[n].user_data = data->user_data;
2359 CONNECTION_UNLOCK (connection);
2361 /* then call the filters in order (without holding the lock) */
2362 for (n = 0; n < num_filters; n++)
2364 g_dbus_message_lock (message);
2365 message = filters[n].func (connection,
2368 filters[n].user_data);
2369 if (message == NULL)
2373 g_object_unref (connection);
2379 /* called with connection lock held, in GDBusWorker thread */
2381 cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
2383 SendMessageData *data = value;
2385 if (data->delivered)
2388 g_simple_async_result_set_error (data->simple,
2391 _("The connection is closed"));
2393 /* Ask send_message_with_reply_deliver not to remove the element from the
2394 * hash table - we're in the middle of a foreach; that would be unsafe.
2395 * Instead, return TRUE from this function so that it gets removed safely.
2397 send_message_with_reply_deliver (data, FALSE);
2401 /* Called in GDBusWorker's thread - we must not block - without lock held */
2403 on_worker_closed (GDBusWorker *worker,
2404 gboolean remote_peer_vanished,
2408 GDBusConnection *connection;
2410 guint old_atomic_flags;
2412 G_LOCK (message_bus_lock);
2413 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2416 G_UNLOCK (message_bus_lock);
2419 connection = G_DBUS_CONNECTION (user_data);
2420 g_object_ref (connection);
2421 G_UNLOCK (message_bus_lock);
2423 //g_debug ("in on_worker_closed: %s", error->message);
2425 CONNECTION_LOCK (connection);
2426 /* Even though this is atomic, we do it inside the lock to avoid breaking
2427 * assumptions in remove_match_rule(). We'd need the lock in a moment
2428 * anyway, so, no loss.
2430 old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
2432 if (!(old_atomic_flags & FLAG_CLOSED))
2434 g_hash_table_foreach_remove (connection->map_method_serial_to_send_message_data, cancel_method_on_close, NULL);
2435 schedule_closed_unlocked (connection, remote_peer_vanished, error);
2437 CONNECTION_UNLOCK (connection);
2439 g_object_unref (connection);
2442 /* ---------------------------------------------------------------------------------------------------- */
2444 /* Determines the biggest set of capabilities we can support on this
2447 * Called with the init_lock held.
2449 static GDBusCapabilityFlags
2450 get_offered_capabilities_max (GDBusConnection *connection)
2452 GDBusCapabilityFlags ret;
2453 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
2455 if (G_IS_UNIX_CONNECTION (connection->stream))
2456 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
2461 /* Called in a user thread, lock is not held */
2463 initable_init (GInitable *initable,
2464 GCancellable *cancellable,
2467 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
2470 /* This method needs to be idempotent to work with the singleton
2471 * pattern. See the docs for g_initable_init(). We implement this by
2474 * Unfortunately we can't use the main lock since the on_worker_*()
2475 * callbacks above needs the lock during initialization (for message
2476 * bus connections we do a synchronous Hello() call on the bus).
2478 g_mutex_lock (&connection->init_lock);
2482 /* Make this a no-op if we're already initialized (successfully or
2485 if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
2487 ret = (connection->initialization_error == NULL);
2491 /* Because of init_lock, we can't get here twice in different threads */
2492 g_assert (connection->initialization_error == NULL);
2494 /* The user can pass multiple (but mutally exclusive) construct
2497 * - stream (of type GIOStream)
2498 * - address (of type gchar*)
2500 * At the end of the day we end up with a non-NULL GIOStream
2501 * object in connection->stream.
2503 if (connection->address != NULL)
2505 g_assert (connection->stream == NULL);
2507 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
2508 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
2510 g_set_error_literal (&connection->initialization_error,
2512 G_IO_ERROR_INVALID_ARGUMENT,
2513 _("Unsupported flags encountered when constructing a client-side connection"));
2517 connection->stream = g_dbus_address_get_stream_sync (connection->address,
2518 NULL, /* TODO: out_guid */
2520 &connection->initialization_error);
2521 if (connection->stream == NULL)
2524 else if (connection->stream != NULL)
2530 g_assert_not_reached ();
2533 /* Authenticate the connection */
2534 if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
2536 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
2537 g_assert (connection->guid != NULL);
2538 connection->auth = _g_dbus_auth_new (connection->stream);
2539 if (!_g_dbus_auth_run_server (connection->auth,
2540 connection->authentication_observer,
2542 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
2543 get_offered_capabilities_max (connection),
2544 &connection->capabilities,
2545 &connection->credentials,
2547 &connection->initialization_error))
2550 else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
2552 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
2553 g_assert (connection->guid == NULL);
2554 connection->auth = _g_dbus_auth_new (connection->stream);
2555 connection->guid = _g_dbus_auth_run_client (connection->auth,
2556 get_offered_capabilities_max (connection),
2557 &connection->capabilities,
2559 &connection->initialization_error);
2560 if (connection->guid == NULL)
2564 if (connection->authentication_observer != NULL)
2566 g_object_unref (connection->authentication_observer);
2567 connection->authentication_observer = NULL;
2570 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
2572 //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
2575 /* We want all IO operations to be non-blocking since they happen in
2576 * the worker thread which is shared by _all_ connections.
2578 if (G_IS_SOCKET_CONNECTION (connection->stream))
2580 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
2584 G_LOCK (message_bus_lock);
2585 if (alive_connections == NULL)
2586 alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
2587 g_hash_table_insert (alive_connections, connection, connection);
2588 G_UNLOCK (message_bus_lock);
2590 connection->worker = _g_dbus_worker_new (connection->stream,
2591 connection->capabilities,
2592 ((connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0),
2593 on_worker_message_received,
2594 on_worker_message_about_to_be_sent,
2598 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
2599 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2601 GVariant *hello_result;
2603 /* we could lift this restriction by adding code in gdbusprivate.c */
2604 if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
2606 g_set_error_literal (&connection->initialization_error,
2609 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
2613 hello_result = g_dbus_connection_call_sync (connection,
2614 "org.freedesktop.DBus", /* name */
2615 "/org/freedesktop/DBus", /* path */
2616 "org.freedesktop.DBus", /* interface */
2618 NULL, /* parameters */
2619 G_VARIANT_TYPE ("(s)"),
2620 CALL_FLAGS_INITIALIZING,
2622 NULL, /* TODO: cancellable */
2623 &connection->initialization_error);
2624 if (hello_result == NULL)
2627 g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
2628 g_variant_unref (hello_result);
2629 //g_debug ("unique name is `%s'", connection->bus_unique_name);
2636 g_assert (connection->initialization_error != NULL);
2637 g_propagate_error (error, g_error_copy (connection->initialization_error));
2640 g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
2641 g_mutex_unlock (&connection->init_lock);
2647 initable_iface_init (GInitableIface *initable_iface)
2649 initable_iface->init = initable_init;
2652 /* ---------------------------------------------------------------------------------------------------- */
2655 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
2660 /* ---------------------------------------------------------------------------------------------------- */
2663 * g_dbus_connection_new:
2664 * @stream: A #GIOStream.
2665 * @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL.
2666 * @flags: Flags describing how to make the connection.
2667 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2668 * @cancellable: A #GCancellable or %NULL.
2669 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2670 * @user_data: The data to pass to @callback.
2672 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
2673 * with the end represented by @stream.
2675 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2676 * will be put into non-blocking mode.
2678 * The D-Bus connection will interact with @stream from a worker thread.
2679 * As a result, the caller should not interact with @stream after this
2680 * method has been called, except by calling g_object_unref() on it.
2682 * If @observer is not %NULL it may be used to control the
2683 * authentication process.
2685 * When the operation is finished, @callback will be invoked. You can
2686 * then call g_dbus_connection_new_finish() to get the result of the
2689 * This is a asynchronous failable constructor. See
2690 * g_dbus_connection_new_sync() for the synchronous
2696 g_dbus_connection_new (GIOStream *stream,
2698 GDBusConnectionFlags flags,
2699 GDBusAuthObserver *observer,
2700 GCancellable *cancellable,
2701 GAsyncReadyCallback callback,
2704 g_return_if_fail (G_IS_IO_STREAM (stream));
2705 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2713 "authentication-observer", observer,
2718 * g_dbus_connection_new_finish:
2719 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2720 * @error: Return location for error or %NULL.
2722 * Finishes an operation started with g_dbus_connection_new().
2724 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2729 g_dbus_connection_new_finish (GAsyncResult *res,
2733 GObject *source_object;
2735 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2736 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2738 source_object = g_async_result_get_source_object (res);
2739 g_assert (source_object != NULL);
2740 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2743 g_object_unref (source_object);
2745 return G_DBUS_CONNECTION (object);
2751 * g_dbus_connection_new_sync:
2752 * @stream: A #GIOStream.
2753 * @guid: (allow-none): The GUID to use if a authenticating as a server or %NULL.
2754 * @flags: Flags describing how to make the connection.
2755 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2756 * @cancellable: A #GCancellable or %NULL.
2757 * @error: Return location for error or %NULL.
2759 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2760 * with the end represented by @stream.
2762 * If @stream is a #GSocketConnection, then the corresponding #GSocket
2763 * will be put into non-blocking mode.
2765 * The D-Bus connection will interact with @stream from a worker thread.
2766 * As a result, the caller should not interact with @stream after this
2767 * method has been called, except by calling g_object_unref() on it.
2769 * If @observer is not %NULL it may be used to control the
2770 * authentication process.
2772 * This is a synchronous failable constructor. See
2773 * g_dbus_connection_new() for the asynchronous version.
2775 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2780 g_dbus_connection_new_sync (GIOStream *stream,
2782 GDBusConnectionFlags flags,
2783 GDBusAuthObserver *observer,
2784 GCancellable *cancellable,
2787 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2788 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2789 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2795 "authentication-observer", observer,
2799 /* ---------------------------------------------------------------------------------------------------- */
2802 * g_dbus_connection_new_for_address:
2803 * @address: A D-Bus address.
2804 * @flags: Flags describing how to make the connection.
2805 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2806 * @cancellable: A #GCancellable or %NULL.
2807 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2808 * @user_data: The data to pass to @callback.
2810 * Asynchronously connects and sets up a D-Bus client connection for
2811 * exchanging D-Bus messages with an endpoint specified by @address
2812 * which must be in the D-Bus address format.
2814 * This constructor can only be used to initiate client-side
2815 * connections - use g_dbus_connection_new() if you need to act as the
2816 * server. In particular, @flags cannot contain the
2817 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2818 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2820 * When the operation is finished, @callback will be invoked. You can
2821 * then call g_dbus_connection_new_finish() to get the result of the
2824 * If @observer is not %NULL it may be used to control the
2825 * authentication process.
2827 * This is a asynchronous failable constructor. See
2828 * g_dbus_connection_new_for_address_sync() for the synchronous
2834 g_dbus_connection_new_for_address (const gchar *address,
2835 GDBusConnectionFlags flags,
2836 GDBusAuthObserver *observer,
2837 GCancellable *cancellable,
2838 GAsyncReadyCallback callback,
2841 g_return_if_fail (address != NULL);
2842 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2849 "authentication-observer", observer,
2854 * g_dbus_connection_new_for_address_finish:
2855 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2856 * @error: Return location for error or %NULL.
2858 * Finishes an operation started with g_dbus_connection_new_for_address().
2860 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2865 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
2869 GObject *source_object;
2871 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2872 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2874 source_object = g_async_result_get_source_object (res);
2875 g_assert (source_object != NULL);
2876 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2879 g_object_unref (source_object);
2881 return G_DBUS_CONNECTION (object);
2887 * g_dbus_connection_new_for_address_sync:
2888 * @address: A D-Bus address.
2889 * @flags: Flags describing how to make the connection.
2890 * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
2891 * @cancellable: A #GCancellable or %NULL.
2892 * @error: Return location for error or %NULL.
2894 * Synchronously connects and sets up a D-Bus client connection for
2895 * exchanging D-Bus messages with an endpoint specified by @address
2896 * which must be in the D-Bus address format.
2898 * This constructor can only be used to initiate client-side
2899 * connections - use g_dbus_connection_new_sync() if you need to act
2900 * as the server. In particular, @flags cannot contain the
2901 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2902 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2904 * This is a synchronous failable constructor. See
2905 * g_dbus_connection_new_for_address() for the asynchronous version.
2907 * If @observer is not %NULL it may be used to control the
2908 * authentication process.
2910 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2915 g_dbus_connection_new_for_address_sync (const gchar *address,
2916 GDBusConnectionFlags flags,
2917 GDBusAuthObserver *observer,
2918 GCancellable *cancellable,
2921 g_return_val_if_fail (address != NULL, NULL);
2922 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2923 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2928 "authentication-observer", observer,
2932 /* ---------------------------------------------------------------------------------------------------- */
2935 * g_dbus_connection_set_exit_on_close:
2936 * @connection: A #GDBusConnection.
2937 * @exit_on_close: Whether the process should be terminated
2938 * when @connection is closed by the remote peer.
2940 * Sets whether the process should be terminated when @connection is
2941 * closed by the remote peer. See #GDBusConnection:exit-on-close for
2944 * Note that this function should be used with care. Most modern UNIX
2945 * desktops tie the notion of a user session the session bus, and expect
2946 * all of a users applications to quit when their bus connection goes away.
2947 * If you are setting @exit_on_close to %FALSE for the shared session
2948 * bus connection, you should make sure that your application exits
2949 * when the user session ends.
2954 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
2955 gboolean exit_on_close)
2957 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2960 g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
2962 g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
2967 * g_dbus_connection_get_exit_on_close:
2968 * @connection: A #GDBusConnection.
2970 * Gets whether the process is terminated when @connection is
2971 * closed by the remote peer. See
2972 * #GDBusConnection:exit-on-close for more details.
2974 * Returns: Whether the process is terminated when @connection is
2975 * closed by the remote peer.
2980 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
2982 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2984 if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
2991 * g_dbus_connection_get_guid:
2992 * @connection: A #GDBusConnection.
2994 * The GUID of the peer performing the role of server when
2995 * authenticating. See #GDBusConnection:guid for more details.
2997 * Returns: The GUID. Do not free this string, it is owned by
3003 g_dbus_connection_get_guid (GDBusConnection *connection)
3005 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3006 return connection->guid;
3010 * g_dbus_connection_get_unique_name:
3011 * @connection: A #GDBusConnection.
3013 * Gets the unique name of @connection as assigned by the message
3014 * bus. This can also be used to figure out if @connection is a
3015 * message bus connection.
3017 * Returns: The unique name or %NULL if @connection is not a message
3018 * bus connection. Do not free this string, it is owned by
3024 g_dbus_connection_get_unique_name (GDBusConnection *connection)
3026 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3028 /* do not use g_return_val_if_fail(), we want the memory barrier */
3029 if (!check_initialized (connection))
3032 return connection->bus_unique_name;
3036 * g_dbus_connection_get_peer_credentials:
3037 * @connection: A #GDBusConnection.
3039 * Gets the credentials of the authenticated peer. This will always
3040 * return %NULL unless @connection acted as a server
3041 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
3042 * when set up and the client passed credentials as part of the
3043 * authentication process.
3045 * In a message bus setup, the message bus is always the server and
3046 * each application is a client. So this method will always return
3047 * %NULL for message bus clients.
3049 * Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free
3050 * this object, it is owned by @connection.
3055 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
3057 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
3059 /* do not use g_return_val_if_fail(), we want the memory barrier */
3060 if (!check_initialized (connection))
3063 return connection->credentials;
3066 /* ---------------------------------------------------------------------------------------------------- */
3068 static guint _global_filter_id = 1;
3071 * g_dbus_connection_add_filter:
3072 * @connection: A #GDBusConnection.
3073 * @filter_function: A filter function.
3074 * @user_data: User data to pass to @filter_function.
3075 * @user_data_free_func: Function to free @user_data with when filter
3076 * is removed or %NULL.
3078 * Adds a message filter. Filters are handlers that are run on all
3079 * incoming and outgoing messages, prior to standard dispatch. Filters
3080 * are run in the order that they were added. The same handler can be
3081 * added as a filter more than once, in which case it will be run more
3082 * than once. Filters added during a filter callback won't be run on
3083 * the message being processed. Filter functions are allowed to modify
3084 * and even drop messages.
3086 * Note that filters are run in a dedicated message handling thread so
3087 * they can't block and, generally, can't do anything but signal a
3088 * worker thread. Also note that filters are rarely needed - use API
3089 * such as g_dbus_connection_send_message_with_reply(),
3090 * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
3092 * If a filter consumes an incoming message the message is not
3093 * dispatched anywhere else - not even the standard dispatch machinery
3094 * (that API such as g_dbus_connection_signal_subscribe() and
3095 * g_dbus_connection_send_message_with_reply() relies on) will see the
3096 * message. Similary, if a filter consumes an outgoing message, the
3097 * message will not be sent to the other peer.
3099 * Returns: A filter identifier that can be used with
3100 * g_dbus_connection_remove_filter().
3105 g_dbus_connection_add_filter (GDBusConnection *connection,
3106 GDBusMessageFilterFunction filter_function,
3108 GDestroyNotify user_data_free_func)
3112 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3113 g_return_val_if_fail (filter_function != NULL, 0);
3114 g_return_val_if_fail (check_initialized (connection), 0);
3116 CONNECTION_LOCK (connection);
3117 data = g_new0 (FilterData, 1);
3118 data->id = _global_filter_id++; /* TODO: overflow etc. */
3119 data->filter_function = filter_function;
3120 data->user_data = user_data;
3121 data->user_data_free_func = user_data_free_func;
3122 g_ptr_array_add (connection->filters, data);
3123 CONNECTION_UNLOCK (connection);
3128 /* only called from finalize(), removes all filters */
3130 purge_all_filters (GDBusConnection *connection)
3133 for (n = 0; n < connection->filters->len; n++)
3135 FilterData *data = connection->filters->pdata[n];
3136 if (data->user_data_free_func != NULL)
3137 data->user_data_free_func (data->user_data);
3143 * g_dbus_connection_remove_filter:
3144 * @connection: a #GDBusConnection
3145 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
3152 g_dbus_connection_remove_filter (GDBusConnection *connection,
3156 FilterData *to_destroy;
3158 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3159 g_return_if_fail (check_initialized (connection));
3161 CONNECTION_LOCK (connection);
3163 for (n = 0; n < connection->filters->len; n++)
3165 FilterData *data = connection->filters->pdata[n];
3166 if (data->id == filter_id)
3168 g_ptr_array_remove_index (connection->filters, n);
3173 CONNECTION_UNLOCK (connection);
3175 /* do free without holding lock */
3176 if (to_destroy != NULL)
3178 if (to_destroy->user_data_free_func != NULL)
3179 to_destroy->user_data_free_func (to_destroy->user_data);
3180 g_free (to_destroy);
3184 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
3188 /* ---------------------------------------------------------------------------------------------------- */
3194 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
3195 gchar *interface_name;
3199 GArray *subscribers;
3204 GDBusSignalCallback callback;
3206 GDestroyNotify user_data_free_func;
3208 GMainContext *context;
3212 signal_data_free (SignalData *signal_data)
3214 g_free (signal_data->rule);
3215 g_free (signal_data->sender);
3216 g_free (signal_data->sender_unique_name);
3217 g_free (signal_data->interface_name);
3218 g_free (signal_data->member);
3219 g_free (signal_data->object_path);
3220 g_free (signal_data->arg0);
3221 g_array_free (signal_data->subscribers, TRUE);
3222 g_free (signal_data);
3226 args_to_rule (const gchar *sender,
3227 const gchar *interface_name,
3228 const gchar *member,
3229 const gchar *object_path,
3235 rule = g_string_new ("type='signal'");
3237 g_string_prepend_c (rule, '-');
3239 g_string_append_printf (rule, ",sender='%s'", sender);
3240 if (interface_name != NULL)
3241 g_string_append_printf (rule, ",interface='%s'", interface_name);
3243 g_string_append_printf (rule, ",member='%s'", member);
3244 if (object_path != NULL)
3245 g_string_append_printf (rule, ",path='%s'", object_path);
3247 g_string_append_printf (rule, ",arg0='%s'", arg0);
3249 return g_string_free (rule, FALSE);
3252 static guint _global_subscriber_id = 1;
3253 static guint _global_registration_id = 1;
3254 static guint _global_subtree_registration_id = 1;
3256 /* ---------------------------------------------------------------------------------------------------- */
3258 /* Called in a user thread, lock is held */
3260 add_match_rule (GDBusConnection *connection,
3261 const gchar *match_rule)
3264 GDBusMessage *message;
3266 if (match_rule[0] == '-')
3269 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3270 "/org/freedesktop/DBus", /* path */
3271 "org.freedesktop.DBus", /* interface */
3273 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3275 if (!g_dbus_connection_send_message_unlocked (connection,
3277 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3281 g_critical ("Error while sending AddMatch() message: %s", error->message);
3282 g_error_free (error);
3284 g_object_unref (message);
3287 /* ---------------------------------------------------------------------------------------------------- */
3289 /* Called in a user thread, lock is held */
3291 remove_match_rule (GDBusConnection *connection,
3292 const gchar *match_rule)
3295 GDBusMessage *message;
3297 if (match_rule[0] == '-')
3300 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3301 "/org/freedesktop/DBus", /* path */
3302 "org.freedesktop.DBus", /* interface */
3304 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3307 if (!g_dbus_connection_send_message_unlocked (connection,
3309 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3313 /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
3314 * critical; but we're holding the lock, and our caller checked whether
3315 * we were already closed, so we can't get that error.
3317 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3318 g_error_free (error);
3320 g_object_unref (message);
3323 /* ---------------------------------------------------------------------------------------------------- */
3326 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3328 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3329 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3330 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3331 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3332 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3335 /* ---------------------------------------------------------------------------------------------------- */
3338 * g_dbus_connection_signal_subscribe:
3339 * @connection: A #GDBusConnection.
3340 * @sender: (allow-none): Sender name to match on (unique or well-known name)
3341 * or %NULL to listen from all senders.
3342 * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
3343 * match on all interfaces.
3344 * @member: (allow-none): D-Bus signal name to match on or %NULL to match on all signals.
3345 * @object_path: (allow-none): Object path to match on or %NULL to match on all object paths.
3346 * @arg0: (allow-none): Contents of first string argument to match on or %NULL
3347 * to match on all kinds of arguments.
3348 * @flags: Flags describing how to subscribe to the signal (currently unused).
3349 * @callback: Callback to invoke when there is a signal matching the requested data.
3350 * @user_data: User data to pass to @callback.
3351 * @user_data_free_func: (allow-none): Function to free @user_data with when
3352 * subscription is removed or %NULL.
3354 * Subscribes to signals on @connection and invokes @callback with a
3355 * whenever the signal is received. Note that @callback
3356 * will be invoked in the <link
3357 * linkend="g-main-context-push-thread-default">thread-default main
3358 * loop</link> of the thread you are calling this method from.
3360 * If @connection is not a message bus connection, @sender must be
3363 * If @sender is a well-known name note that @callback is invoked with
3364 * the unique name for the owner of @sender, not the well-known name
3365 * as one would expect. This is because the message bus rewrites the
3366 * name. As such, to avoid certain race conditions, users should be
3367 * tracking the name owner of the well-known name and use that when
3368 * processing the received signal.
3370 * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
3375 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
3376 const gchar *sender,
3377 const gchar *interface_name,
3378 const gchar *member,
3379 const gchar *object_path,
3381 GDBusSignalFlags flags,
3382 GDBusSignalCallback callback,
3384 GDestroyNotify user_data_free_func)
3387 SignalData *signal_data;
3388 SignalSubscriber subscriber;
3389 GPtrArray *signal_data_array;
3390 const gchar *sender_unique_name;
3392 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
3393 * an OOM condition. We might want to change that but that would involve making
3394 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
3395 * handle that. And there's really no sensible way of handling this short of retrying
3396 * to add the match rule... and then there's the little thing that, hey, maybe there's
3397 * a reason the bus in an OOM condition.
3399 * Doable, but not really sure it's worth it...
3402 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3403 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
3404 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
3405 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
3406 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
3407 g_return_val_if_fail (callback != NULL, 0);
3408 g_return_val_if_fail (check_initialized (connection), 0);
3410 CONNECTION_LOCK (connection);
3412 /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
3413 * with a '-' character to prefix the rule (which will otherwise be
3416 * This allows us to hash the rule and do our lifecycle tracking in
3417 * the usual way, but the '-' prevents the match rule from ever
3418 * actually being send to the bus (either for add or remove).
3420 rule = args_to_rule (sender, interface_name, member, object_path, arg0,
3421 (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE) != 0);
3423 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
3424 sender_unique_name = sender;
3426 sender_unique_name = "";
3428 subscriber.callback = callback;
3429 subscriber.user_data = user_data;
3430 subscriber.user_data_free_func = user_data_free_func;
3431 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
3432 subscriber.context = g_main_context_ref_thread_default ();
3434 /* see if we've already have this rule */
3435 signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
3436 if (signal_data != NULL)
3438 g_array_append_val (signal_data->subscribers, subscriber);
3443 signal_data = g_new0 (SignalData, 1);
3444 signal_data->rule = rule;
3445 signal_data->sender = g_strdup (sender);
3446 signal_data->sender_unique_name = g_strdup (sender_unique_name);
3447 signal_data->interface_name = g_strdup (interface_name);
3448 signal_data->member = g_strdup (member);
3449 signal_data->object_path = g_strdup (object_path);
3450 signal_data->arg0 = g_strdup (arg0);
3451 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3452 g_array_append_val (signal_data->subscribers, subscriber);
3454 g_hash_table_insert (connection->map_rule_to_signal_data,
3458 /* Add the match rule to the bus...
3460 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
3461 * always send such messages to us.
3463 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3465 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
3466 add_match_rule (connection, signal_data->rule);
3469 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3470 signal_data->sender_unique_name);
3471 if (signal_data_array == NULL)
3473 signal_data_array = g_ptr_array_new ();
3474 g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
3475 g_strdup (signal_data->sender_unique_name),
3478 g_ptr_array_add (signal_data_array, signal_data);
3481 g_hash_table_insert (connection->map_id_to_signal_data,
3482 GUINT_TO_POINTER (subscriber.id),
3485 CONNECTION_UNLOCK (connection);
3487 return subscriber.id;
3490 /* ---------------------------------------------------------------------------------------------------- */
3492 /* called in any thread */
3493 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
3495 unsubscribe_id_internal (GDBusConnection *connection,
3496 guint subscription_id,
3497 GArray *out_removed_subscribers)
3499 SignalData *signal_data;
3500 GPtrArray *signal_data_array;
3503 signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
3504 GUINT_TO_POINTER (subscription_id));
3505 if (signal_data == NULL)
3507 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
3511 for (n = 0; n < signal_data->subscribers->len; n++)
3513 SignalSubscriber *subscriber;
3515 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
3516 if (subscriber->id != subscription_id)
3519 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
3520 GUINT_TO_POINTER (subscription_id)));
3521 g_array_append_val (out_removed_subscribers, *subscriber);
3522 g_array_remove_index (signal_data->subscribers, n);
3524 if (signal_data->subscribers->len == 0)
3526 g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
3528 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3529 signal_data->sender_unique_name);
3530 g_warn_if_fail (signal_data_array != NULL);
3531 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
3533 if (signal_data_array->len == 0)
3535 g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
3536 signal_data->sender_unique_name));
3539 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
3540 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
3541 !is_signal_data_for_name_lost_or_acquired (signal_data) &&
3542 !g_dbus_connection_is_closed (connection) &&
3543 !connection->finalizing)
3545 /* The check for g_dbus_connection_is_closed() means that
3546 * sending the RemoveMatch message can't fail with
3547 * G_IO_ERROR_CLOSED, because we're holding the lock,
3548 * so on_worker_closed() can't happen between the check we just
3549 * did, and releasing the lock later.
3551 remove_match_rule (connection, signal_data->rule);
3554 signal_data_free (signal_data);
3560 g_assert_not_reached ();
3567 * g_dbus_connection_signal_unsubscribe:
3568 * @connection: A #GDBusConnection.
3569 * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
3571 * Unsubscribes from signals.
3576 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
3577 guint subscription_id)
3579 GArray *subscribers;
3582 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3583 g_return_if_fail (check_initialized (connection));
3585 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3587 CONNECTION_LOCK (connection);
3588 unsubscribe_id_internal (connection,
3591 CONNECTION_UNLOCK (connection);
3594 g_assert (subscribers->len == 0 || subscribers->len == 1);
3596 /* call GDestroyNotify without lock held */
3597 for (n = 0; n < subscribers->len; n++)
3599 SignalSubscriber *subscriber;
3600 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3601 call_destroy_notify (subscriber->context,
3602 subscriber->user_data_free_func,
3603 subscriber->user_data);
3604 g_main_context_unref (subscriber->context);
3607 g_array_free (subscribers, TRUE);
3610 /* ---------------------------------------------------------------------------------------------------- */
3614 guint subscription_id;
3615 GDBusSignalCallback callback;
3617 GDBusMessage *message;
3618 GDBusConnection *connection;
3619 const gchar *sender;
3621 const gchar *interface;
3622 const gchar *member;
3625 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
3629 emit_signal_instance_in_idle_cb (gpointer data)
3631 SignalInstance *signal_instance = data;
3632 GVariant *parameters;
3633 gboolean has_subscription;
3635 parameters = g_dbus_message_get_body (signal_instance->message);
3636 if (parameters == NULL)
3638 parameters = g_variant_new ("()");
3639 g_variant_ref_sink (parameters);
3643 g_variant_ref_sink (parameters);
3647 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
3648 signal_instance->subscription_id,
3649 signal_instance->sender,
3650 signal_instance->path,
3651 signal_instance->interface,
3652 signal_instance->member,
3653 g_variant_print (parameters, TRUE));
3656 /* Careful here, don't do the callback if we no longer has the subscription */
3657 CONNECTION_LOCK (signal_instance->connection);
3658 has_subscription = FALSE;
3659 if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
3660 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
3661 has_subscription = TRUE;
3662 CONNECTION_UNLOCK (signal_instance->connection);
3664 if (has_subscription)
3665 signal_instance->callback (signal_instance->connection,
3666 signal_instance->sender,
3667 signal_instance->path,
3668 signal_instance->interface,
3669 signal_instance->member,
3671 signal_instance->user_data);
3673 g_variant_unref (parameters);
3679 signal_instance_free (SignalInstance *signal_instance)
3681 g_object_unref (signal_instance->message);
3682 g_object_unref (signal_instance->connection);
3683 g_free (signal_instance);
3686 /* called in GDBusWorker thread WITH lock held */
3688 schedule_callbacks (GDBusConnection *connection,
3689 GPtrArray *signal_data_array,
3690 GDBusMessage *message,
3691 const gchar *sender)
3694 const gchar *interface;
3695 const gchar *member;
3704 interface = g_dbus_message_get_interface (message);
3705 member = g_dbus_message_get_member (message);
3706 path = g_dbus_message_get_path (message);
3707 arg0 = g_dbus_message_get_arg0 (message);
3710 g_print ("In schedule_callbacks:\n"
3712 " interface = `%s'\n"
3723 /* TODO: if this is slow, then we can change signal_data_array into
3724 * map_object_path_to_signal_data_array or something.
3726 for (n = 0; n < signal_data_array->len; n++)
3728 SignalData *signal_data = signal_data_array->pdata[n];
3730 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
3733 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
3736 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
3739 if (signal_data->arg0 != NULL && g_strcmp0 (signal_data->arg0, arg0) != 0)
3742 for (m = 0; m < signal_data->subscribers->len; m++)
3744 SignalSubscriber *subscriber;
3745 GSource *idle_source;
3746 SignalInstance *signal_instance;
3748 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
3750 signal_instance = g_new0 (SignalInstance, 1);
3751 signal_instance->subscription_id = subscriber->id;
3752 signal_instance->callback = subscriber->callback;
3753 signal_instance->user_data = subscriber->user_data;
3754 signal_instance->message = g_object_ref (message);
3755 signal_instance->connection = g_object_ref (connection);
3756 signal_instance->sender = sender;
3757 signal_instance->path = path;
3758 signal_instance->interface = interface;
3759 signal_instance->member = member;
3761 idle_source = g_idle_source_new ();
3762 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3763 g_source_set_callback (idle_source,
3764 emit_signal_instance_in_idle_cb,
3766 (GDestroyNotify) signal_instance_free);
3767 g_source_attach (idle_source, subscriber->context);
3768 g_source_unref (idle_source);
3773 /* called in GDBusWorker thread with lock held */
3775 distribute_signals (GDBusConnection *connection,
3776 GDBusMessage *message)
3778 GPtrArray *signal_data_array;
3779 const gchar *sender;
3781 sender = g_dbus_message_get_sender (message);
3783 if (G_UNLIKELY (_g_dbus_debug_signal ()))
3785 _g_dbus_debug_print_lock ();
3786 g_print ("========================================================================\n"
3787 "GDBus-debug:Signal:\n"
3788 " <<<< RECEIVED SIGNAL %s.%s\n"
3790 " sent by name %s\n",
3791 g_dbus_message_get_interface (message),
3792 g_dbus_message_get_member (message),
3793 g_dbus_message_get_path (message),
3794 sender != NULL ? sender : "(none)");
3795 _g_dbus_debug_print_unlock ();
3798 /* collect subscribers that match on sender */
3801 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
3802 if (signal_data_array != NULL)
3803 schedule_callbacks (connection, signal_data_array, message, sender);
3806 /* collect subscribers not matching on sender */
3807 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
3808 if (signal_data_array != NULL)
3809 schedule_callbacks (connection, signal_data_array, message, sender);
3812 /* ---------------------------------------------------------------------------------------------------- */
3814 /* only called from finalize(), removes all subscriptions */
3816 purge_all_signal_subscriptions (GDBusConnection *connection)
3818 GHashTableIter iter;
3821 GArray *subscribers;
3824 ids = g_array_new (FALSE, FALSE, sizeof (guint));
3825 g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
3826 while (g_hash_table_iter_next (&iter, &key, NULL))
3828 guint subscription_id = GPOINTER_TO_UINT (key);
3829 g_array_append_val (ids, subscription_id);
3832 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3833 for (n = 0; n < ids->len; n++)
3835 guint subscription_id = g_array_index (ids, guint, n);
3836 unsubscribe_id_internal (connection,
3840 g_array_free (ids, TRUE);
3842 /* call GDestroyNotify without lock held */
3843 for (n = 0; n < subscribers->len; n++)
3845 SignalSubscriber *subscriber;
3846 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3847 call_destroy_notify (subscriber->context,
3848 subscriber->user_data_free_func,
3849 subscriber->user_data);
3850 g_main_context_unref (subscriber->context);
3853 g_array_free (subscribers, TRUE);
3856 /* ---------------------------------------------------------------------------------------------------- */
3858 static GDBusInterfaceVTable *
3859 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
3861 /* Don't waste memory by copying padding - remember to update this
3862 * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
3864 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3868 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
3873 /* ---------------------------------------------------------------------------------------------------- */
3875 static GDBusSubtreeVTable *
3876 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
3878 /* Don't waste memory by copying padding - remember to update this
3879 * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
3881 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3885 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
3890 /* ---------------------------------------------------------------------------------------------------- */
3892 struct ExportedObject
3895 GDBusConnection *connection;
3897 /* maps gchar* -> ExportedInterface* */
3898 GHashTable *map_if_name_to_ei;
3901 /* only called with lock held */
3903 exported_object_free (ExportedObject *eo)
3905 g_free (eo->object_path);
3906 g_hash_table_unref (eo->map_if_name_to_ei);
3915 gchar *interface_name;
3916 GDBusInterfaceVTable *vtable;
3917 GDBusInterfaceInfo *interface_info;
3919 GMainContext *context;
3921 GDestroyNotify user_data_free_func;
3922 } ExportedInterface;
3924 /* called with lock held */
3926 exported_interface_free (ExportedInterface *ei)
3928 g_dbus_interface_info_cache_release (ei->interface_info);
3929 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
3931 call_destroy_notify (ei->context,
3932 ei->user_data_free_func,
3935 g_main_context_unref (ei->context);
3937 g_free (ei->interface_name);
3938 _g_dbus_interface_vtable_free (ei->vtable);
3942 /* ---------------------------------------------------------------------------------------------------- */
3944 /* Convenience function to check if @registration_id (if not zero) or
3945 * @subtree_registration_id (if not zero) has been unregistered. If
3946 * so, returns %TRUE.
3948 * May be called by any thread. Caller must *not* hold lock.
3951 has_object_been_unregistered (GDBusConnection *connection,
3952 guint registration_id,
3953 guint subtree_registration_id)
3957 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3961 CONNECTION_LOCK (connection);
3962 if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
3963 GUINT_TO_POINTER (registration_id)) == NULL)
3967 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
3968 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
3972 CONNECTION_UNLOCK (connection);
3977 /* ---------------------------------------------------------------------------------------------------- */
3981 GDBusConnection *connection;
3982 GDBusMessage *message;
3984 const gchar *property_name;
3985 const GDBusInterfaceVTable *vtable;
3986 GDBusInterfaceInfo *interface_info;
3987 const GDBusPropertyInfo *property_info;
3988 guint registration_id;
3989 guint subtree_registration_id;
3993 property_data_free (PropertyData *data)
3995 g_object_unref (data->connection);
3996 g_object_unref (data->message);
4000 /* called in thread where object was registered - no locks held */
4002 invoke_get_property_in_idle_cb (gpointer _data)
4004 PropertyData *data = _data;
4007 GDBusMessage *reply;
4009 if (has_object_been_unregistered (data->connection,
4010 data->registration_id,
4011 data->subtree_registration_id))
4013 reply = g_dbus_message_new_method_error (data->message,
4014 "org.freedesktop.DBus.Error.UnknownMethod",
4015 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
4016 g_dbus_message_get_path (data->message));
4017 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4018 g_object_unref (reply);
4023 value = data->vtable->get_property (data->connection,
4024 g_dbus_message_get_sender (data->message),
4025 g_dbus_message_get_path (data->message),
4026 data->interface_info->name,
4027 data->property_name,
4034 g_assert_no_error (error);
4036 g_variant_take_ref (value);
4037 reply = g_dbus_message_new_method_reply (data->message);
4038 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
4039 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4040 g_variant_unref (value);
4041 g_object_unref (reply);
4045 gchar *dbus_error_name;
4046 g_assert (error != NULL);
4047 dbus_error_name = g_dbus_error_encode_gerror (error);
4048 reply = g_dbus_message_new_method_error_literal (data->message,
4051 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4052 g_free (dbus_error_name);
4053 g_error_free (error);
4054 g_object_unref (reply);
4061 /* called in thread where object was registered - no locks held */
4063 invoke_set_property_in_idle_cb (gpointer _data)
4065 PropertyData *data = _data;
4067 GDBusMessage *reply;
4073 g_variant_get (g_dbus_message_get_body (data->message),
4079 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
4080 * of the given value is wrong
4082 if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
4084 reply = g_dbus_message_new_method_error (data->message,
4085 "org.freedesktop.DBus.Error.InvalidArgs",
4086 _("Error setting property `%s': Expected type `%s' but got `%s'"),
4087 data->property_info->name,
4088 data->property_info->signature,
4089 g_variant_get_type_string (value));
4093 if (!data->vtable->set_property (data->connection,
4094 g_dbus_message_get_sender (data->message),
4095 g_dbus_message_get_path (data->message),
4096 data->interface_info->name,
4097 data->property_name,
4102 gchar *dbus_error_name;
4103 g_assert (error != NULL);
4104 dbus_error_name = g_dbus_error_encode_gerror (error);
4105 reply = g_dbus_message_new_method_error_literal (data->message,
4108 g_free (dbus_error_name);
4109 g_error_free (error);
4113 reply = g_dbus_message_new_method_reply (data->message);
4117 g_assert (reply != NULL);
4118 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4119 g_object_unref (reply);
4120 g_variant_unref (value);
4125 /* called in any thread with connection's lock held */
4127 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
4128 GDBusMessage *message,
4129 guint registration_id,
4130 guint subtree_registration_id,
4132 GDBusInterfaceInfo *interface_info,
4133 const GDBusInterfaceVTable *vtable,
4134 GMainContext *main_context,
4138 const char *interface_name;
4139 const char *property_name;
4140 const GDBusPropertyInfo *property_info;
4141 GSource *idle_source;
4142 PropertyData *property_data;
4143 GDBusMessage *reply;
4148 g_variant_get (g_dbus_message_get_body (message),
4153 g_variant_get (g_dbus_message_get_body (message),
4162 if (vtable == NULL || vtable->get_property == NULL)
4167 if (vtable == NULL || vtable->set_property == NULL)
4171 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
4173 property_info = NULL;
4175 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4176 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
4177 if (property_info == NULL)
4179 reply = g_dbus_message_new_method_error (message,
4180 "org.freedesktop.DBus.Error.InvalidArgs",
4181 _("No such property `%s'"),
4183 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4184 g_object_unref (reply);
4189 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4191 reply = g_dbus_message_new_method_error (message,
4192 "org.freedesktop.DBus.Error.InvalidArgs",
4193 _("Property `%s' is not readable"),
4195 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4196 g_object_unref (reply);
4200 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
4202 reply = g_dbus_message_new_method_error (message,
4203 "org.freedesktop.DBus.Error.InvalidArgs",
4204 _("Property `%s' is not writable"),
4206 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4207 g_object_unref (reply);
4212 /* ok, got the property info - call user code in an idle handler */
4213 property_data = g_new0 (PropertyData, 1);
4214 property_data->connection = g_object_ref (connection);
4215 property_data->message = g_object_ref (message);
4216 property_data->user_data = user_data;
4217 property_data->property_name = property_name;
4218 property_data->vtable = vtable;
4219 property_data->interface_info = interface_info;
4220 property_data->property_info = property_info;
4221 property_data->registration_id = registration_id;
4222 property_data->subtree_registration_id = subtree_registration_id;
4224 idle_source = g_idle_source_new ();
4225 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4226 g_source_set_callback (idle_source,
4227 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
4229 (GDestroyNotify) property_data_free);
4230 g_source_attach (idle_source, main_context);
4231 g_source_unref (idle_source);
4239 /* called in GDBusWorker thread with connection's lock held */
4241 handle_getset_property (GDBusConnection *connection,
4243 GDBusMessage *message,
4246 ExportedInterface *ei;
4248 const char *interface_name;
4249 const char *property_name;
4254 g_variant_get (g_dbus_message_get_body (message),
4259 g_variant_get (g_dbus_message_get_body (message),
4265 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4266 * no such interface registered
4268 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4271 GDBusMessage *reply;
4272 reply = g_dbus_message_new_method_error (message,
4273 "org.freedesktop.DBus.Error.InvalidArgs",
4274 _("No such interface `%s'"),
4276 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4277 g_object_unref (reply);
4282 handled = validate_and_maybe_schedule_property_getset (eo->connection,
4295 /* ---------------------------------------------------------------------------------------------------- */
4299 GDBusConnection *connection;
4300 GDBusMessage *message;
4302 const GDBusInterfaceVTable *vtable;
4303 GDBusInterfaceInfo *interface_info;
4304 guint registration_id;
4305 guint subtree_registration_id;
4306 } PropertyGetAllData;
4309 property_get_all_data_free (PropertyData *data)
4311 g_object_unref (data->connection);
4312 g_object_unref (data->message);
4316 /* called in thread where object was registered - no locks held */
4318 invoke_get_all_properties_in_idle_cb (gpointer _data)
4320 PropertyGetAllData *data = _data;
4321 GVariantBuilder builder;
4322 GDBusMessage *reply;
4325 if (has_object_been_unregistered (data->connection,
4326 data->registration_id,
4327 data->subtree_registration_id))
4329 reply = g_dbus_message_new_method_error (data->message,
4330 "org.freedesktop.DBus.Error.UnknownMethod",
4331 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
4332 g_dbus_message_get_path (data->message));
4333 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4334 g_object_unref (reply);
4338 /* TODO: Right now we never fail this call - we just omit values if
4339 * a get_property() call is failing.
4341 * We could fail the whole call if just a single get_property() call
4342 * returns an error. We need clarification in the D-Bus spec about this.
4344 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
4345 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
4346 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
4348 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
4351 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4354 value = data->vtable->get_property (data->connection,
4355 g_dbus_message_get_sender (data->message),
4356 g_dbus_message_get_path (data->message),
4357 data->interface_info->name,
4358 property_info->name,
4365 g_variant_take_ref (value);
4366 g_variant_builder_add (&builder,
4368 property_info->name,
4370 g_variant_unref (value);
4372 g_variant_builder_close (&builder);
4374 reply = g_dbus_message_new_method_reply (data->message);
4375 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
4376 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4377 g_object_unref (reply);
4383 /* called in any thread with connection's lock held */
4385 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
4386 GDBusMessage *message,
4387 guint registration_id,
4388 guint subtree_registration_id,
4389 GDBusInterfaceInfo *interface_info,
4390 const GDBusInterfaceVTable *vtable,
4391 GMainContext *main_context,
4395 const char *interface_name;
4396 GSource *idle_source;
4397 PropertyGetAllData *property_get_all_data;
4401 g_variant_get (g_dbus_message_get_body (message),
4405 if (vtable == NULL || vtable->get_property == NULL)
4408 /* ok, got the property info - call user in an idle handler */
4409 property_get_all_data = g_new0 (PropertyGetAllData, 1);
4410 property_get_all_data->connection = g_object_ref (connection);
4411 property_get_all_data->message = g_object_ref (message);
4412 property_get_all_data->user_data = user_data;
4413 property_get_all_data->vtable = vtable;
4414 property_get_all_data->interface_info = interface_info;
4415 property_get_all_data->registration_id = registration_id;
4416 property_get_all_data->subtree_registration_id = subtree_registration_id;
4418 idle_source = g_idle_source_new ();
4419 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4420 g_source_set_callback (idle_source,
4421 invoke_get_all_properties_in_idle_cb,
4422 property_get_all_data,
4423 (GDestroyNotify) property_get_all_data_free);
4424 g_source_attach (idle_source, main_context);
4425 g_source_unref (idle_source);
4433 /* called in GDBusWorker thread with connection's lock held */
4435 handle_get_all_properties (GDBusConnection *connection,
4437 GDBusMessage *message)
4439 ExportedInterface *ei;
4441 const char *interface_name;
4445 g_variant_get (g_dbus_message_get_body (message),
4449 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4450 * no such interface registered
4452 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4455 GDBusMessage *reply;
4456 reply = g_dbus_message_new_method_error (message,
4457 "org.freedesktop.DBus.Error.InvalidArgs",
4458 _("No such interface"),
4460 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4461 g_object_unref (reply);
4466 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
4478 /* ---------------------------------------------------------------------------------------------------- */
4480 static const gchar introspect_header[] =
4481 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
4482 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
4483 "<!-- GDBus " PACKAGE_VERSION " -->\n"
4486 static const gchar introspect_tail[] =
4489 static const gchar introspect_properties_interface[] =
4490 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
4491 " <method name=\"Get\">\n"
4492 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4493 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4494 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
4496 " <method name=\"GetAll\">\n"
4497 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4498 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
4500 " <method name=\"Set\">\n"
4501 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4502 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4503 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
4505 " <signal name=\"PropertiesChanged\">\n"
4506 " <arg type=\"s\" name=\"interface_name\"/>\n"
4507 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
4508 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
4512 static const gchar introspect_introspectable_interface[] =
4513 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
4514 " <method name=\"Introspect\">\n"
4515 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
4518 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
4519 " <method name=\"Ping\"/>\n"
4520 " <method name=\"GetMachineId\">\n"
4521 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
4526 introspect_append_header (GString *s)
4528 g_string_append (s, introspect_header);
4532 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
4534 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
4540 begin = object_path + path_len;
4541 end = strchr (begin, '/');
4543 s = g_strndup (begin, end - begin);
4545 s = g_strdup (begin);
4547 if (g_hash_table_lookup (set, s) == NULL)
4548 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
4554 /* TODO: we want a nicer public interface for this */
4555 /* called in any thread with connection's lock held */
4557 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
4562 GHashTableIter hash_iter;
4563 const gchar *object_path;
4569 CONNECTION_ENSURE_LOCK (connection);
4571 path_len = strlen (path);
4575 set = g_hash_table_new (g_str_hash, g_str_equal);
4577 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
4578 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4579 maybe_add_path (path, path_len, object_path, set);
4581 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
4582 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4583 maybe_add_path (path, path_len, object_path, set);
4585 p = g_ptr_array_new ();
4586 keys = g_hash_table_get_keys (set);
4587 for (l = keys; l != NULL; l = l->next)
4588 g_ptr_array_add (p, l->data);
4589 g_hash_table_unref (set);
4592 g_ptr_array_add (p, NULL);
4593 ret = (gchar **) g_ptr_array_free (p, FALSE);
4597 /* called in any thread with connection's lock not held */
4599 g_dbus_connection_list_registered (GDBusConnection *connection,
4603 CONNECTION_LOCK (connection);
4604 ret = g_dbus_connection_list_registered_unlocked (connection, path);
4605 CONNECTION_UNLOCK (connection);
4609 /* called in GDBusWorker thread with connection's lock held */
4611 handle_introspect (GDBusConnection *connection,
4613 GDBusMessage *message)
4617 GDBusMessage *reply;
4618 GHashTableIter hash_iter;
4619 ExportedInterface *ei;
4622 /* first the header with the standard interfaces */
4623 s = g_string_sized_new (sizeof (introspect_header) +
4624 sizeof (introspect_properties_interface) +
4625 sizeof (introspect_introspectable_interface) +
4626 sizeof (introspect_tail));
4627 introspect_append_header (s);
4628 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4629 "org.freedesktop.DBus.Properties"))
4630 g_string_append (s, introspect_properties_interface);
4632 if (!g_hash_table_lookup (eo->map_if_name_to_ei,
4633 "org.freedesktop.DBus.Introspectable"))
4634 g_string_append (s, introspect_introspectable_interface);
4636 /* then include the registered interfaces */
4637 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
4638 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
4639 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
4641 /* finally include nodes registered below us */
4642 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
4643 for (n = 0; registered != NULL && registered[n] != NULL; n++)
4644 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
4645 g_strfreev (registered);
4646 g_string_append (s, introspect_tail);
4648 reply = g_dbus_message_new_method_reply (message);
4649 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4650 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4651 g_object_unref (reply);
4652 g_string_free (s, TRUE);
4657 /* called in thread where object was registered - no locks held */
4659 call_in_idle_cb (gpointer user_data)
4661 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
4662 GDBusInterfaceVTable *vtable;
4663 guint registration_id;
4664 guint subtree_registration_id;
4666 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
4667 g_assert (vtable != NULL && vtable->method_call != NULL);
4669 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
4670 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
4672 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
4674 subtree_registration_id))
4676 GDBusMessage *reply;
4677 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
4678 "org.freedesktop.DBus.Error.UnknownMethod",
4679 _("No such interface `%s' on object at path %s"),
4680 g_dbus_method_invocation_get_interface_name (invocation),
4681 g_dbus_method_invocation_get_object_path (invocation));
4682 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4683 g_object_unref (reply);
4687 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
4688 g_dbus_method_invocation_get_sender (invocation),
4689 g_dbus_method_invocation_get_object_path (invocation),
4690 g_dbus_method_invocation_get_interface_name (invocation),
4691 g_dbus_method_invocation_get_method_name (invocation),
4692 g_dbus_method_invocation_get_parameters (invocation),
4693 g_object_ref (invocation),
4694 g_dbus_method_invocation_get_user_data (invocation));
4700 /* called in GDBusWorker thread with connection's lock held */
4702 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
4703 GDBusMessage *message,
4704 guint registration_id,
4705 guint subtree_registration_id,
4706 GDBusInterfaceInfo *interface_info,
4707 const GDBusInterfaceVTable *vtable,
4708 GMainContext *main_context,
4711 GDBusMethodInvocation *invocation;
4712 const GDBusMethodInfo *method_info;
4713 GDBusMessage *reply;
4714 GVariant *parameters;
4715 GSource *idle_source;
4717 GVariantType *in_type;
4721 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4722 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
4724 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
4725 * error to the caller
4727 if (method_info == NULL)
4729 reply = g_dbus_message_new_method_error (message,
4730 "org.freedesktop.DBus.Error.UnknownMethod",
4731 _("No such method `%s'"),
4732 g_dbus_message_get_member (message));
4733 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4734 g_object_unref (reply);
4739 parameters = g_dbus_message_get_body (message);
4740 if (parameters == NULL)
4742 parameters = g_variant_new ("()");
4743 g_variant_ref_sink (parameters);
4747 g_variant_ref (parameters);
4750 /* Check that the incoming args are of the right type - if they are not, return
4751 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
4753 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
4754 if (!g_variant_is_of_type (parameters, in_type))
4758 type_string = g_variant_type_dup_string (in_type);
4760 reply = g_dbus_message_new_method_error (message,
4761 "org.freedesktop.DBus.Error.InvalidArgs",
4762 _("Type of message, `%s', does not match expected type `%s'"),
4763 g_variant_get_type_string (parameters),
4765 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4766 g_variant_type_free (in_type);
4767 g_variant_unref (parameters);
4768 g_object_unref (reply);
4769 g_free (type_string);
4773 g_variant_type_free (in_type);
4775 /* schedule the call in idle */
4776 invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
4777 g_dbus_message_get_path (message),
4778 g_dbus_message_get_interface (message),
4779 g_dbus_message_get_member (message),
4785 g_variant_unref (parameters);
4787 /* TODO: would be nicer with a real MethodData like we already
4788 * have PropertyData and PropertyGetAllData... */
4789 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
4790 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
4791 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
4793 idle_source = g_idle_source_new ();
4794 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4795 g_source_set_callback (idle_source,
4799 g_source_attach (idle_source, main_context);
4800 g_source_unref (idle_source);
4808 /* ---------------------------------------------------------------------------------------------------- */
4810 /* called in GDBusWorker thread with connection's lock held */
4812 obj_message_func (GDBusConnection *connection,
4814 GDBusMessage *message)
4816 const gchar *interface_name;
4817 const gchar *member;
4818 const gchar *signature;
4823 interface_name = g_dbus_message_get_interface (message);
4824 member = g_dbus_message_get_member (message);
4825 signature = g_dbus_message_get_signature (message);
4827 /* see if we have an interface for handling this call */
4828 if (interface_name != NULL)
4830 ExportedInterface *ei;
4831 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4834 /* we do - invoke the handler in idle in the right thread */
4836 /* handle no vtable or handler being present */
4837 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
4840 handled = validate_and_maybe_schedule_method_call (connection,
4852 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
4853 g_strcmp0 (member, "Introspect") == 0 &&
4854 g_strcmp0 (signature, "") == 0)
4856 handled = handle_introspect (connection, eo, message);
4859 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4860 g_strcmp0 (member, "Get") == 0 &&
4861 g_strcmp0 (signature, "ss") == 0)
4863 handled = handle_getset_property (connection, eo, message, TRUE);
4866 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4867 g_strcmp0 (member, "Set") == 0 &&
4868 g_strcmp0 (signature, "ssv") == 0)
4870 handled = handle_getset_property (connection, eo, message, FALSE);
4873 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4874 g_strcmp0 (member, "GetAll") == 0 &&
4875 g_strcmp0 (signature, "s") == 0)
4877 handled = handle_get_all_properties (connection, eo, message);
4886 * g_dbus_connection_register_object:
4887 * @connection: A #GDBusConnection.
4888 * @object_path: The object path to register at.
4889 * @interface_info: Introspection data for the interface.
4890 * @vtable: (allow-none): A #GDBusInterfaceVTable to call into or %NULL.
4891 * @user_data: (allow-none): Data to pass to functions in @vtable.
4892 * @user_data_free_func: Function to call when the object path is unregistered.
4893 * @error: Return location for error or %NULL.
4895 * Registers callbacks for exported objects at @object_path with the
4896 * D-Bus interface that is described in @interface_info.
4898 * Calls to functions in @vtable (and @user_data_free_func) will
4899 * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
4900 * loop</link> of the thread you are calling this method from.
4902 * Note that all #GVariant values passed to functions in @vtable will match
4903 * the signature given in @interface_info - if a remote caller passes
4904 * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
4905 * is returned to the remote caller.
4907 * Additionally, if the remote caller attempts to invoke methods or
4908 * access properties not mentioned in @interface_info the
4909 * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
4910 * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
4911 * are returned to the caller.
4913 * It is considered a programming error if the
4914 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
4915 * #GVariant of incorrect type.
4917 * If an existing callback is already registered at @object_path and
4918 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
4920 * GDBus automatically implements the standard D-Bus interfaces
4921 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
4922 * and org.freedesktop.Peer, so you don't have to implement those for
4923 * the objects you export. You <emphasis>can</emphasis> implement
4924 * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
4925 * and setting of properties asynchronously.
4927 * Note that the reference count on @interface_info will be
4928 * incremented by 1 (unless allocated statically, e.g. if the
4929 * reference count is -1, see g_dbus_interface_info_ref()) for as long
4930 * as the object is exported. Also note that @vtable will be copied.
4932 * See <xref linkend="gdbus-server"/> for an example of how to use this method.
4934 * Returns: 0 if @error is set, otherwise a registration id (never 0)
4935 * that can be used with g_dbus_connection_unregister_object() .
4940 g_dbus_connection_register_object (GDBusConnection *connection,
4941 const gchar *object_path,
4942 GDBusInterfaceInfo *interface_info,
4943 const GDBusInterfaceVTable *vtable,
4945 GDestroyNotify user_data_free_func,
4949 ExportedInterface *ei;
4952 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4953 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
4954 g_return_val_if_fail (interface_info != NULL, 0);
4955 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
4956 g_return_val_if_fail (error == NULL || *error == NULL, 0);
4957 g_return_val_if_fail (check_initialized (connection), 0);
4961 CONNECTION_LOCK (connection);
4963 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
4966 eo = g_new0 (ExportedObject, 1);
4967 eo->object_path = g_strdup (object_path);
4968 eo->connection = connection;
4969 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
4972 (GDestroyNotify) exported_interface_free);
4973 g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
4976 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
4982 _("An object is already exported for the interface %s at %s"),
4983 interface_info->name,
4988 ei = g_new0 (ExportedInterface, 1);
4989 ei->id = _global_registration_id++; /* TODO: overflow etc. */
4991 ei->user_data = user_data;
4992 ei->user_data_free_func = user_data_free_func;
4993 ei->vtable = _g_dbus_interface_vtable_copy (vtable);
4994 ei->interface_info = g_dbus_interface_info_ref (interface_info);
4995 g_dbus_interface_info_cache_build (ei->interface_info);
4996 ei->interface_name = g_strdup (interface_info->name);
4997 ei->context = g_main_context_ref_thread_default ();
4999 g_hash_table_insert (eo->map_if_name_to_ei,
5000 (gpointer) ei->interface_name,
5002 g_hash_table_insert (connection->map_id_to_ei,
5003 GUINT_TO_POINTER (ei->id),
5009 CONNECTION_UNLOCK (connection);
5015 * g_dbus_connection_unregister_object:
5016 * @connection: A #GDBusConnection.
5017 * @registration_id: A registration id obtained from g_dbus_connection_register_object().
5019 * Unregisters an object.
5021 * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
5026 g_dbus_connection_unregister_object (GDBusConnection *connection,
5027 guint registration_id)
5029 ExportedInterface *ei;
5033 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5034 g_return_val_if_fail (check_initialized (connection), FALSE);
5038 CONNECTION_LOCK (connection);
5040 ei = g_hash_table_lookup (connection->map_id_to_ei,
5041 GUINT_TO_POINTER (registration_id));
5047 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
5048 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
5049 /* unregister object path if we have no more exported interfaces */
5050 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
5051 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
5057 CONNECTION_UNLOCK (connection);
5062 /* ---------------------------------------------------------------------------------------------------- */
5065 * g_dbus_connection_emit_signal:
5066 * @connection: A #GDBusConnection.
5067 * @destination_bus_name: (allow-none): The unique bus name for the destination
5068 * for the signal or %NULL to emit to all listeners.
5069 * @object_path: Path of remote object.
5070 * @interface_name: D-Bus interface to emit a signal on.
5071 * @signal_name: The name of the signal to emit.
5072 * @parameters: (allow-none): A #GVariant tuple with parameters for the signal
5073 * or %NULL if not passing parameters.
5074 * @error: Return location for error or %NULL.
5078 * If the parameters GVariant is floating, it is consumed.
5080 * This can only fail if @parameters is not compatible with the D-Bus protocol.
5082 * Returns: %TRUE unless @error is set.
5087 g_dbus_connection_emit_signal (GDBusConnection *connection,
5088 const gchar *destination_bus_name,
5089 const gchar *object_path,
5090 const gchar *interface_name,
5091 const gchar *signal_name,
5092 GVariant *parameters,
5095 GDBusMessage *message;
5101 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5102 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
5103 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
5104 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
5105 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
5106 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
5107 g_return_val_if_fail (check_initialized (connection), FALSE);
5109 if (G_UNLIKELY (_g_dbus_debug_emission ()))
5111 _g_dbus_debug_print_lock ();
5112 g_print ("========================================================================\n"
5113 "GDBus-debug:Emission:\n"
5114 " >>>> SIGNAL EMISSION %s.%s()\n"
5116 " destination %s\n",
5117 interface_name, signal_name,
5119 destination_bus_name != NULL ? destination_bus_name : "(none)");
5120 _g_dbus_debug_print_unlock ();
5123 message = g_dbus_message_new_signal (object_path,
5127 if (destination_bus_name != NULL)
5128 g_dbus_message_set_header (message,
5129 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
5130 g_variant_new_string (destination_bus_name));
5132 if (parameters != NULL)
5133 g_dbus_message_set_body (message, parameters);
5135 ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
5136 g_object_unref (message);
5142 add_call_flags (GDBusMessage *message,
5143 GDBusCallFlags flags)
5145 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
5146 g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
5150 decode_method_reply (GDBusMessage *reply,
5151 const gchar *method_name,
5152 const GVariantType *reply_type,
5153 GUnixFDList **out_fd_list,
5159 switch (g_dbus_message_get_message_type (reply))
5161 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
5162 result = g_dbus_message_get_body (reply);
5165 result = g_variant_new ("()");
5166 g_variant_ref_sink (result);
5170 g_variant_ref (result);
5173 if (!g_variant_is_of_type (result, reply_type))
5175 gchar *type_string = g_variant_type_dup_string (reply_type);
5179 G_IO_ERROR_INVALID_ARGUMENT,
5180 _("Method `%s' returned type `%s', but expected `%s'"),
5181 method_name, g_variant_get_type_string (result), type_string);
5183 g_variant_unref (result);
5184 g_free (type_string);
5191 if (out_fd_list != NULL)
5193 *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
5194 if (*out_fd_list != NULL)
5195 g_object_ref (*out_fd_list);
5201 case G_DBUS_MESSAGE_TYPE_ERROR:
5202 g_dbus_message_to_gerror (reply, error);
5206 g_assert_not_reached ();
5216 GSimpleAsyncResult *simple;
5217 GVariantType *reply_type;
5218 gchar *method_name; /* for error message */
5222 GUnixFDList *fd_list;
5226 call_state_free (CallState *state)
5228 g_variant_type_free (state->reply_type);
5229 g_free (state->method_name);
5231 if (state->value != NULL)
5232 g_variant_unref (state->value);
5233 if (state->fd_list != NULL)
5234 g_object_unref (state->fd_list);
5235 g_slice_free (CallState, state);
5238 /* called in any thread, with the connection's lock not held */
5240 g_dbus_connection_call_done (GObject *source,
5241 GAsyncResult *result,
5244 GSimpleAsyncResult *simple;
5245 GDBusConnection *connection = G_DBUS_CONNECTION (source);
5246 CallState *state = user_data;
5248 GDBusMessage *reply;
5251 reply = g_dbus_connection_send_message_with_reply_finish (connection,
5255 if (G_UNLIKELY (_g_dbus_debug_call ()))
5257 _g_dbus_debug_print_lock ();
5258 g_print ("========================================================================\n"
5259 "GDBus-debug:Call:\n"
5260 " <<<< ASYNC COMPLETE %s() (serial %d)\n"
5266 g_print ("SUCCESS\n");
5270 g_print ("FAILED: %s\n",
5273 _g_dbus_debug_print_unlock ();
5277 state->value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
5279 simple = state->simple; /* why? because state is freed before we unref simple.. */
5282 g_simple_async_result_take_error (state->simple, error);
5283 g_simple_async_result_complete (state->simple);
5284 call_state_free (state);
5288 g_simple_async_result_set_op_res_gpointer (state->simple, state, (GDestroyNotify) call_state_free);
5289 g_simple_async_result_complete (state->simple);
5291 g_clear_object (&reply);
5292 g_object_unref (simple);
5295 /* called in any thread, with the connection's lock not held */
5297 g_dbus_connection_call_internal (GDBusConnection *connection,
5298 const gchar *bus_name,
5299 const gchar *object_path,
5300 const gchar *interface_name,
5301 const gchar *method_name,
5302 GVariant *parameters,
5303 const GVariantType *reply_type,
5304 GDBusCallFlags flags,
5306 GUnixFDList *fd_list,
5307 GCancellable *cancellable,
5308 GAsyncReadyCallback callback,
5311 GDBusMessage *message;
5314 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
5315 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
5316 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
5317 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
5318 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
5319 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
5320 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
5321 g_return_if_fail (check_initialized (connection));
5323 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
5325 g_return_if_fail (fd_list == NULL);
5328 state = g_slice_new0 (CallState);
5329 state->simple = g_simple_async_result_new (G_OBJECT (connection),
5330 callback, user_data,
5331 g_dbus_connection_call_internal);
5332 g_simple_async_result_set_check_cancellable (state->simple, cancellable);
5333 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
5335 if (reply_type == NULL)
5336 reply_type = G_VARIANT_TYPE_ANY;
5338 state->reply_type = g_variant_type_copy (reply_type);
5340 message = g_dbus_message_new_method_call (bus_name,
5344 add_call_flags (message, flags);
5345 if (parameters != NULL)
5346 g_dbus_message_set_body (message, parameters);
5349 if (fd_list != NULL)
5350 g_dbus_message_set_unix_fd_list (message, fd_list);
5353 g_dbus_connection_send_message_with_reply (connection,
5355 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5359 g_dbus_connection_call_done,
5362 if (G_UNLIKELY (_g_dbus_debug_call ()))
5364 _g_dbus_debug_print_lock ();
5365 g_print ("========================================================================\n"
5366 "GDBus-debug:Call:\n"
5367 " >>>> ASYNC %s.%s()\n"
5369 " owned by name %s (serial %d)\n",
5373 bus_name != NULL ? bus_name : "(none)",
5375 _g_dbus_debug_print_unlock ();
5378 if (message != NULL)
5379 g_object_unref (message);
5382 /* called in any thread, with the connection's lock not held */
5384 g_dbus_connection_call_finish_internal (GDBusConnection *connection,
5385 GUnixFDList **out_fd_list,
5389 GSimpleAsyncResult *simple;
5392 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5393 g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
5394 g_dbus_connection_call_internal), NULL);
5395 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5397 simple = G_SIMPLE_ASYNC_RESULT (res);
5399 if (g_simple_async_result_propagate_error (simple, error))
5402 state = g_simple_async_result_get_op_res_gpointer (simple);
5403 if (out_fd_list != NULL)
5404 *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
5405 return g_variant_ref (state->value);
5408 /* called in any user thread, with the connection's lock not held */
5410 g_dbus_connection_call_sync_internal (GDBusConnection *connection,
5411 const gchar *bus_name,
5412 const gchar *object_path,
5413 const gchar *interface_name,
5414 const gchar *method_name,
5415 GVariant *parameters,
5416 const GVariantType *reply_type,
5417 GDBusCallFlags flags,
5419 GUnixFDList *fd_list,
5420 GUnixFDList **out_fd_list,
5421 GCancellable *cancellable,
5424 GDBusMessage *message;
5425 GDBusMessage *reply;
5427 GError *local_error;
5428 GDBusSendMessageFlags send_flags;
5434 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5435 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
5436 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
5437 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
5438 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
5439 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
5440 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
5442 g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
5444 g_return_val_if_fail (fd_list == NULL, NULL);
5446 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5448 if (!(flags & CALL_FLAGS_INITIALIZING))
5449 g_return_val_if_fail (check_initialized (connection), FALSE);
5451 if (reply_type == NULL)
5452 reply_type = G_VARIANT_TYPE_ANY;
5454 message = g_dbus_message_new_method_call (bus_name,
5458 add_call_flags (message, flags);
5459 if (parameters != NULL)
5460 g_dbus_message_set_body (message, parameters);
5463 if (fd_list != NULL)
5464 g_dbus_message_set_unix_fd_list (message, fd_list);
5467 if (G_UNLIKELY (_g_dbus_debug_call ()))
5469 _g_dbus_debug_print_lock ();
5470 g_print ("========================================================================\n"
5471 "GDBus-debug:Call:\n"
5472 " >>>> SYNC %s.%s()\n"
5474 " owned by name %s\n",
5478 bus_name != NULL ? bus_name : "(none)");
5479 _g_dbus_debug_print_unlock ();
5484 send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
5486 /* translate from one flavour of flags to another... */
5487 if (flags & CALL_FLAGS_INITIALIZING)
5488 send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
5490 reply = g_dbus_connection_send_message_with_reply_sync (connection,
5494 NULL, /* volatile guint32 *out_serial */
5498 if (G_UNLIKELY (_g_dbus_debug_call ()))
5500 _g_dbus_debug_print_lock ();
5501 g_print ("========================================================================\n"
5502 "GDBus-debug:Call:\n"
5503 " <<<< SYNC COMPLETE %s.%s()\n"
5509 g_print ("SUCCESS\n");
5513 g_print ("FAILED: %s\n",
5514 local_error->message);
5516 _g_dbus_debug_print_unlock ();
5522 *error = local_error;
5524 g_error_free (local_error);
5528 result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
5531 if (message != NULL)
5532 g_object_unref (message);
5534 g_object_unref (reply);
5539 /* ---------------------------------------------------------------------------------------------------- */
5542 * g_dbus_connection_call:
5543 * @connection: A #GDBusConnection.
5544 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5545 * @connection is not a message bus connection.
5546 * @object_path: Path of remote object.
5547 * @interface_name: D-Bus interface to invoke method on.
5548 * @method_name: The name of the method to invoke.
5549 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5550 * or %NULL if not passing parameters.
5551 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5552 * @flags: Flags from the #GDBusCallFlags enumeration.
5553 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5554 * timeout or %G_MAXINT for no timeout.
5555 * @cancellable: A #GCancellable or %NULL.
5556 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
5557 * satisfied or %NULL if you don't care about the result of the
5558 * method invocation.
5559 * @user_data: The data to pass to @callback.
5561 * Asynchronously invokes the @method_name method on the
5562 * @interface_name D-Bus interface on the remote object at
5563 * @object_path owned by @bus_name.
5565 * If @connection is closed then the operation will fail with
5566 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
5567 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
5568 * not compatible with the D-Bus protocol, the operation fails with
5569 * %G_IO_ERROR_INVALID_ARGUMENT.
5571 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
5572 * error will be raised if it does not match. Said another way, if you give a @reply_type
5573 * then any non-%NULL return value will be of this type.
5575 * If the @parameters #GVariant is floating, it is consumed. This allows
5576 * convenient 'inline' use of g_variant_new(), e.g.:
5578 * g_dbus_connection_call (connection,
5579 * "org.freedesktop.StringThings",
5580 * "/org/freedesktop/StringThings",
5581 * "org.freedesktop.StringThings",
5583 * g_variant_new ("(ss)",
5587 * G_DBUS_CALL_FLAGS_NONE,
5590 * (GAsyncReadyCallback) two_strings_done,
5594 * This is an asynchronous method. When the operation is finished, @callback will be invoked
5595 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
5596 * of the thread you are calling this method from. You can then call
5597 * g_dbus_connection_call_finish() to get the result of the operation.
5598 * See g_dbus_connection_call_sync() for the synchronous version of this
5604 g_dbus_connection_call (GDBusConnection *connection,
5605 const gchar *bus_name,
5606 const gchar *object_path,
5607 const gchar *interface_name,
5608 const gchar *method_name,
5609 GVariant *parameters,
5610 const GVariantType *reply_type,
5611 GDBusCallFlags flags,
5613 GCancellable *cancellable,
5614 GAsyncReadyCallback callback,
5617 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);
5621 * g_dbus_connection_call_finish:
5622 * @connection: A #GDBusConnection.
5623 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
5624 * @error: Return location for error or %NULL.
5626 * Finishes an operation started with g_dbus_connection_call().
5628 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5629 * return values. Free with g_variant_unref().
5634 g_dbus_connection_call_finish (GDBusConnection *connection,
5638 return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
5642 * g_dbus_connection_call_sync:
5643 * @connection: A #GDBusConnection.
5644 * @bus_name: A unique or well-known bus name.
5645 * @object_path: Path of remote object.
5646 * @interface_name: D-Bus interface to invoke method on.
5647 * @method_name: The name of the method to invoke.
5648 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5649 * or %NULL if not passing parameters.
5650 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5651 * @flags: Flags from the #GDBusCallFlags enumeration.
5652 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5653 * timeout or %G_MAXINT for no timeout.
5654 * @cancellable: A #GCancellable or %NULL.
5655 * @error: Return location for error or %NULL.
5657 * Synchronously invokes the @method_name method on the
5658 * @interface_name D-Bus interface on the remote object at
5659 * @object_path owned by @bus_name.
5661 * If @connection is closed then the operation will fail with
5662 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
5663 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
5664 * contains a value not compatible with the D-Bus protocol, the operation
5665 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
5667 * If @reply_type is non-%NULL then the reply will be checked for having
5668 * this type and an error will be raised if it does not match. Said
5669 * another way, if you give a @reply_type then any non-%NULL return
5670 * value will be of this type.
5672 * If the @parameters #GVariant is floating, it is consumed.
5673 * This allows convenient 'inline' use of g_variant_new(), e.g.:
5675 * g_dbus_connection_call_sync (connection,
5676 * "org.freedesktop.StringThings",
5677 * "/org/freedesktop/StringThings",
5678 * "org.freedesktop.StringThings",
5680 * g_variant_new ("(ss)",
5684 * G_DBUS_CALL_FLAGS_NONE,
5690 * The calling thread is blocked until a reply is received. See
5691 * g_dbus_connection_call() for the asynchronous version of
5694 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5695 * return values. Free with g_variant_unref().
5700 g_dbus_connection_call_sync (GDBusConnection *connection,
5701 const gchar *bus_name,
5702 const gchar *object_path,
5703 const gchar *interface_name,
5704 const gchar *method_name,
5705 GVariant *parameters,
5706 const GVariantType *reply_type,
5707 GDBusCallFlags flags,
5709 GCancellable *cancellable,
5712 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);
5715 /* ---------------------------------------------------------------------------------------------------- */
5720 * g_dbus_connection_call_with_unix_fd_list:
5721 * @connection: A #GDBusConnection.
5722 * @bus_name: (allow-none): A unique or well-known bus name or %NULL if
5723 * @connection is not a message bus connection.
5724 * @object_path: Path of remote object.
5725 * @interface_name: D-Bus interface to invoke method on.
5726 * @method_name: The name of the method to invoke.
5727 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5728 * or %NULL if not passing parameters.
5729 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5730 * @flags: Flags from the #GDBusCallFlags enumeration.
5731 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5732 * timeout or %G_MAXINT for no timeout.
5733 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
5734 * @cancellable: A #GCancellable or %NULL.
5735 * @callback: (allow-none): A #GAsyncReadyCallback to call when the request is
5736 * satisfied or %NULL if you don't * care about the result of the
5737 * method invocation.
5738 * @user_data: The data to pass to @callback.
5740 * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
5742 * This method is only available on UNIX.
5747 g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
5748 const gchar *bus_name,
5749 const gchar *object_path,
5750 const gchar *interface_name,
5751 const gchar *method_name,
5752 GVariant *parameters,
5753 const GVariantType *reply_type,
5754 GDBusCallFlags flags,
5756 GUnixFDList *fd_list,
5757 GCancellable *cancellable,
5758 GAsyncReadyCallback callback,
5761 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);
5765 * g_dbus_connection_call_with_unix_fd_list_finish:
5766 * @connection: A #GDBusConnection.
5767 * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.
5768 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list().
5769 * @error: Return location for error or %NULL.
5771 * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
5773 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5774 * return values. Free with g_variant_unref().
5779 g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
5780 GUnixFDList **out_fd_list,
5784 return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
5788 * g_dbus_connection_call_with_unix_fd_list_sync:
5789 * @connection: A #GDBusConnection.
5790 * @bus_name: A unique or well-known bus name.
5791 * @object_path: Path of remote object.
5792 * @interface_name: D-Bus interface to invoke method on.
5793 * @method_name: The name of the method to invoke.
5794 * @parameters: (allow-none): A #GVariant tuple with parameters for the method
5795 * or %NULL if not passing parameters.
5796 * @reply_type: (allow-none): The expected type of the reply, or %NULL.
5797 * @flags: Flags from the #GDBusCallFlags enumeration.
5798 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5799 * timeout or %G_MAXINT for no timeout.
5800 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
5801 * @out_fd_list: (out): Return location for a #GUnixFDList or %NULL.
5802 * @cancellable: A #GCancellable or %NULL.
5803 * @error: Return location for error or %NULL.
5805 * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
5807 * This method is only available on UNIX.
5809 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5810 * return values. Free with g_variant_unref().
5815 g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
5816 const gchar *bus_name,
5817 const gchar *object_path,
5818 const gchar *interface_name,
5819 const gchar *method_name,
5820 GVariant *parameters,
5821 const GVariantType *reply_type,
5822 GDBusCallFlags flags,
5824 GUnixFDList *fd_list,
5825 GUnixFDList **out_fd_list,
5826 GCancellable *cancellable,
5829 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);
5832 #endif /* G_OS_UNIX */
5834 /* ---------------------------------------------------------------------------------------------------- */
5836 struct ExportedSubtree
5840 GDBusConnection *connection;
5841 GDBusSubtreeVTable *vtable;
5842 GDBusSubtreeFlags flags;
5844 GMainContext *context;
5846 GDestroyNotify user_data_free_func;
5850 exported_subtree_free (ExportedSubtree *es)
5852 call_destroy_notify (es->context,
5853 es->user_data_free_func,
5856 g_main_context_unref (es->context);
5858 _g_dbus_subtree_vtable_free (es->vtable);
5859 g_free (es->object_path);
5863 /* called without lock held in the thread where the caller registered
5867 handle_subtree_introspect (GDBusConnection *connection,
5868 ExportedSubtree *es,
5869 GDBusMessage *message)
5873 GDBusMessage *reply;
5876 const gchar *sender;
5877 const gchar *requested_object_path;
5878 const gchar *requested_node;
5879 GDBusInterfaceInfo **interfaces;
5881 gchar **subnode_paths;
5882 gboolean has_properties_interface;
5883 gboolean has_introspectable_interface;
5887 requested_object_path = g_dbus_message_get_path (message);
5888 sender = g_dbus_message_get_sender (message);
5889 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
5891 s = g_string_new (NULL);
5892 introspect_append_header (s);
5894 /* Strictly we don't need the children in dynamic mode, but we avoid the
5895 * conditionals to preserve code clarity
5897 children = es->vtable->enumerate (es->connection,
5904 requested_node = strrchr (requested_object_path, '/') + 1;
5906 /* Assert existence of object if we are not dynamic */
5907 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
5908 !_g_strv_has_string ((const gchar * const *) children, requested_node))
5913 requested_node = NULL;
5916 interfaces = es->vtable->introspect (es->connection,
5921 if (interfaces != NULL)
5923 has_properties_interface = FALSE;
5924 has_introspectable_interface = FALSE;
5926 for (n = 0; interfaces[n] != NULL; n++)
5928 if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
5929 has_properties_interface = TRUE;
5930 else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
5931 has_introspectable_interface = TRUE;
5933 if (!has_properties_interface)
5934 g_string_append (s, introspect_properties_interface);
5935 if (!has_introspectable_interface)
5936 g_string_append (s, introspect_introspectable_interface);
5938 for (n = 0; interfaces[n] != NULL; n++)
5940 g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
5941 g_dbus_interface_info_unref (interfaces[n]);
5943 g_free (interfaces);
5946 /* then include <node> entries from the Subtree for the root */
5949 for (n = 0; children != NULL && children[n] != NULL; n++)
5950 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
5953 /* finally include nodes registered below us */
5954 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
5955 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
5956 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
5957 g_strfreev (subnode_paths);
5959 g_string_append (s, "</node>\n");
5961 reply = g_dbus_message_new_method_reply (message);
5962 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5963 g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5964 g_object_unref (reply);
5969 g_string_free (s, TRUE);
5970 g_strfreev (children);
5974 /* called without lock held in the thread where the caller registered
5978 handle_subtree_method_invocation (GDBusConnection *connection,
5979 ExportedSubtree *es,
5980 GDBusMessage *message)
5983 const gchar *sender;
5984 const gchar *interface_name;
5985 const gchar *member;
5986 const gchar *signature;
5987 const gchar *requested_object_path;
5988 const gchar *requested_node;
5990 GDBusInterfaceInfo *interface_info;
5991 const GDBusInterfaceVTable *interface_vtable;
5992 gpointer interface_user_data;
5994 GDBusInterfaceInfo **interfaces;
5995 gboolean is_property_get;
5996 gboolean is_property_set;
5997 gboolean is_property_get_all;
6002 requested_object_path = g_dbus_message_get_path (message);
6003 sender = g_dbus_message_get_sender (message);
6004 interface_name = g_dbus_message_get_interface (message);
6005 member = g_dbus_message_get_member (message);
6006 signature = g_dbus_message_get_signature (message);
6007 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
6009 is_property_get = FALSE;
6010 is_property_set = FALSE;
6011 is_property_get_all = FALSE;
6012 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
6014 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
6015 is_property_get = TRUE;
6016 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
6017 is_property_set = TRUE;
6018 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
6019 is_property_get_all = TRUE;
6024 requested_node = strrchr (requested_object_path, '/') + 1;
6026 if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
6028 /* We don't want to dispatch to unenumerated
6029 * nodes, so ensure that the child exists.
6034 children = es->vtable->enumerate (es->connection,
6039 exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
6040 g_strfreev (children);
6048 requested_node = NULL;
6051 /* get introspection data for the node */
6052 interfaces = es->vtable->introspect (es->connection,
6054 requested_object_path,
6058 if (interfaces == NULL)
6061 interface_info = NULL;
6062 for (n = 0; interfaces[n] != NULL; n++)
6064 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6065 interface_info = interfaces[n];
6068 /* dispatch the call if the user wants to handle it */
6069 if (interface_info != NULL)
6071 /* figure out where to dispatch the method call */
6072 interface_user_data = NULL;
6073 interface_vtable = es->vtable->dispatch (es->connection,
6078 &interface_user_data,
6080 if (interface_vtable == NULL)
6083 CONNECTION_LOCK (connection);
6084 handled = validate_and_maybe_schedule_method_call (es->connection,
6091 interface_user_data);
6092 CONNECTION_UNLOCK (connection);
6094 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
6095 else if (is_property_get || is_property_set || is_property_get_all)
6097 if (is_property_get)
6098 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
6099 else if (is_property_set)
6100 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
6101 else if (is_property_get_all)
6102 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
6104 g_assert_not_reached ();
6106 /* see if the object supports this interface at all */
6107 for (n = 0; interfaces[n] != NULL; n++)
6109 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
6110 interface_info = interfaces[n];
6113 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
6114 * claims it won't support the interface
6116 if (interface_info == NULL)
6118 GDBusMessage *reply;
6119 reply = g_dbus_message_new_method_error (message,
6120 "org.freedesktop.DBus.Error.InvalidArgs",
6121 _("No such interface `%s'"),
6123 g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6124 g_object_unref (reply);
6129 /* figure out where to dispatch the property get/set/getall calls */
6130 interface_user_data = NULL;
6131 interface_vtable = es->vtable->dispatch (es->connection,
6136 &interface_user_data,
6138 if (interface_vtable == NULL)
6140 g_warning ("The subtree introspection function indicates that '%s' "
6141 "is a valid interface name, but calling the dispatch "
6142 "function on that interface gave us NULL", interface_name);
6146 if (is_property_get || is_property_set)
6148 CONNECTION_LOCK (connection);
6149 handled = validate_and_maybe_schedule_property_getset (es->connection,
6157 interface_user_data);
6158 CONNECTION_UNLOCK (connection);
6160 else if (is_property_get_all)
6162 CONNECTION_LOCK (connection);
6163 handled = validate_and_maybe_schedule_property_get_all (es->connection,
6170 interface_user_data);
6171 CONNECTION_UNLOCK (connection);
6176 if (interfaces != NULL)
6178 for (n = 0; interfaces[n] != NULL; n++)
6179 g_dbus_interface_info_unref (interfaces[n]);
6180 g_free (interfaces);
6188 GDBusMessage *message;
6189 ExportedSubtree *es;
6190 } SubtreeDeferredData;
6193 subtree_deferred_data_free (SubtreeDeferredData *data)
6195 g_object_unref (data->message);
6199 /* called without lock held in the thread where the caller registered the subtree */
6201 process_subtree_vtable_message_in_idle_cb (gpointer _data)
6203 SubtreeDeferredData *data = _data;
6208 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
6209 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
6210 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
6211 handled = handle_subtree_introspect (data->es->connection,
6215 handled = handle_subtree_method_invocation (data->es->connection,
6221 CONNECTION_LOCK (data->es->connection);
6222 handled = handle_generic_unlocked (data->es->connection, data->message);
6223 CONNECTION_UNLOCK (data->es->connection);
6226 /* if we couldn't handle the request, just bail with the UnknownMethod error */
6229 GDBusMessage *reply;
6230 reply = g_dbus_message_new_method_error (data->message,
6231 "org.freedesktop.DBus.Error.UnknownMethod",
6232 _("Method `%s' on interface `%s' with signature `%s' does not exist"),
6233 g_dbus_message_get_member (data->message),
6234 g_dbus_message_get_interface (data->message),
6235 g_dbus_message_get_signature (data->message));
6236 g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6237 g_object_unref (reply);
6243 /* called in GDBusWorker thread with connection's lock held */
6245 subtree_message_func (GDBusConnection *connection,
6246 ExportedSubtree *es,
6247 GDBusMessage *message)
6249 GSource *idle_source;
6250 SubtreeDeferredData *data;
6252 data = g_new0 (SubtreeDeferredData, 1);
6253 data->message = g_object_ref (message);
6256 /* defer this call to an idle handler in the right thread */
6257 idle_source = g_idle_source_new ();
6258 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
6259 g_source_set_callback (idle_source,
6260 process_subtree_vtable_message_in_idle_cb,
6262 (GDestroyNotify) subtree_deferred_data_free);
6263 g_source_attach (idle_source, es->context);
6264 g_source_unref (idle_source);
6266 /* since we own the entire subtree, handlers for objects not in the subtree have been
6267 * tried already by libdbus-1 - so we just need to ensure that we're always going
6268 * to reply to the message
6274 * g_dbus_connection_register_subtree:
6275 * @connection: A #GDBusConnection.
6276 * @object_path: The object path to register the subtree at.
6277 * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
6278 * @flags: Flags used to fine tune the behavior of the subtree.
6279 * @user_data: Data to pass to functions in @vtable.
6280 * @user_data_free_func: Function to call when the subtree is unregistered.
6281 * @error: Return location for error or %NULL.
6283 * Registers a whole subtree of <quote>dynamic</quote> objects.
6285 * The @enumerate and @introspection functions in @vtable are used to
6286 * convey, to remote callers, what nodes exist in the subtree rooted
6289 * When handling remote calls into any node in the subtree, first the
6290 * @enumerate function is used to check if the node exists. If the node exists
6291 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
6292 * the @introspection function is used to check if the node supports the
6293 * requested method. If so, the @dispatch function is used to determine
6294 * where to dispatch the call. The collected #GDBusInterfaceVTable and
6295 * #gpointer will be used to call into the interface vtable for processing
6298 * All calls into user-provided code will be invoked in the <link
6299 * linkend="g-main-context-push-thread-default">thread-default main
6300 * loop</link> of the thread you are calling this method from.
6302 * If an existing subtree is already registered at @object_path or
6303 * then @error is set to #G_IO_ERROR_EXISTS.
6305 * Note that it is valid to register regular objects (using
6306 * g_dbus_connection_register_object()) in a subtree registered with
6307 * g_dbus_connection_register_subtree() - if so, the subtree handler
6308 * is tried as the last resort. One way to think about a subtree
6309 * handler is to consider it a <quote>fallback handler</quote>
6310 * for object paths not registered via g_dbus_connection_register_object()
6311 * or other bindings.
6313 * Note that @vtable will be copied so you cannot change it after
6316 * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
6318 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
6319 * that can be used with g_dbus_connection_unregister_subtree() .
6324 g_dbus_connection_register_subtree (GDBusConnection *connection,
6325 const gchar *object_path,
6326 const GDBusSubtreeVTable *vtable,
6327 GDBusSubtreeFlags flags,
6329 GDestroyNotify user_data_free_func,
6333 ExportedSubtree *es;
6335 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
6336 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
6337 g_return_val_if_fail (vtable != NULL, 0);
6338 g_return_val_if_fail (error == NULL || *error == NULL, 0);
6339 g_return_val_if_fail (check_initialized (connection), 0);
6343 CONNECTION_LOCK (connection);
6345 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6351 _("A subtree is already exported for %s"),
6356 es = g_new0 (ExportedSubtree, 1);
6357 es->object_path = g_strdup (object_path);
6358 es->connection = connection;
6360 es->vtable = _g_dbus_subtree_vtable_copy (vtable);
6362 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
6363 es->user_data = user_data;
6364 es->user_data_free_func = user_data_free_func;
6365 es->context = g_main_context_ref_thread_default ();
6367 g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
6368 g_hash_table_insert (connection->map_id_to_es,
6369 GUINT_TO_POINTER (es->id),
6375 CONNECTION_UNLOCK (connection);
6380 /* ---------------------------------------------------------------------------------------------------- */
6383 * g_dbus_connection_unregister_subtree:
6384 * @connection: A #GDBusConnection.
6385 * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
6387 * Unregisters a subtree.
6389 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
6394 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
6395 guint registration_id)
6397 ExportedSubtree *es;
6400 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
6401 g_return_val_if_fail (check_initialized (connection), FALSE);
6405 CONNECTION_LOCK (connection);
6407 es = g_hash_table_lookup (connection->map_id_to_es,
6408 GUINT_TO_POINTER (registration_id));
6412 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
6413 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
6418 CONNECTION_UNLOCK (connection);
6423 /* ---------------------------------------------------------------------------------------------------- */
6425 /* may be called in any thread, with connection's lock held */
6427 handle_generic_ping_unlocked (GDBusConnection *connection,
6428 const gchar *object_path,
6429 GDBusMessage *message)
6431 GDBusMessage *reply;
6432 reply = g_dbus_message_new_method_reply (message);
6433 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6434 g_object_unref (reply);
6437 /* may be called in any thread, with connection's lock held */
6439 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
6440 const gchar *object_path,
6441 GDBusMessage *message)
6443 GDBusMessage *reply;
6446 if (connection->machine_id == NULL)
6451 connection->machine_id = _g_dbus_get_machine_id (&error);
6452 if (connection->machine_id == NULL)
6454 reply = g_dbus_message_new_method_error_literal (message,
6455 "org.freedesktop.DBus.Error.Failed",
6457 g_error_free (error);
6463 reply = g_dbus_message_new_method_reply (message);
6464 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
6466 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6467 g_object_unref (reply);
6470 /* may be called in any thread, with connection's lock held */
6472 handle_generic_introspect_unlocked (GDBusConnection *connection,
6473 const gchar *object_path,
6474 GDBusMessage *message)
6479 GDBusMessage *reply;
6481 /* first the header */
6482 s = g_string_new (NULL);
6483 introspect_append_header (s);
6485 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
6486 for (n = 0; registered != NULL && registered[n] != NULL; n++)
6487 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
6488 g_strfreev (registered);
6489 g_string_append (s, "</node>\n");
6491 reply = g_dbus_message_new_method_reply (message);
6492 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
6493 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6494 g_object_unref (reply);
6495 g_string_free (s, TRUE);
6498 /* may be called in any thread, with connection's lock held */
6500 handle_generic_unlocked (GDBusConnection *connection,
6501 GDBusMessage *message)
6504 const gchar *interface_name;
6505 const gchar *member;
6506 const gchar *signature;
6509 CONNECTION_ENSURE_LOCK (connection);
6513 interface_name = g_dbus_message_get_interface (message);
6514 member = g_dbus_message_get_member (message);
6515 signature = g_dbus_message_get_signature (message);
6516 path = g_dbus_message_get_path (message);
6518 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
6519 g_strcmp0 (member, "Introspect") == 0 &&
6520 g_strcmp0 (signature, "") == 0)
6522 handle_generic_introspect_unlocked (connection, path, message);
6525 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6526 g_strcmp0 (member, "Ping") == 0 &&
6527 g_strcmp0 (signature, "") == 0)
6529 handle_generic_ping_unlocked (connection, path, message);
6532 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6533 g_strcmp0 (member, "GetMachineId") == 0 &&
6534 g_strcmp0 (signature, "") == 0)
6536 handle_generic_get_machine_id_unlocked (connection, path, message);
6543 /* ---------------------------------------------------------------------------------------------------- */
6545 /* called in GDBusWorker thread with connection's lock held */
6547 distribute_method_call (GDBusConnection *connection,
6548 GDBusMessage *message)
6550 GDBusMessage *reply;
6552 ExportedSubtree *es;
6553 const gchar *object_path;
6554 const gchar *interface_name;
6555 const gchar *member;
6557 gchar *subtree_path;
6560 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
6562 interface_name = g_dbus_message_get_interface (message);
6563 member = g_dbus_message_get_member (message);
6564 path = g_dbus_message_get_path (message);
6565 subtree_path = g_strdup (path);
6566 needle = strrchr (subtree_path, '/');
6567 if (needle != NULL && needle != subtree_path)
6573 g_free (subtree_path);
6574 subtree_path = NULL;
6578 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
6580 _g_dbus_debug_print_lock ();
6581 g_print ("========================================================================\n"
6582 "GDBus-debug:Incoming:\n"
6583 " <<<< METHOD INVOCATION %s.%s()\n"
6585 " invoked by name %s\n"
6587 interface_name, member,
6589 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
6590 g_dbus_message_get_serial (message));
6591 _g_dbus_debug_print_unlock ();
6594 object_path = g_dbus_message_get_path (message);
6595 g_assert (object_path != NULL);
6597 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
6600 if (obj_message_func (connection, eo, message))
6604 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6607 if (subtree_message_func (connection, es, message))
6611 if (subtree_path != NULL)
6613 es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
6616 if (subtree_message_func (connection, es, message))
6621 if (handle_generic_unlocked (connection, message))
6624 /* if we end up here, the message has not been not handled - so return an error saying this */
6625 reply = g_dbus_message_new_method_error (message,
6626 "org.freedesktop.DBus.Error.UnknownMethod",
6627 _("No such interface `%s' on object at path %s"),
6630 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6631 g_object_unref (reply);
6634 g_free (subtree_path);
6637 /* ---------------------------------------------------------------------------------------------------- */
6639 /* Called in any user thread, with the message_bus_lock held. */
6641 message_bus_get_singleton (GBusType bus_type,
6645 const gchar *starter_bus;
6651 case G_BUS_TYPE_SESSION:
6652 ret = &the_session_bus;
6655 case G_BUS_TYPE_SYSTEM:
6656 ret = &the_system_bus;
6659 case G_BUS_TYPE_STARTER:
6660 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
6661 if (g_strcmp0 (starter_bus, "session") == 0)
6663 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
6666 else if (g_strcmp0 (starter_bus, "system") == 0)
6668 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
6673 if (starter_bus != NULL)
6677 G_IO_ERROR_INVALID_ARGUMENT,
6678 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
6679 " - unknown value `%s'"),
6684 g_set_error_literal (error,
6686 G_IO_ERROR_INVALID_ARGUMENT,
6687 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
6688 "variable is not set"));
6694 g_assert_not_reached ();
6702 /* Called in any user thread, without holding locks. */
6703 static GDBusConnection *
6704 get_uninitialized_connection (GBusType bus_type,
6705 GCancellable *cancellable,
6708 GWeakRef *singleton;
6709 GDBusConnection *ret;
6713 G_LOCK (message_bus_lock);
6714 singleton = message_bus_get_singleton (bus_type, error);
6715 if (singleton == NULL)
6718 ret = g_weak_ref_get (singleton);
6723 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
6724 if (address == NULL)
6726 ret = g_object_new (G_TYPE_DBUS_CONNECTION,
6728 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
6729 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
6730 "exit-on-close", TRUE,
6733 g_weak_ref_set (singleton, ret);
6737 g_assert (ret != NULL);
6740 G_UNLOCK (message_bus_lock);
6746 * @bus_type: A #GBusType.
6747 * @cancellable: A #GCancellable or %NULL.
6748 * @error: Return location for error or %NULL.
6750 * Synchronously connects to the message bus specified by @bus_type.
6751 * Note that the returned object may shared with other callers,
6752 * e.g. if two separate parts of a process calls this function with
6753 * the same @bus_type, they will share the same object.
6755 * This is a synchronous failable function. See g_bus_get() and
6756 * g_bus_get_finish() for the asynchronous version.
6758 * The returned object is a singleton, that is, shared with other
6759 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6760 * event that you need a private message bus connection, use
6761 * g_dbus_address_get_for_bus_sync() and
6762 * g_dbus_connection_new_for_address().
6764 * Note that the returned #GDBusConnection object will (usually) have
6765 * the #GDBusConnection:exit-on-close property set to %TRUE.
6767 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
6772 g_bus_get_sync (GBusType bus_type,
6773 GCancellable *cancellable,
6776 GDBusConnection *connection;
6778 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6780 connection = get_uninitialized_connection (bus_type, cancellable, error);
6781 if (connection == NULL)
6784 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
6786 g_object_unref (connection);
6795 bus_get_async_initable_cb (GObject *source_object,
6799 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
6803 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
6807 g_assert (error != NULL);
6808 g_simple_async_result_take_error (simple, error);
6809 g_object_unref (source_object);
6813 g_simple_async_result_set_op_res_gpointer (simple,
6817 g_simple_async_result_complete_in_idle (simple);
6818 g_object_unref (simple);
6823 * @bus_type: A #GBusType.
6824 * @cancellable: A #GCancellable or %NULL.
6825 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
6826 * @user_data: The data to pass to @callback.
6828 * Asynchronously connects to the message bus specified by @bus_type.
6830 * When the operation is finished, @callback will be invoked. You can
6831 * then call g_bus_get_finish() to get the result of the operation.
6833 * This is a asynchronous failable function. See g_bus_get_sync() for
6834 * the synchronous version.
6839 g_bus_get (GBusType bus_type,
6840 GCancellable *cancellable,
6841 GAsyncReadyCallback callback,
6844 GDBusConnection *connection;
6845 GSimpleAsyncResult *simple;
6848 simple = g_simple_async_result_new (NULL,
6852 g_simple_async_result_set_check_cancellable (simple, cancellable);
6855 connection = get_uninitialized_connection (bus_type, cancellable, &error);
6856 if (connection == NULL)
6858 g_assert (error != NULL);
6859 g_simple_async_result_take_error (simple, error);
6860 g_simple_async_result_complete_in_idle (simple);
6861 g_object_unref (simple);
6865 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
6868 bus_get_async_initable_cb,
6875 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
6876 * @error: Return location for error or %NULL.
6878 * Finishes an operation started with g_bus_get().
6880 * The returned object is a singleton, that is, shared with other
6881 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6882 * event that you need a private message bus connection, use
6883 * g_dbus_address_get_for_bus_sync() and
6884 * g_dbus_connection_new_for_address().
6886 * Note that the returned #GDBusConnection object will (usually) have
6887 * the #GDBusConnection:exit-on-close property set to %TRUE.
6889 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
6894 g_bus_get_finish (GAsyncResult *res,
6897 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
6899 GDBusConnection *ret;
6901 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6903 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
6907 if (g_simple_async_result_propagate_error (simple, error))
6910 object = g_simple_async_result_get_op_res_gpointer (simple);
6911 g_assert (object != NULL);
6912 ret = g_object_ref (G_DBUS_CONNECTION (object));
6918 /* ---------------------------------------------------------------------------------------------------- */