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 (excect
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 acheive 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 "gio-marshal.h"
125 #include "ginitable.h"
126 #include "gasyncinitable.h"
127 #include "giostream.h"
128 #include "gasyncresult.h"
129 #include "gsimpleasyncresult.h"
132 #include "gunixconnection.h"
133 #include "gunixfdmessage.h"
136 #include "glibintl.h"
139 * SECTION:gdbusconnection
140 * @short_description: D-Bus Connections
141 * @include: gio/gio.h
143 * The #GDBusConnection type is used for D-Bus connections to remote
144 * peers such as a message buses. It is a low-level API that offers a
145 * lot of flexibility. For instance, it lets you establish a connection
146 * over any transport that can by represented as an #GIOStream.
148 * This class is rarely used directly in D-Bus clients. If you are writing
149 * an D-Bus client, it is often easier to use the g_bus_own_name(),
150 * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
152 * <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>
154 * <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>
156 * <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>
158 * <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>
161 /* ---------------------------------------------------------------------------------------------------- */
163 typedef struct _GDBusConnectionClass GDBusConnectionClass;
166 * GDBusConnectionClass:
167 * @closed: Signal class handler for the #GDBusConnection::closed signal.
169 * Class structure for #GDBusConnection.
173 struct _GDBusConnectionClass
176 GObjectClass parent_class;
180 void (*closed) (GDBusConnection *connection,
181 gboolean remote_peer_vanished,
185 G_LOCK_DEFINE_STATIC (message_bus_lock);
187 static GDBusConnection *the_session_bus = NULL;
188 static GDBusConnection *the_system_bus = NULL;
190 /* ---------------------------------------------------------------------------------------------------- */
194 GDestroyNotify callback;
196 GMainContext *context;
197 } CallDestroyNotifyData;
200 call_destroy_notify_data_in_idle (gpointer user_data)
202 CallDestroyNotifyData *data = user_data;
203 data->callback (data->user_data);
208 call_destroy_notify_data_free (CallDestroyNotifyData *data)
210 if (data->context != NULL)
211 g_main_context_unref (data->context);
216 * call_destroy_notify: <internal>
217 * @context: A #GMainContext or %NULL.
218 * @callback: A #GDestroyNotify or %NULL.
219 * @user_data: Data to pass to @callback.
221 * Schedules @callback to run in @context.
224 call_destroy_notify (GMainContext *context,
225 GDestroyNotify callback,
228 if (callback == NULL)
231 if (context == g_main_context_get_thread_default ())
233 callback (user_data);
237 GSource *idle_source;
238 CallDestroyNotifyData *data;
240 data = g_new0 (CallDestroyNotifyData, 1);
241 data->callback = callback;
242 data->user_data = user_data;
243 data->context = context;
244 if (data->context != NULL)
245 g_main_context_ref (data->context);
247 idle_source = g_idle_source_new ();
248 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
249 g_source_set_callback (idle_source,
250 call_destroy_notify_data_in_idle,
252 (GDestroyNotify) call_destroy_notify_data_free);
253 g_source_attach (idle_source, data->context);
254 g_source_unref (idle_source);
261 /* ---------------------------------------------------------------------------------------------------- */
264 _g_strv_has_string (const gchar* const *haystack,
269 for (n = 0; haystack != NULL && haystack[n] != NULL; n++)
271 if (g_strcmp0 (haystack[n], needle) == 0)
277 /* ---------------------------------------------------------------------------------------------------- */
280 #define CONNECTION_ENSURE_LOCK(obj) do { ; } while (FALSE)
282 // TODO: for some reason this doesn't work on Windows
283 #define CONNECTION_ENSURE_LOCK(obj) do { \
284 if (G_UNLIKELY (g_mutex_trylock((obj)->lock))) \
286 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
287 "CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
292 #define CONNECTION_LOCK(obj) do { \
293 g_mutex_lock ((obj)->lock); \
296 #define CONNECTION_UNLOCK(obj) do { \
297 g_mutex_unlock ((obj)->lock); \
303 * The #GDBusConnection structure contains only private data and
304 * should only be accessed using the provided API.
308 struct _GDBusConnection
311 GObject parent_instance;
313 /* ------------------------------------------------------------------------ */
314 /* -- General object state ------------------------------------------------ */
315 /* ------------------------------------------------------------------------ */
317 /* object-wide lock */
320 /* A lock used in the init() method of the GInitable interface - see comments
321 * in initable_init() for why a separate lock is needed
325 /* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
326 * someone calls org.freedesktop.DBus.GetMachineId()
330 /* The underlying stream used for communication */
333 /* The object used for authentication (if any) */
336 /* Set to TRUE if the connection has been closed */
339 /* Last serial used */
342 /* The object used to send/receive message */
345 /* If connected to a message bus, this contains the unique name assigned to
346 * us by the bus (e.g. ":1.42")
348 gchar *bus_unique_name;
350 /* The GUID returned by the other side if we authenticed as a client or
351 * the GUID to use if authenticating as a server
355 /* set to TRUE exactly when initable_init() has finished running */
356 gboolean is_initialized;
358 /* If the connection could not be established during initable_init(), this GError will set */
359 GError *initialization_error;
361 /* The result of g_main_context_get_thread_default() when the object
362 * was created (the GObject _init() function) - this is used for delivery
363 * of the :closed GObject signal.
365 GMainContext *main_context_at_construction;
367 /* construct properties */
369 GDBusConnectionFlags flags;
371 /* Map used for managing method replies */
372 GHashTable *map_method_serial_to_send_message_data; /* guint32 -> SendMessageData* */
374 /* Maps used for managing signal subscription */
375 GHashTable *map_rule_to_signal_data; /* match rule (gchar*) -> SignalData */
376 GHashTable *map_id_to_signal_data; /* id (guint) -> SignalData */
377 GHashTable *map_sender_unique_name_to_signal_data_array; /* unique sender (gchar*) -> GPtrArray* of SignalData */
379 /* Maps used for managing exported objects and subtrees */
380 GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
381 GHashTable *map_id_to_ei; /* guint -> ExportedInterface* */
382 GHashTable *map_object_path_to_es; /* gchar* -> ExportedSubtree* */
383 GHashTable *map_id_to_es; /* guint -> ExportedSubtree* */
385 /* Structure used for message filters */
388 /* Whether to exit on close */
389 gboolean exit_on_close;
391 /* Capabilities negotiated during authentication */
392 GDBusCapabilityFlags capabilities;
394 GDBusAuthObserver *authentication_observer;
395 GCredentials *credentials;
397 /* set to TRUE when finalizing */
401 typedef struct ExportedObject ExportedObject;
402 static void exported_object_free (ExportedObject *eo);
404 typedef struct ExportedSubtree ExportedSubtree;
405 static void exported_subtree_free (ExportedSubtree *es);
423 PROP_CAPABILITY_FLAGS,
424 PROP_AUTHENTICATION_OBSERVER,
427 static void distribute_signals (GDBusConnection *connection,
428 GDBusMessage *message);
430 static void distribute_method_call (GDBusConnection *connection,
431 GDBusMessage *message);
433 static gboolean handle_generic_unlocked (GDBusConnection *connection,
434 GDBusMessage *message);
437 static void purge_all_signal_subscriptions (GDBusConnection *connection);
438 static void purge_all_filters (GDBusConnection *connection);
440 #define _G_ENSURE_LOCK(name) do { \
441 if (G_UNLIKELY (G_TRYLOCK(name))) \
443 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
444 "_G_ENSURE_LOCK: Lock `" #name "' is not locked"); \
448 static guint signals[LAST_SIGNAL] = { 0 };
450 static void initable_iface_init (GInitableIface *initable_iface);
451 static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
453 G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
454 G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, initable_iface_init)
455 G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
458 static GHashTable *alive_connections = NULL;
461 g_dbus_connection_dispose (GObject *object)
463 GDBusConnection *connection = G_DBUS_CONNECTION (object);
465 G_LOCK (message_bus_lock);
466 if (connection == the_session_bus)
468 the_session_bus = NULL;
470 else if (connection == the_system_bus)
472 the_system_bus = NULL;
474 CONNECTION_LOCK (connection);
475 if (connection->worker != NULL)
477 _g_dbus_worker_stop (connection->worker);
478 connection->worker = NULL;
479 if (alive_connections != NULL)
480 g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
484 if (alive_connections != NULL)
485 g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
487 CONNECTION_UNLOCK (connection);
488 G_UNLOCK (message_bus_lock);
490 if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
491 G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose (object);
495 g_dbus_connection_finalize (GObject *object)
497 GDBusConnection *connection = G_DBUS_CONNECTION (object);
499 connection->finalizing = TRUE;
501 purge_all_signal_subscriptions (connection);
503 purge_all_filters (connection);
504 g_ptr_array_unref (connection->filters);
506 if (connection->authentication_observer != NULL)
507 g_object_unref (connection->authentication_observer);
509 if (connection->auth != NULL)
510 g_object_unref (connection->auth);
512 if (connection->credentials)
513 g_object_unref (connection->credentials);
515 if (connection->stream != NULL)
517 /* We don't really care if closing the stream succeeds or not */
518 g_io_stream_close_async (connection->stream,
520 NULL, /* GCancellable */
521 NULL, /* GAsyncReadyCallback */
522 NULL); /* userdata */
523 g_object_unref (connection->stream);
524 connection->stream = NULL;
527 g_free (connection->address);
529 g_free (connection->guid);
530 g_free (connection->bus_unique_name);
532 if (connection->initialization_error != NULL)
533 g_error_free (connection->initialization_error);
535 g_hash_table_unref (connection->map_method_serial_to_send_message_data);
537 g_hash_table_unref (connection->map_rule_to_signal_data);
538 g_hash_table_unref (connection->map_id_to_signal_data);
539 g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
541 g_hash_table_unref (connection->map_id_to_ei);
542 g_hash_table_unref (connection->map_object_path_to_eo);
543 g_hash_table_unref (connection->map_id_to_es);
544 g_hash_table_unref (connection->map_object_path_to_es);
546 if (connection->main_context_at_construction != NULL)
547 g_main_context_unref (connection->main_context_at_construction);
549 g_free (connection->machine_id);
551 g_mutex_free (connection->init_lock);
552 g_mutex_free (connection->lock);
554 G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
558 g_dbus_connection_get_property (GObject *object,
563 GDBusConnection *connection = G_DBUS_CONNECTION (object);
568 g_value_set_object (value, g_dbus_connection_get_stream (connection));
572 g_value_set_string (value, g_dbus_connection_get_guid (connection));
575 case PROP_UNIQUE_NAME:
576 g_value_set_string (value, g_dbus_connection_get_unique_name (connection));
580 g_value_set_boolean (value, g_dbus_connection_is_closed (connection));
583 case PROP_EXIT_ON_CLOSE:
584 g_value_set_boolean (value, g_dbus_connection_get_exit_on_close (connection));
587 case PROP_CAPABILITY_FLAGS:
588 g_value_set_flags (value, g_dbus_connection_get_capabilities (connection));
592 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
598 g_dbus_connection_set_property (GObject *object,
603 GDBusConnection *connection = G_DBUS_CONNECTION (object);
608 connection->stream = g_value_dup_object (value);
612 connection->guid = g_value_dup_string (value);
616 connection->address = g_value_dup_string (value);
620 connection->flags = g_value_get_flags (value);
623 case PROP_EXIT_ON_CLOSE:
624 g_dbus_connection_set_exit_on_close (connection, g_value_get_boolean (value));
627 case PROP_AUTHENTICATION_OBSERVER:
628 connection->authentication_observer = g_value_dup_object (value);
632 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
638 g_dbus_connection_real_closed (GDBusConnection *connection,
639 gboolean remote_peer_vanished,
642 if (remote_peer_vanished && connection->exit_on_close)
646 g_print ("%s: Remote peer vanished with error: %s (%s, %d). Exiting.\n",
649 g_quark_to_string (error->domain), error->code);
653 g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
660 g_dbus_connection_class_init (GDBusConnectionClass *klass)
662 GObjectClass *gobject_class;
664 gobject_class = G_OBJECT_CLASS (klass);
666 gobject_class->finalize = g_dbus_connection_finalize;
667 gobject_class->dispose = g_dbus_connection_dispose;
668 gobject_class->set_property = g_dbus_connection_set_property;
669 gobject_class->get_property = g_dbus_connection_get_property;
671 klass->closed = g_dbus_connection_real_closed;
674 * GDBusConnection:stream:
676 * The underlying #GIOStream used for I/O.
680 g_object_class_install_property (gobject_class,
682 g_param_spec_object ("stream",
684 P_("The underlying streams used for I/O"),
688 G_PARAM_CONSTRUCT_ONLY |
689 G_PARAM_STATIC_NAME |
690 G_PARAM_STATIC_BLURB |
691 G_PARAM_STATIC_NICK));
694 * GDBusConnection:address:
696 * A D-Bus address specifying potential endpoints that can be used
697 * when establishing the connection.
701 g_object_class_install_property (gobject_class,
703 g_param_spec_string ("address",
705 P_("D-Bus address specifying potential socket endpoints"),
708 G_PARAM_CONSTRUCT_ONLY |
709 G_PARAM_STATIC_NAME |
710 G_PARAM_STATIC_BLURB |
711 G_PARAM_STATIC_NICK));
714 * GDBusConnection:flags:
716 * Flags from the #GDBusConnectionFlags enumeration.
720 g_object_class_install_property (gobject_class,
722 g_param_spec_flags ("flags",
725 G_TYPE_DBUS_CONNECTION_FLAGS,
726 G_DBUS_CONNECTION_FLAGS_NONE,
728 G_PARAM_CONSTRUCT_ONLY |
729 G_PARAM_STATIC_NAME |
730 G_PARAM_STATIC_BLURB |
731 G_PARAM_STATIC_NICK));
734 * GDBusConnection:guid:
736 * The GUID of the peer performing the role of server when
739 * If you are constructing a #GDBusConnection and pass
740 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER in the
741 * #GDBusConnection:flags property then you MUST also set this
742 * property to a valid guid.
744 * If you are constructing a #GDBusConnection and pass
745 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
746 * #GDBusConnection:flags property you will be able to read the GUID
747 * of the other peer here after the connection has been successfully
752 g_object_class_install_property (gobject_class,
754 g_param_spec_string ("guid",
756 P_("GUID of the server peer"),
760 G_PARAM_CONSTRUCT_ONLY |
761 G_PARAM_STATIC_NAME |
762 G_PARAM_STATIC_BLURB |
763 G_PARAM_STATIC_NICK));
766 * GDBusConnection:unique-name:
768 * The unique name as assigned by the message bus or %NULL if the
769 * connection is not open or not a message bus connection.
773 g_object_class_install_property (gobject_class,
775 g_param_spec_string ("unique-name",
777 P_("Unique name of bus connection"),
780 G_PARAM_STATIC_NAME |
781 G_PARAM_STATIC_BLURB |
782 G_PARAM_STATIC_NICK));
785 * GDBusConnection:closed:
787 * A boolean specifying whether the connection has been closed.
791 g_object_class_install_property (gobject_class,
793 g_param_spec_boolean ("closed",
795 P_("Whether the connection is closed"),
798 G_PARAM_STATIC_NAME |
799 G_PARAM_STATIC_BLURB |
800 G_PARAM_STATIC_NICK));
803 * GDBusConnection:exit-on-close:
805 * A boolean specifying whether the process will be terminated (by
806 * calling <literal>raise(SIGTERM)</literal>) if the connection
807 * is closed by the remote peer.
811 g_object_class_install_property (gobject_class,
813 g_param_spec_boolean ("exit-on-close",
815 P_("Whether the process is terminated when the connection is closed"),
819 G_PARAM_STATIC_NAME |
820 G_PARAM_STATIC_BLURB |
821 G_PARAM_STATIC_NICK));
824 * GDBusConnection:capabilities:
826 * Flags from the #GDBusCapabilityFlags enumeration
827 * representing connection features negotiated with the other peer.
831 g_object_class_install_property (gobject_class,
832 PROP_CAPABILITY_FLAGS,
833 g_param_spec_flags ("capabilities",
836 G_TYPE_DBUS_CAPABILITY_FLAGS,
837 G_DBUS_CAPABILITY_FLAGS_NONE,
839 G_PARAM_STATIC_NAME |
840 G_PARAM_STATIC_BLURB |
841 G_PARAM_STATIC_NICK));
844 * GDBusConnection:authentication-observer:
846 * A #GDBusAuthObserver object to assist in the authentication process or %NULL.
850 g_object_class_install_property (gobject_class,
851 PROP_AUTHENTICATION_OBSERVER,
852 g_param_spec_object ("authentication-observer",
853 P_("Authentication Observer"),
854 P_("Object used to assist in the authentication process"),
855 G_TYPE_DBUS_AUTH_OBSERVER,
857 G_PARAM_CONSTRUCT_ONLY |
858 G_PARAM_STATIC_NAME |
859 G_PARAM_STATIC_BLURB |
860 G_PARAM_STATIC_NICK));
863 * GDBusConnection::closed:
864 * @connection: The #GDBusConnection emitting the signal.
865 * @remote_peer_vanished: %TRUE if @connection is closed because the
866 * remote peer closed its end of the connection.
867 * @error: A #GError with more details about the event or %NULL.
869 * Emitted when the connection is closed.
871 * The cause of this event can be
874 * If g_dbus_connection_close() is called. In this case
875 * @remote_peer_vanished is set to %FALSE and @error is %NULL.
878 * If the remote peer closes the connection. In this case
879 * @remote_peer_vanished is set to %TRUE and @error is set.
882 * If the remote peer sends invalid or malformed data. In this
883 * case @remote_peer_vanished is set to %FALSE and @error
888 * Upon receiving this signal, you should give up your reference to
889 * @connection. You are guaranteed that this signal is emitted only
894 signals[CLOSED_SIGNAL] = g_signal_new ("closed",
895 G_TYPE_DBUS_CONNECTION,
897 G_STRUCT_OFFSET (GDBusConnectionClass, closed),
900 _gio_marshal_VOID__BOOLEAN_BOXED,
908 g_dbus_connection_init (GDBusConnection *connection)
910 connection->lock = g_mutex_new ();
911 connection->init_lock = g_mutex_new ();
913 connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
915 connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
917 connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
919 connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
922 (GDestroyNotify) g_ptr_array_unref);
924 connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
927 (GDestroyNotify) exported_object_free);
929 connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
932 connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
935 (GDestroyNotify) exported_subtree_free);
937 connection->map_id_to_es = g_hash_table_new (g_direct_hash,
940 connection->main_context_at_construction = g_main_context_get_thread_default ();
941 if (connection->main_context_at_construction != NULL)
942 g_main_context_ref (connection->main_context_at_construction);
944 connection->filters = g_ptr_array_new ();
948 * g_dbus_connection_get_stream:
949 * @connection: a #GDBusConnection
951 * Gets the underlying stream used for IO.
953 * Returns: (transfer none): the stream used for IO
958 g_dbus_connection_get_stream (GDBusConnection *connection)
960 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
961 return connection->stream;
965 * g_dbus_connection_start_message_processing:
966 * @connection: A #GDBusConnection.
968 * If @connection was created with
969 * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
970 * starts processing messages. Does nothing on if @connection wasn't
971 * created with this flag or if the method has already been called.
976 g_dbus_connection_start_message_processing (GDBusConnection *connection)
978 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
979 _g_dbus_worker_unfreeze (connection->worker);
983 * g_dbus_connection_is_closed:
984 * @connection: A #GDBusConnection.
986 * Gets whether @connection is closed.
988 * Returns: %TRUE if the connection is closed, %FALSE otherwise.
993 g_dbus_connection_is_closed (GDBusConnection *connection)
995 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
996 return connection->closed;
1000 * g_dbus_connection_get_capabilities:
1001 * @connection: A #GDBusConnection.
1003 * Gets the capabilities negotiated with the remote peer
1005 * Returns: Zero or more flags from the #GDBusCapabilityFlags enumeration.
1009 GDBusCapabilityFlags
1010 g_dbus_connection_get_capabilities (GDBusConnection *connection)
1012 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
1013 return connection->capabilities;
1016 /* ---------------------------------------------------------------------------------------------------- */
1019 flush_in_thread_func (GSimpleAsyncResult *res,
1021 GCancellable *cancellable)
1026 if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
1030 g_simple_async_result_set_from_error (res, error);
1031 g_error_free (error);
1036 * g_dbus_connection_flush:
1037 * @connection: A #GDBusConnection.
1038 * @cancellable: A #GCancellable or %NULL.
1039 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
1040 * care about the result.
1041 * @user_data: The data to pass to @callback.
1043 * Asynchronously flushes @connection, that is, writes all queued
1044 * outgoing message to the transport and then flushes the transport
1045 * (using g_output_stream_flush_async()). This is useful in programs
1046 * that wants to emit a D-Bus signal and then exit
1047 * immediately. Without flushing the connection, there is no guarantee
1048 * that the message has been sent to the networking buffers in the OS
1051 * This is an asynchronous method. When the operation is finished,
1052 * @callback will be invoked in the <link
1053 * linkend="g-main-context-push-thread-default">thread-default main
1054 * loop</link> of the thread you are calling this method from. You can
1055 * then call g_dbus_connection_flush_finish() to get the result of the
1056 * operation. See g_dbus_connection_flush_sync() for the synchronous
1062 g_dbus_connection_flush (GDBusConnection *connection,
1063 GCancellable *cancellable,
1064 GAsyncReadyCallback callback,
1067 GSimpleAsyncResult *simple;
1069 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1071 simple = g_simple_async_result_new (G_OBJECT (connection),
1074 g_dbus_connection_flush);
1075 g_simple_async_result_run_in_thread (simple,
1076 flush_in_thread_func,
1079 g_object_unref (simple);
1083 * g_dbus_connection_flush_finish:
1084 * @connection: A #GDBusConnection.
1085 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush().
1086 * @error: Return location for error or %NULL.
1088 * Finishes an operation started with g_dbus_connection_flush().
1090 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1095 g_dbus_connection_flush_finish (GDBusConnection *connection,
1099 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1104 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1105 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1106 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1108 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
1110 if (g_simple_async_result_propagate_error (simple, error))
1120 * g_dbus_connection_flush_sync:
1121 * @connection: A #GDBusConnection.
1122 * @cancellable: A #GCancellable or %NULL.
1123 * @error: Return location for error or %NULL.
1125 * Synchronously flushes @connection. The calling thread is blocked
1126 * until this is done. See g_dbus_connection_flush() for the
1127 * asynchronous version of this method and more details about what it
1130 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1135 g_dbus_connection_flush_sync (GDBusConnection *connection,
1136 GCancellable *cancellable,
1141 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1142 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1146 if (connection->closed)
1148 g_set_error_literal (error,
1151 _("The connection is closed"));
1155 ret = _g_dbus_worker_flush_sync (connection->worker,
1163 /* ---------------------------------------------------------------------------------------------------- */
1167 GDBusConnection *connection;
1169 gboolean remote_peer_vanished;
1173 emit_closed_data_free (EmitClosedData *data)
1175 g_object_unref (data->connection);
1176 if (data->error != NULL)
1177 g_error_free (data->error);
1182 emit_closed_in_idle (gpointer user_data)
1184 EmitClosedData *data = user_data;
1187 g_object_notify (G_OBJECT (data->connection), "closed");
1188 g_signal_emit (data->connection,
1189 signals[CLOSED_SIGNAL],
1191 data->remote_peer_vanished,
1197 /* Can be called from any thread, must hold lock */
1199 set_closed_unlocked (GDBusConnection *connection,
1200 gboolean remote_peer_vanished,
1203 GSource *idle_source;
1204 EmitClosedData *data;
1206 CONNECTION_ENSURE_LOCK (connection);
1208 g_assert (!connection->closed);
1210 connection->closed = TRUE;
1212 data = g_new0 (EmitClosedData, 1);
1213 data->connection = g_object_ref (connection);
1214 data->remote_peer_vanished = remote_peer_vanished;
1215 data->error = error != NULL ? g_error_copy (error) : NULL;
1217 idle_source = g_idle_source_new ();
1218 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1219 g_source_set_callback (idle_source,
1220 emit_closed_in_idle,
1222 (GDestroyNotify) emit_closed_data_free);
1223 g_source_attach (idle_source, connection->main_context_at_construction);
1224 g_source_unref (idle_source);
1227 /* ---------------------------------------------------------------------------------------------------- */
1230 close_in_thread_func (GSimpleAsyncResult *res,
1232 GCancellable *cancellable)
1237 if (!g_dbus_connection_close_sync (G_DBUS_CONNECTION (object),
1241 g_simple_async_result_set_from_error (res, error);
1242 g_error_free (error);
1247 * g_dbus_connection_close:
1248 * @connection: A #GDBusConnection.
1249 * @cancellable: A #GCancellable or %NULL.
1250 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
1251 * care about the result.
1252 * @user_data: The data to pass to @callback.
1254 * Closes @connection. Note that this never causes the process to
1255 * exit (this might only happen if the other end of a shared message
1256 * bus connection disconnects, see #GDBusConnection:exit-on-close).
1258 * Once the connection is closed, operations such as sending a message
1259 * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
1260 * will not automatically flush the connection so queued messages may
1261 * be lost. Use g_dbus_connection_flush() if you need such guarantees.
1263 * If @connection is already closed, this method fails with
1264 * %G_IO_ERROR_CLOSED.
1266 * When @connection has been closed, the #GDBusConnection::closed
1267 * signal is emitted in the <link
1268 * linkend="g-main-context-push-thread-default">thread-default main
1269 * loop</link> of the thread that @connection was constructed in.
1271 * This is an asynchronous method. When the operation is finished,
1272 * @callback will be invoked in the <link
1273 * linkend="g-main-context-push-thread-default">thread-default main
1274 * loop</link> of the thread you are calling this method from. You can
1275 * then call g_dbus_connection_close_finish() to get the result of the
1276 * operation. See g_dbus_connection_close_sync() for the synchronous
1282 g_dbus_connection_close (GDBusConnection *connection,
1283 GCancellable *cancellable,
1284 GAsyncReadyCallback callback,
1287 GSimpleAsyncResult *simple;
1289 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1291 simple = g_simple_async_result_new (G_OBJECT (connection),
1294 g_dbus_connection_close);
1295 g_simple_async_result_run_in_thread (simple,
1296 close_in_thread_func,
1299 g_object_unref (simple);
1303 * g_dbus_connection_close_finish:
1304 * @connection: A #GDBusConnection.
1305 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close().
1306 * @error: Return location for error or %NULL.
1308 * Finishes an operation started with g_dbus_connection_close().
1310 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1315 g_dbus_connection_close_finish (GDBusConnection *connection,
1319 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1324 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1325 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
1326 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1328 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
1330 if (g_simple_async_result_propagate_error (simple, error))
1340 * g_dbus_connection_close_sync:
1341 * @connection: A #GDBusConnection.
1342 * @cancellable: A #GCancellable or %NULL.
1343 * @error: Return location for error or %NULL.
1345 * Synchronously closees @connection. The calling thread is blocked
1346 * until this is done. See g_dbus_connection_close() for the
1347 * asynchronous version of this method and more details about what it
1350 * Returns: %TRUE if the operation succeeded, %FALSE if @error is set.
1355 g_dbus_connection_close_sync (GDBusConnection *connection,
1356 GCancellable *cancellable,
1361 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1362 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1366 CONNECTION_LOCK (connection);
1367 if (!connection->closed)
1369 ret = g_io_stream_close (connection->stream,
1373 set_closed_unlocked (connection, FALSE, NULL);
1377 g_set_error_literal (error,
1380 _("The connection is closed"));
1382 CONNECTION_UNLOCK (connection);
1387 /* ---------------------------------------------------------------------------------------------------- */
1390 g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
1391 GDBusMessage *message,
1392 GDBusSendMessageFlags flags,
1393 volatile guint32 *out_serial,
1398 guint32 serial_to_use;
1401 CONNECTION_ENSURE_LOCK (connection);
1403 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1404 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1406 /* TODO: check all necessary headers are present */
1411 if (out_serial != NULL)
1414 if (connection->closed)
1416 g_set_error_literal (error,
1419 _("The connection is closed"));
1423 blob = g_dbus_message_to_blob (message,
1425 connection->capabilities,
1430 if (flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL)
1431 serial_to_use = g_dbus_message_get_serial (message);
1433 serial_to_use = ++connection->last_serial; /* TODO: handle overflow */
1438 ((guint32 *) blob)[2] = GUINT32_TO_LE (serial_to_use);
1441 ((guint32 *) blob)[2] = GUINT32_TO_BE (serial_to_use);
1444 g_assert_not_reached ();
1449 g_printerr ("Writing message of %" G_GSIZE_FORMAT " bytes (serial %d) on %p:\n",
1450 blob_size, serial_to_use, connection);
1451 g_printerr ("----\n");
1452 hexdump (blob, blob_size);
1453 g_printerr ("----\n");
1456 /* TODO: use connection->auth to encode the blob */
1458 if (out_serial != NULL)
1459 *out_serial = serial_to_use;
1461 g_dbus_message_set_serial (message, serial_to_use);
1463 g_dbus_message_lock (message);
1464 _g_dbus_worker_send_message (connection->worker,
1468 blob = NULL; /* since _g_dbus_worker_send_message() steals the blob */
1479 * g_dbus_connection_send_message:
1480 * @connection: A #GDBusConnection.
1481 * @message: A #GDBusMessage
1482 * @flags: Flags affecting how the message is sent.
1483 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1484 * @error: Return location for error or %NULL.
1486 * Asynchronously sends @message to the peer represented by @connection.
1488 * Unless @flags contain the
1489 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1490 * will be assigned by @connection and set on @message via
1491 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1492 * serial number used will be written to this location prior to
1493 * submitting the message to the underlying transport.
1495 * If @connection is closed then the operation will fail with
1496 * %G_IO_ERROR_CLOSED. If @message is not well-formed,
1497 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1499 * See <xref linkend="gdbus-server"/> and <xref
1500 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1501 * low-level API to send and receive UNIX file descriptors.
1503 * Note that @message must be unlocked, unless @flags contain the
1504 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1506 * Returns: %TRUE if the message was well-formed and queued for
1507 * transmission, %FALSE if @error is set.
1512 g_dbus_connection_send_message (GDBusConnection *connection,
1513 GDBusMessage *message,
1514 GDBusSendMessageFlags flags,
1515 volatile guint32 *out_serial,
1520 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
1521 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
1522 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
1523 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1525 CONNECTION_LOCK (connection);
1526 ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
1527 CONNECTION_UNLOCK (connection);
1531 /* ---------------------------------------------------------------------------------------------------- */
1535 volatile gint ref_count;
1536 GDBusConnection *connection;
1538 GSimpleAsyncResult *simple;
1540 GMainContext *main_context;
1542 GCancellable *cancellable;
1544 gulong cancellable_handler_id;
1546 GSource *timeout_source;
1551 static SendMessageData *
1552 send_message_data_ref (SendMessageData *data)
1554 g_atomic_int_inc (&data->ref_count);
1559 send_message_data_unref (SendMessageData *data)
1561 if (g_atomic_int_dec_and_test (&data->ref_count))
1563 g_assert (data->timeout_source == NULL);
1564 g_assert (data->simple == NULL);
1565 g_assert (data->cancellable_handler_id == 0);
1566 g_object_unref (data->connection);
1567 if (data->cancellable != NULL)
1568 g_object_unref (data->cancellable);
1569 if (data->main_context != NULL)
1570 g_main_context_unref (data->main_context);
1575 /* ---------------------------------------------------------------------------------------------------- */
1577 /* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
1579 send_message_with_reply_deliver (SendMessageData *data)
1581 CONNECTION_ENSURE_LOCK (data->connection);
1583 g_assert (!data->delivered);
1585 data->delivered = TRUE;
1587 g_simple_async_result_complete_in_idle (data->simple);
1588 g_object_unref (data->simple);
1589 data->simple = NULL;
1591 if (data->timeout_source != NULL)
1593 g_source_destroy (data->timeout_source);
1594 data->timeout_source = NULL;
1596 if (data->cancellable_handler_id > 0)
1598 g_cancellable_disconnect (data->cancellable, data->cancellable_handler_id);
1599 data->cancellable_handler_id = 0;
1602 g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
1603 GUINT_TO_POINTER (data->serial)));
1605 send_message_data_unref (data);
1608 /* ---------------------------------------------------------------------------------------------------- */
1610 /* must hold lock */
1612 send_message_data_deliver_reply_unlocked (SendMessageData *data,
1613 GDBusMessage *reply)
1615 if (data->delivered)
1618 g_simple_async_result_set_op_res_gpointer (data->simple,
1619 g_object_ref (reply),
1622 send_message_with_reply_deliver (data);
1628 /* ---------------------------------------------------------------------------------------------------- */
1631 send_message_with_reply_cancelled_idle_cb (gpointer user_data)
1633 SendMessageData *data = user_data;
1635 CONNECTION_LOCK (data->connection);
1636 if (data->delivered)
1639 g_simple_async_result_set_error (data->simple,
1641 G_IO_ERROR_CANCELLED,
1642 _("Operation was cancelled"));
1644 send_message_with_reply_deliver (data);
1647 CONNECTION_UNLOCK (data->connection);
1651 /* Can be called from any thread with or without lock held */
1653 send_message_with_reply_cancelled_cb (GCancellable *cancellable,
1656 SendMessageData *data = user_data;
1657 GSource *idle_source;
1659 /* postpone cancellation to idle handler since we may be called directly
1660 * via g_cancellable_connect() (e.g. holding lock)
1662 idle_source = g_idle_source_new ();
1663 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
1664 g_source_set_callback (idle_source,
1665 send_message_with_reply_cancelled_idle_cb,
1666 send_message_data_ref (data),
1667 (GDestroyNotify) send_message_data_unref);
1668 g_source_attach (idle_source, data->main_context);
1669 g_source_unref (idle_source);
1672 /* ---------------------------------------------------------------------------------------------------- */
1675 send_message_with_reply_timeout_cb (gpointer user_data)
1677 SendMessageData *data = user_data;
1679 CONNECTION_LOCK (data->connection);
1680 if (data->delivered)
1683 g_simple_async_result_set_error (data->simple,
1685 G_IO_ERROR_TIMED_OUT,
1686 _("Timeout was reached"));
1688 send_message_with_reply_deliver (data);
1691 CONNECTION_UNLOCK (data->connection);
1696 /* ---------------------------------------------------------------------------------------------------- */
1699 g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
1700 GDBusMessage *message,
1701 GDBusSendMessageFlags flags,
1703 volatile guint32 *out_serial,
1704 GCancellable *cancellable,
1705 GAsyncReadyCallback callback,
1708 GSimpleAsyncResult *simple;
1709 SendMessageData *data;
1711 volatile guint32 serial;
1715 if (out_serial == NULL)
1716 out_serial = &serial;
1718 if (timeout_msec == -1)
1719 timeout_msec = 25 * 1000;
1721 simple = g_simple_async_result_new (G_OBJECT (connection),
1724 g_dbus_connection_send_message_with_reply);
1726 if (g_cancellable_is_cancelled (cancellable))
1728 g_simple_async_result_set_error (simple,
1730 G_IO_ERROR_CANCELLED,
1731 _("Operation was cancelled"));
1732 g_simple_async_result_complete_in_idle (simple);
1733 g_object_unref (simple);
1737 if (connection->closed)
1739 g_simple_async_result_set_error (simple,
1742 _("The connection is closed"));
1743 g_simple_async_result_complete_in_idle (simple);
1744 g_object_unref (simple);
1749 if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
1751 g_simple_async_result_set_from_error (simple, error);
1752 g_simple_async_result_complete_in_idle (simple);
1753 g_object_unref (simple);
1757 data = g_new0 (SendMessageData, 1);
1758 data->ref_count = 1;
1759 data->connection = g_object_ref (connection);
1760 data->simple = simple;
1761 data->serial = *out_serial;
1762 data->main_context = g_main_context_get_thread_default ();
1763 if (data->main_context != NULL)
1764 g_main_context_ref (data->main_context);
1766 if (cancellable != NULL)
1768 data->cancellable = g_object_ref (cancellable);
1769 data->cancellable_handler_id = g_cancellable_connect (cancellable,
1770 G_CALLBACK (send_message_with_reply_cancelled_cb),
1771 send_message_data_ref (data),
1772 (GDestroyNotify) send_message_data_unref);
1773 g_object_set_data_full (G_OBJECT (simple),
1775 g_object_ref (cancellable),
1776 (GDestroyNotify) g_object_unref);
1779 if (timeout_msec != G_MAXINT)
1781 data->timeout_source = g_timeout_source_new (timeout_msec);
1782 g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
1783 g_source_set_callback (data->timeout_source,
1784 send_message_with_reply_timeout_cb,
1785 send_message_data_ref (data),
1786 (GDestroyNotify) send_message_data_unref);
1787 g_source_attach (data->timeout_source, data->main_context);
1788 g_source_unref (data->timeout_source);
1791 g_hash_table_insert (connection->map_method_serial_to_send_message_data,
1792 GUINT_TO_POINTER (*out_serial),
1800 * g_dbus_connection_send_message_with_reply:
1801 * @connection: A #GDBusConnection.
1802 * @message: A #GDBusMessage.
1803 * @flags: Flags affecting how the message is sent.
1804 * @timeout_msec: The timeout in milliseconds, -1 to use the default
1805 * timeout or %G_MAXINT for no timeout.
1806 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1807 * @cancellable: A #GCancellable or %NULL.
1808 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
1809 * care about the result.
1810 * @user_data: The data to pass to @callback.
1812 * Asynchronously sends @message to the peer represented by @connection.
1814 * Unless @flags contain the
1815 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1816 * will be assigned by @connection and set on @message via
1817 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1818 * serial number used will be written to this location prior to
1819 * submitting the message to the underlying transport.
1821 * If @connection is closed then the operation will fail with
1822 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1823 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1824 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1826 * This is an asynchronous method. When the operation is finished, @callback will be invoked
1827 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
1828 * of the thread you are calling this method from. You can then call
1829 * g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
1830 * See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
1832 * Note that @message must be unlocked, unless @flags contain the
1833 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1835 * See <xref linkend="gdbus-server"/> and <xref
1836 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1837 * low-level API to send and receive UNIX file descriptors.
1842 g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
1843 GDBusMessage *message,
1844 GDBusSendMessageFlags flags,
1846 volatile guint32 *out_serial,
1847 GCancellable *cancellable,
1848 GAsyncReadyCallback callback,
1851 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
1852 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1853 g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
1854 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
1856 CONNECTION_LOCK (connection);
1857 g_dbus_connection_send_message_with_reply_unlocked (connection,
1865 CONNECTION_UNLOCK (connection);
1869 * g_dbus_connection_send_message_with_reply_finish:
1870 * @connection: a #GDBusConnection
1871 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
1872 * @error: Return location for error or %NULL.
1874 * Finishes an operation started with g_dbus_connection_send_message_with_reply().
1876 * Note that @error is only set if a local in-process error
1877 * occured. That is to say that the returned #GDBusMessage object may
1878 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
1879 * g_dbus_message_to_gerror() to transcode this to a #GError.
1881 * See <xref linkend="gdbus-server"/> and <xref
1882 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1883 * low-level API to send and receive UNIX file descriptors.
1885 * Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set.
1890 g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
1894 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1895 GDBusMessage *reply;
1896 GCancellable *cancellable;
1898 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1899 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1903 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_send_message_with_reply);
1905 if (g_simple_async_result_propagate_error (simple, error))
1908 reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
1909 cancellable = g_object_get_data (G_OBJECT (simple), "cancellable");
1910 if (cancellable != NULL && g_cancellable_is_cancelled (cancellable))
1912 g_object_unref (reply);
1914 g_set_error_literal (error,
1916 G_IO_ERROR_CANCELLED,
1917 _("Operation was cancelled"));
1923 /* ---------------------------------------------------------------------------------------------------- */
1928 GMainContext *context;
1930 } SendMessageSyncData;
1933 send_message_with_reply_sync_cb (GDBusConnection *connection,
1937 SendMessageSyncData *data = user_data;
1938 data->res = g_object_ref (res);
1939 g_main_loop_quit (data->loop);
1943 * g_dbus_connection_send_message_with_reply_sync:
1944 * @connection: A #GDBusConnection.
1945 * @message: A #GDBusMessage.
1946 * @flags: Flags affecting how the message is sent.
1947 * @timeout_msec: The timeout in milliseconds, -1 to use the default
1948 * timeout or %G_MAXINT for no timeout.
1949 * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
1950 * @cancellable: A #GCancellable or %NULL.
1951 * @error: Return location for error or %NULL.
1953 * Synchronously sends @message to the peer represented by @connection
1954 * and blocks the calling thread until a reply is received or the
1955 * timeout is reached. See g_dbus_connection_send_message_with_reply()
1956 * for the asynchronous version of this method.
1958 * Unless @flags contain the
1959 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
1960 * will be assigned by @connection and set on @message via
1961 * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
1962 * serial number used will be written to this location prior to
1963 * submitting the message to the underlying transport.
1965 * If @connection is closed then the operation will fail with
1966 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
1967 * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
1968 * the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
1970 * Note that @error is only set if a local in-process error
1971 * occured. That is to say that the returned #GDBusMessage object may
1972 * be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
1973 * g_dbus_message_to_gerror() to transcode this to a #GError.
1975 * See <xref linkend="gdbus-server"/> and <xref
1976 * linkend="gdbus-unix-fd-client"/> for an example of how to use this
1977 * low-level API to send and receive UNIX file descriptors.
1979 * Note that @message must be unlocked, unless @flags contain the
1980 * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
1982 * Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set.
1987 g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
1988 GDBusMessage *message,
1989 GDBusSendMessageFlags flags,
1991 volatile guint32 *out_serial,
1992 GCancellable *cancellable,
1995 SendMessageSyncData *data;
1996 GDBusMessage *reply;
1998 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
1999 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2000 g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
2001 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
2002 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2004 data = g_new0 (SendMessageSyncData, 1);
2005 data->context = g_main_context_new ();
2006 data->loop = g_main_loop_new (data->context, FALSE);
2008 g_main_context_push_thread_default (data->context);
2010 g_dbus_connection_send_message_with_reply (connection,
2016 (GAsyncReadyCallback) send_message_with_reply_sync_cb,
2018 g_main_loop_run (data->loop);
2019 reply = g_dbus_connection_send_message_with_reply_finish (connection,
2023 g_main_context_pop_thread_default (data->context);
2025 g_main_context_unref (data->context);
2026 g_main_loop_unref (data->loop);
2027 g_object_unref (data->res);
2033 /* ---------------------------------------------------------------------------------------------------- */
2037 GDBusMessageFilterFunction func;
2044 GDBusMessageFilterFunction filter_function;
2046 GDestroyNotify user_data_free_func;
2049 /* Called in worker's thread - we must not block */
2051 on_worker_message_received (GDBusWorker *worker,
2052 GDBusMessage *message,
2055 GDBusConnection *connection;
2056 FilterCallback *filters;
2057 gboolean consumed_by_filter;
2058 gboolean altered_by_filter;
2063 G_LOCK (message_bus_lock);
2064 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2067 G_UNLOCK (message_bus_lock);
2070 connection = G_DBUS_CONNECTION (user_data);
2071 g_object_ref (connection);
2072 G_UNLOCK (message_bus_lock);
2074 //g_debug ("in on_worker_message_received");
2076 g_object_ref (message);
2077 g_dbus_message_lock (message);
2079 //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
2081 /* First collect the set of callback functions */
2082 CONNECTION_LOCK (connection);
2083 num_filters = connection->filters->len;
2084 filters = g_new0 (FilterCallback, num_filters);
2085 for (n = 0; n < num_filters; n++)
2087 FilterData *data = connection->filters->pdata[n];
2088 filters[n].func = data->filter_function;
2089 filters[n].user_data = data->user_data;
2091 CONNECTION_UNLOCK (connection);
2093 /* then call the filters in order (without holding the lock) */
2094 consumed_by_filter = FALSE;
2095 altered_by_filter = FALSE;
2096 for (n = 0; n < num_filters; n++)
2098 message = filters[n].func (connection,
2101 filters[n].user_data);
2102 if (message == NULL)
2104 g_dbus_message_lock (message);
2107 /* Standard dispatch unless the filter ate the message - no need to
2108 * do anything if the message was altered
2110 if (message != NULL)
2112 GDBusMessageType message_type;
2114 message_type = g_dbus_message_get_message_type (message);
2115 if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
2117 guint32 reply_serial;
2118 SendMessageData *send_message_data;
2120 reply_serial = g_dbus_message_get_reply_serial (message);
2121 CONNECTION_LOCK (connection);
2122 send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
2123 GUINT_TO_POINTER (reply_serial));
2124 if (send_message_data != NULL)
2126 //g_debug ("delivering reply/error for serial %d for %p", reply_serial, connection);
2127 send_message_data_deliver_reply_unlocked (send_message_data, message);
2131 //g_debug ("message reply/error for serial %d but no SendMessageData found for %p", reply_serial, connection);
2133 CONNECTION_UNLOCK (connection);
2135 else if (message_type == G_DBUS_MESSAGE_TYPE_SIGNAL)
2137 CONNECTION_LOCK (connection);
2138 distribute_signals (connection, message);
2139 CONNECTION_UNLOCK (connection);
2141 else if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_CALL)
2143 CONNECTION_LOCK (connection);
2144 distribute_method_call (connection, message);
2145 CONNECTION_UNLOCK (connection);
2149 if (message != NULL)
2150 g_object_unref (message);
2151 g_object_unref (connection);
2155 /* Called in worker's thread */
2156 static GDBusMessage *
2157 on_worker_message_about_to_be_sent (GDBusWorker *worker,
2158 GDBusMessage *message,
2161 GDBusConnection *connection;
2162 FilterCallback *filters;
2167 G_LOCK (message_bus_lock);
2168 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2171 G_UNLOCK (message_bus_lock);
2174 connection = G_DBUS_CONNECTION (user_data);
2175 g_object_ref (connection);
2176 G_UNLOCK (message_bus_lock);
2178 //g_debug ("in on_worker_message_about_to_be_sent");
2180 /* First collect the set of callback functions */
2181 CONNECTION_LOCK (connection);
2182 num_filters = connection->filters->len;
2183 filters = g_new0 (FilterCallback, num_filters);
2184 for (n = 0; n < num_filters; n++)
2186 FilterData *data = connection->filters->pdata[n];
2187 filters[n].func = data->filter_function;
2188 filters[n].user_data = data->user_data;
2190 CONNECTION_UNLOCK (connection);
2192 /* then call the filters in order (without holding the lock) */
2193 for (n = 0; n < num_filters; n++)
2195 g_dbus_message_lock (message);
2196 message = filters[n].func (connection,
2199 filters[n].user_data);
2200 if (message == NULL)
2204 g_object_unref (connection);
2210 /* Called in worker's thread - we must not block */
2212 on_worker_closed (GDBusWorker *worker,
2213 gboolean remote_peer_vanished,
2217 GDBusConnection *connection;
2220 G_LOCK (message_bus_lock);
2221 alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
2224 G_UNLOCK (message_bus_lock);
2227 connection = G_DBUS_CONNECTION (user_data);
2228 g_object_ref (connection);
2229 G_UNLOCK (message_bus_lock);
2231 //g_debug ("in on_worker_closed: %s", error->message);
2233 CONNECTION_LOCK (connection);
2234 if (!connection->closed)
2235 set_closed_unlocked (connection, remote_peer_vanished, error);
2236 CONNECTION_UNLOCK (connection);
2238 g_object_unref (connection);
2241 /* ---------------------------------------------------------------------------------------------------- */
2243 /* Determines the biggest set of capabilities we can support on this connection */
2244 static GDBusCapabilityFlags
2245 get_offered_capabilities_max (GDBusConnection *connection)
2247 GDBusCapabilityFlags ret;
2248 ret = G_DBUS_CAPABILITY_FLAGS_NONE;
2250 if (G_IS_UNIX_CONNECTION (connection->stream))
2251 ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
2257 initable_init (GInitable *initable,
2258 GCancellable *cancellable,
2261 GDBusConnection *connection = G_DBUS_CONNECTION (initable);
2264 /* This method needs to be idempotent to work with the singleton
2265 * pattern. See the docs for g_initable_init(). We implement this by
2268 * Unfortunately we can't use the main lock since the on_worker_*()
2269 * callbacks above needs the lock during initialization (for message
2270 * bus connections we do a synchronous Hello() call on the bus).
2272 g_mutex_lock (connection->init_lock);
2276 if (connection->is_initialized)
2278 if (connection->stream != NULL)
2281 g_assert (connection->initialization_error != NULL);
2284 g_assert (connection->initialization_error == NULL);
2286 /* The user can pass multiple (but mutally exclusive) construct
2289 * - stream (of type GIOStream)
2290 * - address (of type gchar*)
2292 * At the end of the day we end up with a non-NULL GIOStream
2293 * object in connection->stream.
2295 if (connection->address != NULL)
2297 g_assert (connection->stream == NULL);
2299 if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
2300 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
2302 g_set_error_literal (error,
2304 G_IO_ERROR_INVALID_ARGUMENT,
2305 _("Unsupported flags encountered when constructing a client-side connection"));
2309 connection->stream = g_dbus_address_get_stream_sync (connection->address,
2310 NULL, /* TODO: out_guid */
2312 &connection->initialization_error);
2313 if (connection->stream == NULL)
2316 else if (connection->stream != NULL)
2322 g_assert_not_reached ();
2325 /* Authenticate the connection */
2326 if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
2328 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
2329 g_assert (connection->guid != NULL);
2330 connection->auth = _g_dbus_auth_new (connection->stream);
2331 if (!_g_dbus_auth_run_server (connection->auth,
2332 connection->authentication_observer,
2334 (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
2335 get_offered_capabilities_max (connection),
2336 &connection->capabilities,
2337 &connection->credentials,
2339 &connection->initialization_error))
2342 else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
2344 g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
2345 g_assert (connection->guid == NULL);
2346 connection->auth = _g_dbus_auth_new (connection->stream);
2347 connection->guid = _g_dbus_auth_run_client (connection->auth,
2348 get_offered_capabilities_max (connection),
2349 &connection->capabilities,
2351 &connection->initialization_error);
2352 if (connection->guid == NULL)
2356 if (connection->authentication_observer != NULL)
2358 g_object_unref (connection->authentication_observer);
2359 connection->authentication_observer = NULL;
2362 //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
2364 //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
2369 * https://bugzilla.gnome.org/show_bug.cgi?id=616458
2373 if (G_IS_SOCKET_CONNECTION (connection->stream))
2375 g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
2379 G_LOCK (message_bus_lock);
2380 if (alive_connections == NULL)
2381 alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
2382 g_hash_table_insert (alive_connections, connection, connection);
2383 G_UNLOCK (message_bus_lock);
2385 connection->worker = _g_dbus_worker_new (connection->stream,
2386 connection->capabilities,
2387 (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING),
2388 on_worker_message_received,
2389 on_worker_message_about_to_be_sent,
2393 /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
2394 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
2396 GVariant *hello_result;
2398 /* we could lift this restriction by adding code in gdbusprivate.c */
2399 if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
2401 g_set_error_literal (&connection->initialization_error,
2404 "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
2408 hello_result = g_dbus_connection_call_sync (connection,
2409 "org.freedesktop.DBus", /* name */
2410 "/org/freedesktop/DBus", /* path */
2411 "org.freedesktop.DBus", /* interface */
2413 NULL, /* parameters */
2414 G_VARIANT_TYPE ("(s)"),
2415 G_DBUS_CALL_FLAGS_NONE,
2417 NULL, /* TODO: cancellable */
2418 &connection->initialization_error);
2419 if (hello_result == NULL)
2422 g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
2423 g_variant_unref (hello_result);
2424 //g_debug ("unique name is `%s'", connection->bus_unique_name);
2427 connection->is_initialized = TRUE;
2433 g_assert (connection->initialization_error != NULL);
2434 g_propagate_error (error, g_error_copy (connection->initialization_error));
2437 g_mutex_unlock (connection->init_lock);
2443 initable_iface_init (GInitableIface *initable_iface)
2445 initable_iface->init = initable_init;
2448 /* ---------------------------------------------------------------------------------------------------- */
2451 async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
2456 /* ---------------------------------------------------------------------------------------------------- */
2459 * g_dbus_connection_new:
2460 * @stream: A #GIOStream.
2461 * @guid: The GUID to use if a authenticating as a server or %NULL.
2462 * @flags: Flags describing how to make the connection.
2463 * @observer: A #GDBusAuthObserver or %NULL.
2464 * @cancellable: A #GCancellable or %NULL.
2465 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2466 * @user_data: The data to pass to @callback.
2468 * Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
2469 * with the end represented by @stream.
2471 * If @observer is not %NULL it may be used to control the
2472 * authentication process.
2474 * When the operation is finished, @callback will be invoked. You can
2475 * then call g_dbus_connection_new_finish() to get the result of the
2478 * This is a asynchronous failable constructor. See
2479 * g_dbus_connection_new_sync() for the synchronous
2485 g_dbus_connection_new (GIOStream *stream,
2487 GDBusConnectionFlags flags,
2488 GDBusAuthObserver *observer,
2489 GCancellable *cancellable,
2490 GAsyncReadyCallback callback,
2493 g_return_if_fail (G_IS_IO_STREAM (stream));
2494 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2502 "authentication-observer", observer,
2507 * g_dbus_connection_new_finish:
2508 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2509 * @error: Return location for error or %NULL.
2511 * Finishes an operation started with g_dbus_connection_new().
2513 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2518 g_dbus_connection_new_finish (GAsyncResult *res,
2522 GObject *source_object;
2524 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2525 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2527 source_object = g_async_result_get_source_object (res);
2528 g_assert (source_object != NULL);
2529 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2532 g_object_unref (source_object);
2534 return G_DBUS_CONNECTION (object);
2540 * g_dbus_connection_new_sync:
2541 * @stream: A #GIOStream.
2542 * @guid: The GUID to use if a authenticating as a server or %NULL.
2543 * @flags: Flags describing how to make the connection.
2544 * @observer: A #GDBusAuthObserver or %NULL.
2545 * @cancellable: A #GCancellable or %NULL.
2546 * @error: Return location for error or %NULL.
2548 * Synchronously sets up a D-Bus connection for exchanging D-Bus messages
2549 * with the end represented by @stream.
2551 * If @observer is not %NULL it may be used to control the
2552 * authentication process.
2554 * This is a synchronous failable constructor. See
2555 * g_dbus_connection_new() for the asynchronous version.
2557 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2562 g_dbus_connection_new_sync (GIOStream *stream,
2564 GDBusConnectionFlags flags,
2565 GDBusAuthObserver *observer,
2566 GCancellable *cancellable,
2569 g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
2570 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2571 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2577 "authentication-observer", observer,
2581 /* ---------------------------------------------------------------------------------------------------- */
2584 * g_dbus_connection_new_for_address:
2585 * @address: A D-Bus address.
2586 * @flags: Flags describing how to make the connection.
2587 * @observer: A #GDBusAuthObserver or %NULL.
2588 * @cancellable: A #GCancellable or %NULL.
2589 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
2590 * @user_data: The data to pass to @callback.
2592 * Asynchronously connects and sets up a D-Bus client connection for
2593 * exchanging D-Bus messages with an endpoint specified by @address
2594 * which must be in the D-Bus address format.
2596 * This constructor can only be used to initiate client-side
2597 * connections - use g_dbus_connection_new() if you need to act as the
2598 * server. In particular, @flags cannot contain the
2599 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2600 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2602 * When the operation is finished, @callback will be invoked. You can
2603 * then call g_dbus_connection_new_finish() to get the result of the
2606 * If @observer is not %NULL it may be used to control the
2607 * authentication process.
2609 * This is a asynchronous failable constructor. See
2610 * g_dbus_connection_new_for_address_sync() for the synchronous
2616 g_dbus_connection_new_for_address (const gchar *address,
2617 GDBusConnectionFlags flags,
2618 GDBusAuthObserver *observer,
2619 GCancellable *cancellable,
2620 GAsyncReadyCallback callback,
2623 g_return_if_fail (address != NULL);
2624 g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
2631 "authentication-observer", observer,
2636 * g_dbus_connection_new_for_address_finish:
2637 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
2638 * @error: Return location for error or %NULL.
2640 * Finishes an operation started with g_dbus_connection_new_for_address().
2642 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2647 g_dbus_connection_new_for_address_finish (GAsyncResult *res,
2651 GObject *source_object;
2653 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2654 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2656 source_object = g_async_result_get_source_object (res);
2657 g_assert (source_object != NULL);
2658 object = g_async_initable_new_finish (G_ASYNC_INITABLE (source_object),
2661 g_object_unref (source_object);
2663 return G_DBUS_CONNECTION (object);
2669 * g_dbus_connection_new_for_address_sync:
2670 * @address: A D-Bus address.
2671 * @flags: Flags describing how to make the connection.
2672 * @observer: A #GDBusAuthObserver or %NULL.
2673 * @cancellable: A #GCancellable or %NULL.
2674 * @error: Return location for error or %NULL.
2676 * Synchronously connects and sets up a D-Bus client connection for
2677 * exchanging D-Bus messages with an endpoint specified by @address
2678 * which must be in the D-Bus address format.
2680 * This constructor can only be used to initiate client-side
2681 * connections - use g_dbus_connection_new_sync() if you need to act
2682 * as the server. In particular, @flags cannot contain the
2683 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER or
2684 * %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS flags.
2686 * This is a synchronous failable constructor. See
2687 * g_dbus_connection_new_for_address() for the asynchronous version.
2689 * If @observer is not %NULL it may be used to control the
2690 * authentication process.
2692 * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
2697 g_dbus_connection_new_for_address_sync (const gchar *address,
2698 GDBusConnectionFlags flags,
2699 GDBusAuthObserver *observer,
2700 GCancellable *cancellable,
2703 g_return_val_if_fail (address != NULL, NULL);
2704 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2705 return g_initable_new (G_TYPE_DBUS_CONNECTION,
2710 "authentication-observer", observer,
2714 /* ---------------------------------------------------------------------------------------------------- */
2717 * g_dbus_connection_set_exit_on_close:
2718 * @connection: A #GDBusConnection.
2719 * @exit_on_close: Whether the process should be terminated
2720 * when @connection is closed by the remote peer.
2722 * Sets whether the process should be terminated when @connection is
2723 * closed by the remote peer. See #GDBusConnection:exit-on-close for
2729 g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
2730 gboolean exit_on_close)
2732 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2733 connection->exit_on_close = exit_on_close;
2737 * g_dbus_connection_get_exit_on_close:
2738 * @connection: A #GDBusConnection.
2740 * Gets whether the process is terminated when @connection is
2741 * closed by the remote peer. See
2742 * #GDBusConnection:exit-on-close for more details.
2744 * Returns: Whether the process is terminated when @connection is
2745 * closed by the remote peer.
2750 g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
2752 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
2753 return connection->exit_on_close;
2757 * g_dbus_connection_get_guid:
2758 * @connection: A #GDBusConnection.
2760 * The GUID of the peer performing the role of server when
2761 * authenticating. See #GDBusConnection:guid for more details.
2763 * Returns: The GUID. Do not free this string, it is owned by
2769 g_dbus_connection_get_guid (GDBusConnection *connection)
2771 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2772 return connection->guid;
2776 * g_dbus_connection_get_unique_name:
2777 * @connection: A #GDBusConnection.
2779 * Gets the unique name of @connection as assigned by the message
2780 * bus. This can also be used to figure out if @connection is a
2781 * message bus connection.
2783 * Returns: The unique name or %NULL if @connection is not a message
2784 * bus connection. Do not free this string, it is owned by
2790 g_dbus_connection_get_unique_name (GDBusConnection *connection)
2792 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2793 return connection->bus_unique_name;
2797 * g_dbus_connection_get_peer_credentials:
2798 * @connection: A #GDBusConnection.
2800 * Gets the credentials of the authenticated peer. This will always
2801 * return %NULL unless @connection acted as a server
2802 * (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed)
2803 * when set up and the client passed credentials as part of the
2804 * authentication process.
2806 * In a message bus setup, the message bus is always the server and
2807 * each application is a client. So this method will always return
2808 * %NULL for message bus clients.
2810 * Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free
2811 * this object, it is owned by @connection.
2816 g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
2818 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
2819 return connection->credentials;
2822 /* ---------------------------------------------------------------------------------------------------- */
2824 static guint _global_filter_id = 1;
2827 * g_dbus_connection_add_filter:
2828 * @connection: A #GDBusConnection.
2829 * @filter_function: A filter function.
2830 * @user_data: User data to pass to @filter_function.
2831 * @user_data_free_func: Function to free @user_data with when filter
2832 * is removed or %NULL.
2834 * Adds a message filter. Filters are handlers that are run on all
2835 * incoming and outgoing messages, prior to standard dispatch. Filters
2836 * are run in the order that they were added. The same handler can be
2837 * added as a filter more than once, in which case it will be run more
2838 * than once. Filters added during a filter callback won't be run on
2839 * the message being processed. Filter functions are allowed to modify
2840 * and even drop messages - see the #GDBusMessageFilterResult
2841 * enumeration for details.
2843 * Note that filters are run in a dedicated message handling thread so
2844 * they can't block and, generally, can't do anything but signal a
2845 * worker thread. Also note that filters are rarely needed - use API
2846 * such as g_dbus_connection_send_message_with_reply(),
2847 * g_dbus_connection_signal_subscribe() or
2848 * g_dbus_connection_call() instead.
2850 * If a filter consumes an incoming message the message is not
2851 * dispatched anywhere else - not even the standard dispatch machinery
2852 * (that API such as g_dbus_connection_signal_subscribe() and
2853 * g_dbus_connection_send_message_with_reply() relies on) will see the
2854 * message. Similary, if a filter consumes an outgoing message, the
2855 * message will not be sent to the other peer.
2857 * Returns: A filter identifier that can be used with
2858 * g_dbus_connection_remove_filter().
2863 g_dbus_connection_add_filter (GDBusConnection *connection,
2864 GDBusMessageFilterFunction filter_function,
2866 GDestroyNotify user_data_free_func)
2870 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
2871 g_return_val_if_fail (filter_function != NULL, 0);
2873 CONNECTION_LOCK (connection);
2874 data = g_new0 (FilterData, 1);
2875 data->id = _global_filter_id++; /* TODO: overflow etc. */
2876 data->filter_function = filter_function;
2877 data->user_data = user_data;
2878 data->user_data_free_func = user_data_free_func;
2879 g_ptr_array_add (connection->filters, data);
2880 CONNECTION_UNLOCK (connection);
2885 /* only called from finalize(), removes all filters */
2887 purge_all_filters (GDBusConnection *connection)
2890 for (n = 0; n < connection->filters->len; n++)
2892 FilterData *data = connection->filters->pdata[n];
2893 if (data->user_data_free_func != NULL)
2894 data->user_data_free_func (data->user_data);
2900 * g_dbus_connection_remove_filter:
2901 * @connection: a #GDBusConnection
2902 * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
2909 g_dbus_connection_remove_filter (GDBusConnection *connection,
2913 FilterData *to_destroy;
2915 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
2917 CONNECTION_LOCK (connection);
2919 for (n = 0; n < connection->filters->len; n++)
2921 FilterData *data = connection->filters->pdata[n];
2922 if (data->id == filter_id)
2924 g_ptr_array_remove_index (connection->filters, n);
2929 CONNECTION_UNLOCK (connection);
2931 /* do free without holding lock */
2932 if (to_destroy != NULL)
2934 if (to_destroy->user_data_free_func != NULL)
2935 to_destroy->user_data_free_func (to_destroy->user_data);
2936 g_free (to_destroy);
2940 g_warning ("g_dbus_connection_remove_filter: No filter found for filter_id %d", filter_id);
2944 /* ---------------------------------------------------------------------------------------------------- */
2950 gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
2951 gchar *interface_name;
2955 GArray *subscribers;
2960 GDBusSignalCallback callback;
2962 GDestroyNotify user_data_free_func;
2964 GMainContext *context;
2968 signal_data_free (SignalData *signal_data)
2970 g_free (signal_data->rule);
2971 g_free (signal_data->sender);
2972 g_free (signal_data->sender_unique_name);
2973 g_free (signal_data->interface_name);
2974 g_free (signal_data->member);
2975 g_free (signal_data->object_path);
2976 g_free (signal_data->arg0);
2977 g_array_free (signal_data->subscribers, TRUE);
2978 g_free (signal_data);
2982 args_to_rule (const gchar *sender,
2983 const gchar *interface_name,
2984 const gchar *member,
2985 const gchar *object_path,
2990 rule = g_string_new ("type='signal'");
2992 g_string_append_printf (rule, ",sender='%s'", sender);
2993 if (interface_name != NULL)
2994 g_string_append_printf (rule, ",interface='%s'", interface_name);
2996 g_string_append_printf (rule, ",member='%s'", member);
2997 if (object_path != NULL)
2998 g_string_append_printf (rule, ",path='%s'", object_path);
3000 g_string_append_printf (rule, ",arg0='%s'", arg0);
3002 return g_string_free (rule, FALSE);
3005 static guint _global_subscriber_id = 1;
3006 static guint _global_registration_id = 1;
3007 static guint _global_subtree_registration_id = 1;
3009 /* ---------------------------------------------------------------------------------------------------- */
3011 /* must hold lock when calling */
3013 add_match_rule (GDBusConnection *connection,
3014 const gchar *match_rule)
3017 GDBusMessage *message;
3019 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3020 "/org/freedesktop/DBus", /* path */
3021 "org.freedesktop.DBus", /* interface */
3023 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3025 if (!g_dbus_connection_send_message_unlocked (connection,
3027 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3031 g_critical ("Error while sending AddMatch() message: %s", error->message);
3032 g_error_free (error);
3034 g_object_unref (message);
3037 /* ---------------------------------------------------------------------------------------------------- */
3039 /* must hold lock when calling */
3041 remove_match_rule (GDBusConnection *connection,
3042 const gchar *match_rule)
3045 GDBusMessage *message;
3047 message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
3048 "/org/freedesktop/DBus", /* path */
3049 "org.freedesktop.DBus", /* interface */
3051 g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
3054 if (!g_dbus_connection_send_message_unlocked (connection,
3056 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
3060 g_critical ("Error while sending RemoveMatch() message: %s", error->message);
3061 g_error_free (error);
3063 g_object_unref (message);
3066 /* ---------------------------------------------------------------------------------------------------- */
3069 is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
3071 return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
3072 g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
3073 g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
3074 (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
3075 g_strcmp0 (signal_data->member, "NameAcquired") == 0);
3078 /* ---------------------------------------------------------------------------------------------------- */
3081 * g_dbus_connection_signal_subscribe:
3082 * @connection: A #GDBusConnection.
3083 * @sender: Sender name to match on (unique or well-known name) or %NULL to listen from all senders.
3084 * @interface_name: D-Bus interface name to match on or %NULL to match on all interfaces.
3085 * @member: D-Bus signal name to match on or %NULL to match on all signals.
3086 * @object_path: Object path to match on or %NULL to match on all object paths.
3087 * @arg0: Contents of first string argument to match on or %NULL to match on all kinds of arguments.
3088 * @flags: Flags describing how to subscribe to the signal (currently unused).
3089 * @callback: Callback to invoke when there is a signal matching the requested data.
3090 * @user_data: User data to pass to @callback.
3091 * @user_data_free_func: Function to free @user_data with when subscription is removed or %NULL.
3093 * Subscribes to signals on @connection and invokes @callback with a
3094 * whenever the signal is received. Note that @callback
3095 * will be invoked in the <link
3096 * linkend="g-main-context-push-thread-default">thread-default main
3097 * loop</link> of the thread you are calling this method from.
3099 * If @connection is not a message bus connection, @sender must be
3102 * If @sender is a well-known name note that @callback is invoked with
3103 * the unique name for the owner of @sender, not the well-known name
3104 * as one would expect. This is because the message bus rewrites the
3105 * name. As such, to avoid certain race conditions, users should be
3106 * tracking the name owner of the well-known name and use that when
3107 * processing the received signal.
3109 * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
3114 g_dbus_connection_signal_subscribe (GDBusConnection *connection,
3115 const gchar *sender,
3116 const gchar *interface_name,
3117 const gchar *member,
3118 const gchar *object_path,
3120 GDBusSignalFlags flags,
3121 GDBusSignalCallback callback,
3123 GDestroyNotify user_data_free_func)
3126 SignalData *signal_data;
3127 SignalSubscriber subscriber;
3128 GPtrArray *signal_data_array;
3129 const gchar *sender_unique_name;
3131 /* Right now we abort if AddMatch() fails since it can only fail with the bus being in
3132 * an OOM condition. We might want to change that but that would involve making
3133 * g_dbus_connection_signal_subscribe() asynchronous and having the call sites
3134 * handle that. And there's really no sensible way of handling this short of retrying
3135 * to add the match rule... and then there's the little thing that, hey, maybe there's
3136 * a reason the bus in an OOM condition.
3138 * Doable, but not really sure it's worth it...
3141 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
3142 g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
3143 g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
3144 g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
3145 g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
3146 g_return_val_if_fail (callback != NULL, 0);
3148 CONNECTION_LOCK (connection);
3150 rule = args_to_rule (sender, interface_name, member, object_path, arg0);
3152 if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
3153 sender_unique_name = sender;
3155 sender_unique_name = "";
3157 subscriber.callback = callback;
3158 subscriber.user_data = user_data;
3159 subscriber.user_data_free_func = user_data_free_func;
3160 subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
3161 subscriber.context = g_main_context_get_thread_default ();
3162 if (subscriber.context != NULL)
3163 g_main_context_ref (subscriber.context);
3165 /* see if we've already have this rule */
3166 signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
3167 if (signal_data != NULL)
3169 g_array_append_val (signal_data->subscribers, subscriber);
3174 signal_data = g_new0 (SignalData, 1);
3175 signal_data->rule = rule;
3176 signal_data->sender = g_strdup (sender);
3177 signal_data->sender_unique_name = g_strdup (sender_unique_name);
3178 signal_data->interface_name = g_strdup (interface_name);
3179 signal_data->member = g_strdup (member);
3180 signal_data->object_path = g_strdup (object_path);
3181 signal_data->arg0 = g_strdup (arg0);
3182 signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3183 g_array_append_val (signal_data->subscribers, subscriber);
3185 g_hash_table_insert (connection->map_rule_to_signal_data,
3189 /* Add the match rule to the bus...
3191 * Avoid adding match rules for NameLost and NameAcquired messages - the bus will
3192 * always send such messages to us.
3194 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3196 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
3197 add_match_rule (connection, signal_data->rule);
3200 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3201 signal_data->sender_unique_name);
3202 if (signal_data_array == NULL)
3204 signal_data_array = g_ptr_array_new ();
3205 g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
3206 g_strdup (signal_data->sender_unique_name),
3209 g_ptr_array_add (signal_data_array, signal_data);
3212 g_hash_table_insert (connection->map_id_to_signal_data,
3213 GUINT_TO_POINTER (subscriber.id),
3216 CONNECTION_UNLOCK (connection);
3218 return subscriber.id;
3221 /* ---------------------------------------------------------------------------------------------------- */
3223 /* must hold lock when calling this (except if connection->finalizing is TRUE) */
3225 unsubscribe_id_internal (GDBusConnection *connection,
3226 guint subscription_id,
3227 GArray *out_removed_subscribers)
3229 SignalData *signal_data;
3230 GPtrArray *signal_data_array;
3233 signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
3234 GUINT_TO_POINTER (subscription_id));
3235 if (signal_data == NULL)
3237 /* Don't warn here, we may have thrown all subscriptions out when the connection was closed */
3241 for (n = 0; n < signal_data->subscribers->len; n++)
3243 SignalSubscriber *subscriber;
3245 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, n));
3246 if (subscriber->id != subscription_id)
3249 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
3250 GUINT_TO_POINTER (subscription_id)));
3251 g_array_append_val (out_removed_subscribers, *subscriber);
3252 g_array_remove_index (signal_data->subscribers, n);
3254 if (signal_data->subscribers->len == 0)
3256 g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
3258 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
3259 signal_data->sender_unique_name);
3260 g_warn_if_fail (signal_data_array != NULL);
3261 g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
3263 if (signal_data_array->len == 0)
3265 g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
3266 signal_data->sender_unique_name));
3269 /* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
3270 if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
3272 if (!is_signal_data_for_name_lost_or_acquired (signal_data))
3273 if (!connection->closed && !connection->finalizing)
3274 remove_match_rule (connection, signal_data->rule);
3276 signal_data_free (signal_data);
3282 g_assert_not_reached ();
3289 * g_dbus_connection_signal_unsubscribe:
3290 * @connection: A #GDBusConnection.
3291 * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
3293 * Unsubscribes from signals.
3298 g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
3299 guint subscription_id)
3301 GArray *subscribers;
3304 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
3306 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3308 CONNECTION_LOCK (connection);
3309 unsubscribe_id_internal (connection,
3312 CONNECTION_UNLOCK (connection);
3315 g_assert (subscribers->len == 0 || subscribers->len == 1);
3317 /* call GDestroyNotify without lock held */
3318 for (n = 0; n < subscribers->len; n++)
3320 SignalSubscriber *subscriber;
3321 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3322 call_destroy_notify (subscriber->context,
3323 subscriber->user_data_free_func,
3324 subscriber->user_data);
3325 if (subscriber->context != NULL)
3326 g_main_context_unref (subscriber->context);
3329 g_array_free (subscribers, TRUE);
3332 /* ---------------------------------------------------------------------------------------------------- */
3336 guint subscription_id;
3337 GDBusSignalCallback callback;
3339 GDBusMessage *message;
3340 GDBusConnection *connection;
3341 const gchar *sender;
3343 const gchar *interface;
3344 const gchar *member;
3347 /* called on delivery thread (e.g. where g_dbus_connection_signal_subscribe() was called) with
3351 emit_signal_instance_in_idle_cb (gpointer data)
3353 SignalInstance *signal_instance = data;
3354 GVariant *parameters;
3355 gboolean has_subscription;
3357 parameters = g_dbus_message_get_body (signal_instance->message);
3358 if (parameters == NULL)
3360 parameters = g_variant_new ("()");
3361 g_variant_ref_sink (parameters);
3365 g_variant_ref_sink (parameters);
3369 g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
3370 signal_instance->subscription_id,
3371 signal_instance->sender,
3372 signal_instance->path,
3373 signal_instance->interface,
3374 signal_instance->member,
3375 g_variant_print (parameters, TRUE));
3378 /* Careful here, don't do the callback if we no longer has the subscription */
3379 CONNECTION_LOCK (signal_instance->connection);
3380 has_subscription = FALSE;
3381 if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
3382 GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
3383 has_subscription = TRUE;
3384 CONNECTION_UNLOCK (signal_instance->connection);
3386 if (has_subscription)
3387 signal_instance->callback (signal_instance->connection,
3388 signal_instance->sender,
3389 signal_instance->path,
3390 signal_instance->interface,
3391 signal_instance->member,
3393 signal_instance->user_data);
3395 if (parameters != NULL)
3396 g_variant_unref (parameters);
3402 signal_instance_free (SignalInstance *signal_instance)
3404 g_object_unref (signal_instance->message);
3405 g_object_unref (signal_instance->connection);
3406 g_free (signal_instance);
3409 /* called in message handler thread WITH lock held */
3411 schedule_callbacks (GDBusConnection *connection,
3412 GPtrArray *signal_data_array,
3413 GDBusMessage *message,
3414 const gchar *sender)
3417 const gchar *interface;
3418 const gchar *member;
3427 interface = g_dbus_message_get_interface (message);
3428 member = g_dbus_message_get_member (message);
3429 path = g_dbus_message_get_path (message);
3430 arg0 = g_dbus_message_get_arg0 (message);
3433 g_print ("In schedule_callbacks:\n"
3435 " interface = `%s'\n"
3446 /* TODO: if this is slow, then we can change signal_data_array into
3447 * map_object_path_to_signal_data_array or something.
3449 for (n = 0; n < signal_data_array->len; n++)
3451 SignalData *signal_data = signal_data_array->pdata[n];
3453 if (signal_data->interface_name != NULL && g_strcmp0 (signal_data->interface_name, interface) != 0)
3456 if (signal_data->member != NULL && g_strcmp0 (signal_data->member, member) != 0)
3459 if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
3462 if (signal_data->arg0 != NULL && g_strcmp0 (signal_data->arg0, arg0) != 0)
3465 for (m = 0; m < signal_data->subscribers->len; m++)
3467 SignalSubscriber *subscriber;
3468 GSource *idle_source;
3469 SignalInstance *signal_instance;
3471 subscriber = &(g_array_index (signal_data->subscribers, SignalSubscriber, m));
3473 signal_instance = g_new0 (SignalInstance, 1);
3474 signal_instance->subscription_id = subscriber->id;
3475 signal_instance->callback = subscriber->callback;
3476 signal_instance->user_data = subscriber->user_data;
3477 signal_instance->message = g_object_ref (message);
3478 signal_instance->connection = g_object_ref (connection);
3479 signal_instance->sender = sender;
3480 signal_instance->path = path;
3481 signal_instance->interface = interface;
3482 signal_instance->member = member;
3484 idle_source = g_idle_source_new ();
3485 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3486 g_source_set_callback (idle_source,
3487 emit_signal_instance_in_idle_cb,
3489 (GDestroyNotify) signal_instance_free);
3490 g_source_attach (idle_source, subscriber->context);
3491 g_source_unref (idle_source);
3496 /* called in message handler thread with lock held */
3498 distribute_signals (GDBusConnection *connection,
3499 GDBusMessage *message)
3501 GPtrArray *signal_data_array;
3502 const gchar *sender;
3504 sender = g_dbus_message_get_sender (message);
3506 if (G_UNLIKELY (_g_dbus_debug_signal ()))
3508 _g_dbus_debug_print_lock ();
3509 g_print ("========================================================================\n"
3510 "GDBus-debug:Signal:\n"
3511 " <<<< RECEIVED SIGNAL %s.%s\n"
3513 " sent by name %s\n",
3514 g_dbus_message_get_interface (message),
3515 g_dbus_message_get_member (message),
3516 g_dbus_message_get_path (message),
3517 sender != NULL ? sender : "(none)");
3518 _g_dbus_debug_print_unlock ();
3521 /* collect subscribers that match on sender */
3524 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
3525 if (signal_data_array != NULL)
3526 schedule_callbacks (connection, signal_data_array, message, sender);
3529 /* collect subscribers not matching on sender */
3530 signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
3531 if (signal_data_array != NULL)
3532 schedule_callbacks (connection, signal_data_array, message, sender);
3535 /* ---------------------------------------------------------------------------------------------------- */
3537 /* only called from finalize(), removes all subscriptions */
3539 purge_all_signal_subscriptions (GDBusConnection *connection)
3541 GHashTableIter iter;
3544 GArray *subscribers;
3547 ids = g_array_new (FALSE, FALSE, sizeof (guint));
3548 g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
3549 while (g_hash_table_iter_next (&iter, &key, NULL))
3551 guint subscription_id = GPOINTER_TO_UINT (key);
3552 g_array_append_val (ids, subscription_id);
3555 subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
3556 for (n = 0; n < ids->len; n++)
3558 guint subscription_id = g_array_index (ids, guint, n);
3559 unsubscribe_id_internal (connection,
3563 g_array_free (ids, TRUE);
3565 /* call GDestroyNotify without lock held */
3566 for (n = 0; n < subscribers->len; n++)
3568 SignalSubscriber *subscriber;
3569 subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
3570 call_destroy_notify (subscriber->context,
3571 subscriber->user_data_free_func,
3572 subscriber->user_data);
3573 if (subscriber->context != NULL)
3574 g_main_context_unref (subscriber->context);
3577 g_array_free (subscribers, TRUE);
3580 /* ---------------------------------------------------------------------------------------------------- */
3582 static GDBusInterfaceVTable *
3583 _g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
3585 /* Don't waste memory by copying padding - remember to update this
3586 * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
3588 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3592 _g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
3597 /* ---------------------------------------------------------------------------------------------------- */
3599 static GDBusSubtreeVTable *
3600 _g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
3602 /* Don't waste memory by copying padding - remember to update this
3603 * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
3605 return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
3609 _g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
3614 /* ---------------------------------------------------------------------------------------------------- */
3616 struct ExportedObject
3619 GDBusConnection *connection;
3621 /* maps gchar* -> ExportedInterface* */
3622 GHashTable *map_if_name_to_ei;
3625 /* only called with lock held */
3627 exported_object_free (ExportedObject *eo)
3629 g_free (eo->object_path);
3630 g_hash_table_unref (eo->map_if_name_to_ei);
3639 gchar *interface_name;
3640 GDBusInterfaceVTable *vtable;
3641 GDBusInterfaceInfo *interface_info;
3643 GMainContext *context;
3645 GDestroyNotify user_data_free_func;
3646 } ExportedInterface;
3648 /* called with lock held */
3650 exported_interface_free (ExportedInterface *ei)
3652 g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
3654 call_destroy_notify (ei->context,
3655 ei->user_data_free_func,
3658 if (ei->context != NULL)
3659 g_main_context_unref (ei->context);
3661 g_free (ei->interface_name);
3662 _g_dbus_interface_vtable_free (ei->vtable);
3666 /* ---------------------------------------------------------------------------------------------------- */
3668 /* Convenience function to check if @registration_id (if not zero) or
3669 * @subtree_registration_id (if not zero) has been unregistered. If
3670 * so, returns %TRUE.
3672 * Caller must *not* hold lock.
3675 has_object_been_unregistered (GDBusConnection *connection,
3676 guint registration_id,
3677 guint subtree_registration_id)
3681 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
3685 CONNECTION_LOCK (connection);
3686 if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
3687 GUINT_TO_POINTER (registration_id)) == NULL)
3691 else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
3692 GUINT_TO_POINTER (subtree_registration_id)) == NULL)
3696 CONNECTION_UNLOCK (connection);
3701 /* ---------------------------------------------------------------------------------------------------- */
3705 GDBusConnection *connection;
3706 GDBusMessage *message;
3708 const gchar *property_name;
3709 const GDBusInterfaceVTable *vtable;
3710 GDBusInterfaceInfo *interface_info;
3711 const GDBusPropertyInfo *property_info;
3712 guint registration_id;
3713 guint subtree_registration_id;
3717 property_data_free (PropertyData *data)
3719 g_object_unref (data->connection);
3720 g_object_unref (data->message);
3724 /* called in thread where object was registered - no locks held */
3726 invoke_get_property_in_idle_cb (gpointer _data)
3728 PropertyData *data = _data;
3731 GDBusMessage *reply;
3733 if (has_object_been_unregistered (data->connection,
3734 data->registration_id,
3735 data->subtree_registration_id))
3737 reply = g_dbus_message_new_method_error (data->message,
3738 "org.freedesktop.DBus.Error.UnknownMethod",
3739 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
3740 g_dbus_message_get_path (data->message));
3741 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
3742 g_object_unref (reply);
3747 value = data->vtable->get_property (data->connection,
3748 g_dbus_message_get_sender (data->message),
3749 g_dbus_message_get_path (data->message),
3750 data->interface_info->name,
3751 data->property_name,
3758 g_assert_no_error (error);
3760 if (g_variant_is_floating (value))
3761 g_variant_ref_sink (value);
3762 reply = g_dbus_message_new_method_reply (data->message);
3763 g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
3764 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
3765 g_variant_unref (value);
3766 g_object_unref (reply);
3770 gchar *dbus_error_name;
3771 g_assert (error != NULL);
3772 dbus_error_name = g_dbus_error_encode_gerror (error);
3773 reply = g_dbus_message_new_method_error_literal (data->message,
3776 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
3777 g_free (dbus_error_name);
3778 g_error_free (error);
3779 g_object_unref (reply);
3786 /* called in thread where object was registered - no locks held */
3788 invoke_set_property_in_idle_cb (gpointer _data)
3790 PropertyData *data = _data;
3792 GDBusMessage *reply;
3798 g_variant_get (g_dbus_message_get_body (data->message),
3804 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
3805 * of the given value is wrong
3807 if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
3809 reply = g_dbus_message_new_method_error (data->message,
3810 "org.freedesktop.DBus.Error.InvalidArgs",
3811 _("Error setting property `%s': Expected type `%s' but got `%s'"),
3812 data->property_info->name,
3813 data->property_info->signature,
3814 g_variant_get_type_string (value));
3818 if (!data->vtable->set_property (data->connection,
3819 g_dbus_message_get_sender (data->message),
3820 g_dbus_message_get_path (data->message),
3821 data->interface_info->name,
3822 data->property_name,
3827 gchar *dbus_error_name;
3828 g_assert (error != NULL);
3829 dbus_error_name = g_dbus_error_encode_gerror (error);
3830 reply = g_dbus_message_new_method_error_literal (data->message,
3833 g_free (dbus_error_name);
3834 g_error_free (error);
3838 reply = g_dbus_message_new_method_reply (data->message);
3842 g_assert (reply != NULL);
3843 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
3844 g_object_unref (reply);
3845 g_variant_unref (value);
3850 /* called with lock held */
3852 validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
3853 GDBusMessage *message,
3854 guint registration_id,
3855 guint subtree_registration_id,
3857 GDBusInterfaceInfo *interface_info,
3858 const GDBusInterfaceVTable *vtable,
3859 GMainContext *main_context,
3863 const char *interface_name;
3864 const char *property_name;
3865 const GDBusPropertyInfo *property_info;
3866 GSource *idle_source;
3867 PropertyData *property_data;
3868 GDBusMessage *reply;
3873 g_variant_get (g_dbus_message_get_body (message),
3878 g_variant_get (g_dbus_message_get_body (message),
3887 if (vtable == NULL || vtable->get_property == NULL)
3892 if (vtable == NULL || vtable->set_property == NULL)
3896 /* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
3898 property_info = NULL;
3900 /* TODO: the cost of this is O(n) - it might be worth caching the result */
3901 property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
3902 if (property_info == NULL)
3904 reply = g_dbus_message_new_method_error (message,
3905 "org.freedesktop.DBus.Error.InvalidArgs",
3906 _("No such property `%s'"),
3908 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
3909 g_object_unref (reply);
3914 if (is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
3916 reply = g_dbus_message_new_method_error (message,
3917 "org.freedesktop.DBus.Error.InvalidArgs",
3918 _("Property `%s' is not readable"),
3920 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
3921 g_object_unref (reply);
3925 else if (!is_get && !(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE))
3927 reply = g_dbus_message_new_method_error (message,
3928 "org.freedesktop.DBus.Error.InvalidArgs",
3929 _("Property `%s' is not writable"),
3931 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
3932 g_object_unref (reply);
3937 /* ok, got the property info - call user code in an idle handler */
3938 property_data = g_new0 (PropertyData, 1);
3939 property_data->connection = g_object_ref (connection);
3940 property_data->message = g_object_ref (message);
3941 property_data->user_data = user_data;
3942 property_data->property_name = property_name;
3943 property_data->vtable = vtable;
3944 property_data->interface_info = interface_info;
3945 property_data->property_info = property_info;
3946 property_data->registration_id = registration_id;
3947 property_data->subtree_registration_id = subtree_registration_id;
3949 idle_source = g_idle_source_new ();
3950 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
3951 g_source_set_callback (idle_source,
3952 is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
3954 (GDestroyNotify) property_data_free);
3955 g_source_attach (idle_source, main_context);
3956 g_source_unref (idle_source);
3964 /* called with lock held */
3966 handle_getset_property (GDBusConnection *connection,
3968 GDBusMessage *message,
3971 ExportedInterface *ei;
3973 const char *interface_name;
3974 const char *property_name;
3979 g_variant_get (g_dbus_message_get_body (message),
3984 g_variant_get (g_dbus_message_get_body (message),
3990 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
3991 * no such interface registered
3993 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
3996 GDBusMessage *reply;
3997 reply = g_dbus_message_new_method_error (message,
3998 "org.freedesktop.DBus.Error.InvalidArgs",
3999 _("No such interface `%s'"),
4001 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4002 g_object_unref (reply);
4007 handled = validate_and_maybe_schedule_property_getset (eo->connection,
4020 /* ---------------------------------------------------------------------------------------------------- */
4024 GDBusConnection *connection;
4025 GDBusMessage *message;
4027 const GDBusInterfaceVTable *vtable;
4028 GDBusInterfaceInfo *interface_info;
4029 guint registration_id;
4030 guint subtree_registration_id;
4031 } PropertyGetAllData;
4034 property_get_all_data_free (PropertyData *data)
4036 g_object_unref (data->connection);
4037 g_object_unref (data->message);
4041 /* called in thread where object was registered - no locks held */
4043 invoke_get_all_properties_in_idle_cb (gpointer _data)
4045 PropertyGetAllData *data = _data;
4046 GVariantBuilder builder;
4048 GDBusMessage *reply;
4051 if (has_object_been_unregistered (data->connection,
4052 data->registration_id,
4053 data->subtree_registration_id))
4055 reply = g_dbus_message_new_method_error (data->message,
4056 "org.freedesktop.DBus.Error.UnknownMethod",
4057 _("No such interface `org.freedesktop.DBus.Properties' on object at path %s"),
4058 g_dbus_message_get_path (data->message));
4059 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4060 g_object_unref (reply);
4066 /* TODO: Right now we never fail this call - we just omit values if
4067 * a get_property() call is failing.
4069 * We could fail the whole call if just a single get_property() call
4070 * returns an error. We need clarification in the D-Bus spec about this.
4072 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
4073 g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
4074 for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
4076 const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
4079 if (!(property_info->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE))
4082 value = data->vtable->get_property (data->connection,
4083 g_dbus_message_get_sender (data->message),
4084 g_dbus_message_get_path (data->message),
4085 data->interface_info->name,
4086 property_info->name,
4093 if (g_variant_is_floating (value))
4094 g_variant_ref_sink (value);
4095 g_variant_builder_add (&builder,
4097 property_info->name,
4099 g_variant_unref (value);
4101 g_variant_builder_close (&builder);
4103 reply = g_dbus_message_new_method_reply (data->message);
4104 g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
4105 g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4106 g_object_unref (reply);
4112 /* called with lock held */
4114 validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
4115 GDBusMessage *message,
4116 guint registration_id,
4117 guint subtree_registration_id,
4118 GDBusInterfaceInfo *interface_info,
4119 const GDBusInterfaceVTable *vtable,
4120 GMainContext *main_context,
4124 const char *interface_name;
4125 GSource *idle_source;
4126 PropertyGetAllData *property_get_all_data;
4130 g_variant_get (g_dbus_message_get_body (message),
4134 if (vtable == NULL || vtable->get_property == NULL)
4137 /* ok, got the property info - call user in an idle handler */
4138 property_get_all_data = g_new0 (PropertyGetAllData, 1);
4139 property_get_all_data->connection = g_object_ref (connection);
4140 property_get_all_data->message = g_object_ref (message);
4141 property_get_all_data->user_data = user_data;
4142 property_get_all_data->vtable = vtable;
4143 property_get_all_data->interface_info = interface_info;
4144 property_get_all_data->registration_id = registration_id;
4145 property_get_all_data->subtree_registration_id = subtree_registration_id;
4147 idle_source = g_idle_source_new ();
4148 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4149 g_source_set_callback (idle_source,
4150 invoke_get_all_properties_in_idle_cb,
4151 property_get_all_data,
4152 (GDestroyNotify) property_get_all_data_free);
4153 g_source_attach (idle_source, main_context);
4154 g_source_unref (idle_source);
4162 /* called with lock held */
4164 handle_get_all_properties (GDBusConnection *connection,
4166 GDBusMessage *message)
4168 ExportedInterface *ei;
4170 const char *interface_name;
4174 g_variant_get (g_dbus_message_get_body (message),
4178 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
4179 * no such interface registered
4181 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4184 GDBusMessage *reply;
4185 reply = g_dbus_message_new_method_error (message,
4186 "org.freedesktop.DBus.Error.InvalidArgs",
4187 _("No such interface"),
4189 g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4190 g_object_unref (reply);
4195 handled = validate_and_maybe_schedule_property_get_all (eo->connection,
4207 /* ---------------------------------------------------------------------------------------------------- */
4209 static const gchar introspect_header[] =
4210 "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
4211 " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
4212 "<!-- GDBus " PACKAGE_VERSION " -->\n"
4215 static const gchar introspect_tail[] =
4218 static const gchar introspect_standard_interfaces[] =
4219 " <interface name=\"org.freedesktop.DBus.Properties\">\n"
4220 " <method name=\"Get\">\n"
4221 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4222 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4223 " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
4225 " <method name=\"GetAll\">\n"
4226 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4227 " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
4229 " <method name=\"Set\">\n"
4230 " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
4231 " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
4232 " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
4234 " <signal name=\"PropertiesChanged\">\n"
4235 " <arg type=\"s\" name=\"interface_name\"/>\n"
4236 " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
4237 " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
4240 " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
4241 " <method name=\"Introspect\">\n"
4242 " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
4245 " <interface name=\"org.freedesktop.DBus.Peer\">\n"
4246 " <method name=\"Ping\"/>\n"
4247 " <method name=\"GetMachineId\">\n"
4248 " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
4253 introspect_append_header (GString *s)
4255 g_string_append (s, introspect_header);
4259 introspect_append_standard_interfaces (GString *s)
4261 g_string_append (s, introspect_standard_interfaces);
4265 maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
4267 if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
4273 begin = object_path + path_len;
4274 end = strchr (begin, '/');
4276 s = g_strndup (begin, end - begin);
4278 s = g_strdup (begin);
4280 if (g_hash_table_lookup (set, s) == NULL)
4281 g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
4287 /* TODO: we want a nicer public interface for this */
4289 g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
4294 GHashTableIter hash_iter;
4295 const gchar *object_path;
4301 CONNECTION_ENSURE_LOCK (connection);
4303 path_len = strlen (path);
4307 set = g_hash_table_new (g_str_hash, g_str_equal);
4309 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
4310 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4311 maybe_add_path (path, path_len, object_path, set);
4313 g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
4314 while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
4315 maybe_add_path (path, path_len, object_path, set);
4317 p = g_ptr_array_new ();
4318 keys = g_hash_table_get_keys (set);
4319 for (l = keys; l != NULL; l = l->next)
4320 g_ptr_array_add (p, l->data);
4321 g_hash_table_unref (set);
4324 g_ptr_array_add (p, NULL);
4325 ret = (gchar **) g_ptr_array_free (p, FALSE);
4330 g_dbus_connection_list_registered (GDBusConnection *connection,
4334 CONNECTION_LOCK (connection);
4335 ret = g_dbus_connection_list_registered_unlocked (connection, path);
4336 CONNECTION_UNLOCK (connection);
4340 /* called in message handler thread with lock held */
4342 handle_introspect (GDBusConnection *connection,
4344 GDBusMessage *message)
4348 GDBusMessage *reply;
4349 GHashTableIter hash_iter;
4350 ExportedInterface *ei;
4353 /* first the header with the standard interfaces */
4354 s = g_string_sized_new (sizeof (introspect_header) +
4355 sizeof (introspect_standard_interfaces) +
4356 sizeof (introspect_tail));
4357 introspect_append_header (s);
4358 introspect_append_standard_interfaces (s);
4360 /* then include the registered interfaces */
4361 g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
4362 while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
4363 g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
4365 /* finally include nodes registered below us */
4366 registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
4367 for (n = 0; registered != NULL && registered[n] != NULL; n++)
4368 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
4369 g_strfreev (registered);
4370 g_string_append (s, introspect_tail);
4372 reply = g_dbus_message_new_method_reply (message);
4373 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
4374 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4375 g_object_unref (reply);
4376 g_string_free (s, TRUE);
4381 /* called in thread where object was registered - no locks held */
4383 call_in_idle_cb (gpointer user_data)
4385 GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
4386 GDBusInterfaceVTable *vtable;
4387 guint registration_id;
4388 guint subtree_registration_id;
4390 vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
4391 g_assert (vtable != NULL && vtable->method_call != NULL);
4393 registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
4394 subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
4396 if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
4398 subtree_registration_id))
4400 GDBusMessage *reply;
4401 reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
4402 "org.freedesktop.DBus.Error.UnknownMethod",
4403 _("No such interface `%s' on object at path %s"),
4404 g_dbus_method_invocation_get_interface_name (invocation),
4405 g_dbus_method_invocation_get_object_path (invocation));
4406 g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4407 g_object_unref (reply);
4411 vtable->method_call (g_dbus_method_invocation_get_connection (invocation),
4412 g_dbus_method_invocation_get_sender (invocation),
4413 g_dbus_method_invocation_get_object_path (invocation),
4414 g_dbus_method_invocation_get_interface_name (invocation),
4415 g_dbus_method_invocation_get_method_name (invocation),
4416 g_dbus_method_invocation_get_parameters (invocation),
4417 g_object_ref (invocation),
4418 g_dbus_method_invocation_get_user_data (invocation));
4424 /* called in message handler thread with lock held */
4426 validate_and_maybe_schedule_method_call (GDBusConnection *connection,
4427 GDBusMessage *message,
4428 guint registration_id,
4429 guint subtree_registration_id,
4430 GDBusInterfaceInfo *interface_info,
4431 const GDBusInterfaceVTable *vtable,
4432 GMainContext *main_context,
4435 GDBusMethodInvocation *invocation;
4436 const GDBusMethodInfo *method_info;
4437 GDBusMessage *reply;
4438 GVariant *parameters;
4439 GSource *idle_source;
4441 GVariantType *in_type;
4445 /* TODO: the cost of this is O(n) - it might be worth caching the result */
4446 method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
4448 /* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
4449 * error to the caller
4451 if (method_info == NULL)
4453 reply = g_dbus_message_new_method_error (message,
4454 "org.freedesktop.DBus.Error.UnknownMethod",
4455 _("No such method `%s'"),
4456 g_dbus_message_get_member (message));
4457 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4458 g_object_unref (reply);
4463 parameters = g_dbus_message_get_body (message);
4464 if (parameters == NULL)
4466 parameters = g_variant_new ("()");
4467 g_variant_ref_sink (parameters);
4471 g_variant_ref (parameters);
4474 /* Check that the incoming args are of the right type - if they are not, return
4475 * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
4477 in_type = _g_dbus_compute_complete_signature (method_info->in_args);
4478 if (!g_variant_is_of_type (parameters, in_type))
4482 type_string = g_variant_type_dup_string (in_type);
4484 reply = g_dbus_message_new_method_error (message,
4485 "org.freedesktop.DBus.Error.InvalidArgs",
4486 _("Type of message, `%s', does not match expected type `%s'"),
4487 g_variant_get_type_string (parameters),
4489 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
4490 g_variant_type_free (in_type);
4491 g_variant_unref (parameters);
4492 g_object_unref (reply);
4493 g_free (type_string);
4497 g_variant_type_free (in_type);
4499 /* schedule the call in idle */
4500 invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
4501 g_dbus_message_get_path (message),
4502 g_dbus_message_get_interface (message),
4503 g_dbus_message_get_member (message),
4509 g_variant_unref (parameters);
4511 /* TODO: would be nicer with a real MethodData like we already
4512 * have PropertyData and PropertyGetAllData... */
4513 g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
4514 g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
4515 g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
4517 idle_source = g_idle_source_new ();
4518 g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
4519 g_source_set_callback (idle_source,
4523 g_source_attach (idle_source, main_context);
4524 g_source_unref (idle_source);
4532 /* ---------------------------------------------------------------------------------------------------- */
4534 /* called in message handler thread with lock held */
4536 obj_message_func (GDBusConnection *connection,
4538 GDBusMessage *message)
4540 const gchar *interface_name;
4541 const gchar *member;
4542 const gchar *signature;
4547 interface_name = g_dbus_message_get_interface (message);
4548 member = g_dbus_message_get_member (message);
4549 signature = g_dbus_message_get_signature (message);
4551 /* see if we have an interface for handling this call */
4552 if (interface_name != NULL)
4554 ExportedInterface *ei;
4555 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
4558 /* we do - invoke the handler in idle in the right thread */
4560 /* handle no vtable or handler being present */
4561 if (ei->vtable == NULL || ei->vtable->method_call == NULL)
4564 handled = validate_and_maybe_schedule_method_call (connection,
4576 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
4577 g_strcmp0 (member, "Introspect") == 0 &&
4578 g_strcmp0 (signature, "") == 0)
4580 handled = handle_introspect (connection, eo, message);
4583 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4584 g_strcmp0 (member, "Get") == 0 &&
4585 g_strcmp0 (signature, "ss") == 0)
4587 handled = handle_getset_property (connection, eo, message, TRUE);
4590 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4591 g_strcmp0 (member, "Set") == 0 &&
4592 g_strcmp0 (signature, "ssv") == 0)
4594 handled = handle_getset_property (connection, eo, message, FALSE);
4597 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0 &&
4598 g_strcmp0 (member, "GetAll") == 0 &&
4599 g_strcmp0 (signature, "s") == 0)
4601 handled = handle_get_all_properties (connection, eo, message);
4610 * g_dbus_connection_register_object:
4611 * @connection: A #GDBusConnection.
4612 * @object_path: The object path to register at.
4613 * @interface_info: Introspection data for the interface.
4614 * @vtable: A #GDBusInterfaceVTable to call into or %NULL.
4615 * @user_data: Data to pass to functions in @vtable.
4616 * @user_data_free_func: Function to call when the object path is unregistered.
4617 * @error: Return location for error or %NULL.
4619 * Registers callbacks for exported objects at @object_path with the
4620 * D-Bus interface that is described in @interface_info.
4622 * Calls to functions in @vtable (and @user_data_free_func) will
4623 * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
4624 * loop</link> of the thread you are calling this method from.
4626 * Note that all #GVariant values passed to functions in @vtable will match
4627 * the signature given in @interface_info - if a remote caller passes
4628 * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
4629 * is returned to the remote caller.
4631 * Additionally, if the remote caller attempts to invoke methods or
4632 * access properties not mentioned in @interface_info the
4633 * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
4634 * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
4635 * are returned to the caller.
4637 * It is considered a programming error if the
4638 * #GDBusInterfaceGetPropertyFunc function in @vtable returns a
4639 * #GVariant of incorrect type.
4641 * If an existing callback is already registered at @object_path and
4642 * @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
4644 * GDBus automatically implements the standard D-Bus interfaces
4645 * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
4646 * and org.freedesktop.Peer, so you don't have to implement those for
4647 * the objects you export. You <emphasis>can</emphasis> implement
4648 * org.freedesktop.DBus.Properties yourself, e.g. to handle getting
4649 * and setting of properties asynchronously.
4651 * Note that the reference count on @interface_info will be
4652 * incremented by 1 (unless allocated statically, e.g. if the
4653 * reference count is -1, see g_dbus_interface_info_ref()) for as long
4654 * as the object is exported. Also note that @vtable will be copied.
4656 * See <xref linkend="gdbus-server"/> for an example of how to use this method.
4658 * Returns: 0 if @error is set, otherwise a registration id (never 0)
4659 * that can be used with g_dbus_connection_unregister_object() .
4664 g_dbus_connection_register_object (GDBusConnection *connection,
4665 const gchar *object_path,
4666 GDBusInterfaceInfo *interface_info,
4667 const GDBusInterfaceVTable *vtable,
4669 GDestroyNotify user_data_free_func,
4673 ExportedInterface *ei;
4676 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
4677 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
4678 g_return_val_if_fail (interface_info != NULL, 0);
4679 g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
4680 g_return_val_if_fail (error == NULL || *error == NULL, 0);
4684 CONNECTION_LOCK (connection);
4686 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
4689 eo = g_new0 (ExportedObject, 1);
4690 eo->object_path = g_strdup (object_path);
4691 eo->connection = connection;
4692 eo->map_if_name_to_ei = g_hash_table_new_full (g_str_hash,
4695 (GDestroyNotify) exported_interface_free);
4696 g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
4699 ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
4705 _("An object is already exported for the interface %s at %s"),
4706 interface_info->name,
4711 ei = g_new0 (ExportedInterface, 1);
4712 ei->id = _global_registration_id++; /* TODO: overflow etc. */
4714 ei->user_data = user_data;
4715 ei->user_data_free_func = user_data_free_func;
4716 ei->vtable = _g_dbus_interface_vtable_copy (vtable);
4717 ei->interface_info = g_dbus_interface_info_ref (interface_info);
4718 ei->interface_name = g_strdup (interface_info->name);
4719 ei->context = g_main_context_get_thread_default ();
4720 if (ei->context != NULL)
4721 g_main_context_ref (ei->context);
4723 g_hash_table_insert (eo->map_if_name_to_ei,
4724 (gpointer) ei->interface_name,
4726 g_hash_table_insert (connection->map_id_to_ei,
4727 GUINT_TO_POINTER (ei->id),
4733 CONNECTION_UNLOCK (connection);
4739 * g_dbus_connection_unregister_object:
4740 * @connection: A #GDBusConnection.
4741 * @registration_id: A registration id obtained from g_dbus_connection_register_object().
4743 * Unregisters an object.
4745 * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
4750 g_dbus_connection_unregister_object (GDBusConnection *connection,
4751 guint registration_id)
4753 ExportedInterface *ei;
4757 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4761 CONNECTION_LOCK (connection);
4763 ei = g_hash_table_lookup (connection->map_id_to_ei,
4764 GUINT_TO_POINTER (registration_id));
4770 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
4771 g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
4772 /* unregister object path if we have no more exported interfaces */
4773 if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
4774 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
4780 CONNECTION_UNLOCK (connection);
4785 /* ---------------------------------------------------------------------------------------------------- */
4788 * g_dbus_connection_emit_signal:
4789 * @connection: A #GDBusConnection.
4790 * @destination_bus_name: The unique bus name for the destination for the signal or %NULL to emit to all listeners.
4791 * @object_path: Path of remote object.
4792 * @interface_name: D-Bus interface to emit a signal on.
4793 * @signal_name: The name of the signal to emit.
4794 * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
4795 * @error: Return location for error or %NULL.
4799 * If the parameters GVariant is floating, it is consumed.
4801 * This can only fail if @parameters is not compatible with the D-Bus protocol.
4803 * Returns: %TRUE unless @error is set.
4808 g_dbus_connection_emit_signal (GDBusConnection *connection,
4809 const gchar *destination_bus_name,
4810 const gchar *object_path,
4811 const gchar *interface_name,
4812 const gchar *signal_name,
4813 GVariant *parameters,
4816 GDBusMessage *message;
4822 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
4823 g_return_val_if_fail (destination_bus_name == NULL || g_dbus_is_name (destination_bus_name), FALSE);
4824 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), FALSE);
4825 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
4826 g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
4827 g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
4829 if (G_UNLIKELY (_g_dbus_debug_emission ()))
4831 _g_dbus_debug_print_lock ();
4832 g_print ("========================================================================\n"
4833 "GDBus-debug:Emission:\n"
4834 " >>>> SIGNAL EMISSION %s.%s()\n"
4836 " destination %s\n",
4837 interface_name, signal_name,
4839 destination_bus_name != NULL ? destination_bus_name : "(none)");
4840 _g_dbus_debug_print_unlock ();
4843 message = g_dbus_message_new_signal (object_path,
4847 if (destination_bus_name != NULL)
4848 g_dbus_message_set_header (message,
4849 G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
4850 g_variant_new_string (destination_bus_name));
4852 if (parameters != NULL)
4853 g_dbus_message_set_body (message, parameters);
4855 ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
4856 g_object_unref (message);
4862 add_call_flags (GDBusMessage *message,
4863 GDBusCallFlags flags)
4865 if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
4866 g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
4870 decode_method_reply (GDBusMessage *reply,
4871 const gchar *method_name,
4872 const GVariantType *reply_type,
4878 switch (g_dbus_message_get_message_type (reply))
4880 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
4881 result = g_dbus_message_get_body (reply);
4884 result = g_variant_new ("()");
4885 g_variant_ref_sink (result);
4889 g_variant_ref (result);
4892 if (!g_variant_is_of_type (result, reply_type))
4894 gchar *type_string = g_variant_type_dup_string (reply_type);
4898 G_IO_ERROR_INVALID_ARGUMENT,
4899 _("Method `%s' returned type `%s', but expected `%s'"),
4900 method_name, g_variant_get_type_string (result), type_string);
4902 g_variant_unref (result);
4903 g_free (type_string);
4908 case G_DBUS_MESSAGE_TYPE_ERROR:
4909 g_dbus_message_to_gerror (reply, error);
4913 g_assert_not_reached ();
4923 GSimpleAsyncResult *simple;
4924 GVariantType *reply_type;
4925 gchar *method_name; /* for error message */
4930 g_dbus_connection_call_done (GObject *source,
4931 GAsyncResult *result,
4934 GDBusConnection *connection = G_DBUS_CONNECTION (source);
4935 CallState *state = user_data;
4937 GDBusMessage *reply;
4941 reply = g_dbus_connection_send_message_with_reply_finish (connection,
4945 if (G_UNLIKELY (_g_dbus_debug_call ()))
4947 _g_dbus_debug_print_lock ();
4948 g_print ("========================================================================\n"
4949 "GDBus-debug:Call:\n"
4950 " <<<< ASYNC COMPLETE %s() (serial %d)\n"
4956 g_print ("SUCCESS\n");
4960 g_print ("FAILED: %s\n",
4963 _g_dbus_debug_print_unlock ();
4969 value = decode_method_reply (reply, state->method_name,
4970 state->reply_type, &error);
4971 g_object_unref (reply);
4978 g_simple_async_result_set_from_error (state->simple, error);
4979 g_error_free (error);
4982 g_simple_async_result_set_op_res_gpointer (state->simple, value,
4983 (GDestroyNotify) g_variant_unref);
4985 g_simple_async_result_complete (state->simple);
4986 g_variant_type_free (state->reply_type);
4987 g_object_unref (state->simple);
4988 g_free (state->method_name);
4990 g_slice_free (CallState, state);
4994 * g_dbus_connection_call:
4995 * @connection: A #GDBusConnection.
4996 * @bus_name: A unique or well-known bus name or %NULL if @connection is not a message bus connection.
4997 * @object_path: Path of remote object.
4998 * @interface_name: D-Bus interface to invoke method on.
4999 * @method_name: The name of the method to invoke.
5000 * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
5001 * @reply_type: The expected type of the reply, or %NULL.
5002 * @flags: Flags from the #GDBusCallFlags enumeration.
5003 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5004 * timeout or %G_MAXINT for no timeout.
5005 * @cancellable: A #GCancellable or %NULL.
5006 * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
5007 * care about the result of the method invocation.
5008 * @user_data: The data to pass to @callback.
5010 * Asynchronously invokes the @method_name method on the
5011 * @interface_name D-Bus interface on the remote object at
5012 * @object_path owned by @bus_name.
5014 * If @connection is closed then the operation will fail with
5015 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
5016 * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
5017 * not compatible with the D-Bus protocol, the operation fails with
5018 * %G_IO_ERROR_INVALID_ARGUMENT.
5020 * If @reply_type is non-%NULL then the reply will be checked for having this type and an
5021 * error will be raised if it does not match. Said another way, if you give a @reply_type
5022 * then any non-%NULL return value will be of this type.
5024 * If the @parameters #GVariant is floating, it is consumed. This allows
5025 * convenient 'inline' use of g_variant_new(), e.g.:
5027 * g_dbus_connection_call (connection,
5028 * "org.freedesktop.StringThings",
5029 * "/org/freedesktop/StringThings",
5030 * "org.freedesktop.StringThings",
5032 * g_variant_new ("(ss)",
5036 * G_DBUS_CALL_FLAGS_NONE,
5039 * (GAsyncReadyCallback) two_strings_done,
5043 * This is an asynchronous method. When the operation is finished, @callback will be invoked
5044 * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
5045 * of the thread you are calling this method from. You can then call
5046 * g_dbus_connection_call_finish() to get the result of the operation.
5047 * See g_dbus_connection_call_sync() for the synchronous version of this
5053 g_dbus_connection_call (GDBusConnection *connection,
5054 const gchar *bus_name,
5055 const gchar *object_path,
5056 const gchar *interface_name,
5057 const gchar *method_name,
5058 GVariant *parameters,
5059 const GVariantType *reply_type,
5060 GDBusCallFlags flags,
5062 GCancellable *cancellable,
5063 GAsyncReadyCallback callback,
5066 GDBusMessage *message;
5069 g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
5070 g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
5071 g_return_if_fail (object_path != NULL && g_variant_is_object_path (object_path));
5072 g_return_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name));
5073 g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
5074 g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
5075 g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
5077 state = g_slice_new (CallState);
5078 state->simple = g_simple_async_result_new (G_OBJECT (connection),
5079 callback, user_data,
5080 g_dbus_connection_call);
5081 state->method_name = g_strjoin (".", interface_name, method_name, NULL);
5083 if (reply_type == NULL)
5084 reply_type = G_VARIANT_TYPE_ANY;
5086 state->reply_type = g_variant_type_copy (reply_type);
5088 message = g_dbus_message_new_method_call (bus_name,
5092 add_call_flags (message, flags);
5093 if (parameters != NULL)
5094 g_dbus_message_set_body (message, parameters);
5096 g_dbus_connection_send_message_with_reply (connection,
5098 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5102 g_dbus_connection_call_done,
5105 if (G_UNLIKELY (_g_dbus_debug_call ()))
5107 _g_dbus_debug_print_lock ();
5108 g_print ("========================================================================\n"
5109 "GDBus-debug:Call:\n"
5110 " >>>> ASYNC %s.%s()\n"
5112 " owned by name %s (serial %d)\n",
5116 bus_name != NULL ? bus_name : "(none)",
5118 _g_dbus_debug_print_unlock ();
5121 if (message != NULL)
5122 g_object_unref (message);
5126 * g_dbus_connection_call_finish:
5127 * @connection: A #GDBusConnection.
5128 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call().
5129 * @error: Return location for error or %NULL.
5131 * Finishes an operation started with g_dbus_connection_call().
5133 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5134 * return values. Free with g_variant_unref().
5139 g_dbus_connection_call_finish (GDBusConnection *connection,
5143 GSimpleAsyncResult *simple;
5145 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5146 g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
5147 g_dbus_connection_call), NULL);
5148 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
5150 simple = G_SIMPLE_ASYNC_RESULT (res);
5152 if (g_simple_async_result_propagate_error (simple, error))
5155 return g_variant_ref (g_simple_async_result_get_op_res_gpointer (simple));
5158 /* ---------------------------------------------------------------------------------------------------- */
5161 * g_dbus_connection_call_sync:
5162 * @connection: A #GDBusConnection.
5163 * @bus_name: A unique or well-known bus name.
5164 * @object_path: Path of remote object.
5165 * @interface_name: D-Bus interface to invoke method on.
5166 * @method_name: The name of the method to invoke.
5167 * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
5168 * @reply_type: The expected type of the reply, or %NULL.
5169 * @flags: Flags from the #GDBusCallFlags enumeration.
5170 * @timeout_msec: The timeout in milliseconds, -1 to use the default
5171 * timeout or %G_MAXINT for no timeout.
5172 * @cancellable: A #GCancellable or %NULL.
5173 * @error: Return location for error or %NULL.
5175 * Synchronously invokes the @method_name method on the
5176 * @interface_name D-Bus interface on the remote object at
5177 * @object_path owned by @bus_name.
5179 * If @connection is closed then the operation will fail with
5180 * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the
5181 * operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
5182 * contains a value not compatible with the D-Bus protocol, the operation
5183 * fails with %G_IO_ERROR_INVALID_ARGUMENT.
5185 * If @reply_type is non-%NULL then the reply will be checked for having
5186 * this type and an error will be raised if it does not match. Said
5187 * another way, if you give a @reply_type then any non-%NULL return
5188 * value will be of this type.
5190 * If the @parameters #GVariant is floating, it is consumed.
5191 * This allows convenient 'inline' use of g_variant_new(), e.g.:
5193 * g_dbus_connection_call_sync (connection,
5194 * "org.freedesktop.StringThings",
5195 * "/org/freedesktop/StringThings",
5196 * "org.freedesktop.StringThings",
5198 * g_variant_new ("(ss)",
5202 * G_DBUS_CALL_FLAGS_NONE,
5208 * The calling thread is blocked until a reply is received. See
5209 * g_dbus_connection_call() for the asynchronous version of
5212 * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
5213 * return values. Free with g_variant_unref().
5218 g_dbus_connection_call_sync (GDBusConnection *connection,
5219 const gchar *bus_name,
5220 const gchar *object_path,
5221 const gchar *interface_name,
5222 const gchar *method_name,
5223 GVariant *parameters,
5224 const GVariantType *reply_type,
5225 GDBusCallFlags flags,
5227 GCancellable *cancellable,
5230 GDBusMessage *message;
5231 GDBusMessage *reply;
5233 GError *local_error;
5239 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
5240 g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
5241 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
5242 g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
5243 g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
5244 g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
5245 g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
5247 if (reply_type == NULL)
5248 reply_type = G_VARIANT_TYPE_ANY;
5250 message = g_dbus_message_new_method_call (bus_name,
5254 add_call_flags (message, flags);
5255 if (parameters != NULL)
5256 g_dbus_message_set_body (message, parameters);
5258 if (G_UNLIKELY (_g_dbus_debug_call ()))
5260 _g_dbus_debug_print_lock ();
5261 g_print ("========================================================================\n"
5262 "GDBus-debug:Call:\n"
5263 " >>>> SYNC %s.%s()\n"
5265 " owned by name %s\n",
5269 bus_name != NULL ? bus_name : "(none)");
5270 _g_dbus_debug_print_unlock ();
5274 reply = g_dbus_connection_send_message_with_reply_sync (connection,
5276 G_DBUS_SEND_MESSAGE_FLAGS_NONE,
5278 NULL, /* volatile guint32 *out_serial */
5282 if (G_UNLIKELY (_g_dbus_debug_call ()))
5284 _g_dbus_debug_print_lock ();
5285 g_print ("========================================================================\n"
5286 "GDBus-debug:Call:\n"
5287 " <<<< SYNC COMPLETE %s.%s()\n"
5293 g_print ("SUCCESS\n");
5297 g_print ("FAILED: %s\n",
5298 local_error->message);
5300 _g_dbus_debug_print_unlock ();
5306 *error = local_error;
5308 g_error_free (local_error);
5312 result = decode_method_reply (reply, method_name, reply_type, error);
5315 if (message != NULL)
5316 g_object_unref (message);
5318 g_object_unref (reply);
5323 /* ---------------------------------------------------------------------------------------------------- */
5325 struct ExportedSubtree
5329 GDBusConnection *connection;
5330 GDBusSubtreeVTable *vtable;
5331 GDBusSubtreeFlags flags;
5333 GMainContext *context;
5335 GDestroyNotify user_data_free_func;
5339 exported_subtree_free (ExportedSubtree *es)
5341 call_destroy_notify (es->context,
5342 es->user_data_free_func,
5345 if (es->context != NULL)
5346 g_main_context_unref (es->context);
5348 _g_dbus_subtree_vtable_free (es->vtable);
5349 g_free (es->object_path);
5353 /* called without lock held */
5355 handle_subtree_introspect (GDBusConnection *connection,
5356 ExportedSubtree *es,
5357 GDBusMessage *message)
5361 GDBusMessage *reply;
5364 const gchar *sender;
5365 const gchar *requested_object_path;
5366 const gchar *requested_node;
5367 GDBusInterfaceInfo **interfaces;
5369 gchar **subnode_paths;
5373 requested_object_path = g_dbus_message_get_path (message);
5374 sender = g_dbus_message_get_sender (message);
5375 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
5377 s = g_string_new (NULL);
5378 introspect_append_header (s);
5380 /* Strictly we don't need the children in dynamic mode, but we avoid the
5381 * conditionals to preserve code clarity
5383 children = es->vtable->enumerate (es->connection,
5390 requested_node = strrchr (requested_object_path, '/') + 1;
5392 /* Assert existence of object if we are not dynamic */
5393 if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
5394 !_g_strv_has_string ((const gchar * const *) children, requested_node))
5399 requested_node = NULL;
5402 interfaces = es->vtable->introspect (es->connection,
5407 if (interfaces != NULL)
5409 introspect_append_standard_interfaces (s);
5411 for (n = 0; interfaces[n] != NULL; n++)
5413 g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
5414 g_dbus_interface_info_unref (interfaces[n]);
5416 g_free (interfaces);
5419 /* then include <node> entries from the Subtree for the root */
5422 for (n = 0; children != NULL && children[n] != NULL; n++)
5423 g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
5426 /* finally include nodes registered below us */
5427 subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
5428 for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
5429 g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
5430 g_strfreev (subnode_paths);
5432 g_string_append (s, "</node>\n");
5434 reply = g_dbus_message_new_method_reply (message);
5435 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5436 g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5437 g_object_unref (reply);
5442 g_string_free (s, TRUE);
5443 g_strfreev (children);
5447 /* called without lock held */
5449 handle_subtree_method_invocation (GDBusConnection *connection,
5450 ExportedSubtree *es,
5451 GDBusMessage *message)
5454 const gchar *sender;
5455 const gchar *interface_name;
5456 const gchar *member;
5457 const gchar *signature;
5458 const gchar *requested_object_path;
5459 const gchar *requested_node;
5461 GDBusInterfaceInfo *interface_info;
5462 const GDBusInterfaceVTable *interface_vtable;
5463 gpointer interface_user_data;
5465 GDBusInterfaceInfo **interfaces;
5466 gboolean is_property_get;
5467 gboolean is_property_set;
5468 gboolean is_property_get_all;
5473 requested_object_path = g_dbus_message_get_path (message);
5474 sender = g_dbus_message_get_sender (message);
5475 interface_name = g_dbus_message_get_interface (message);
5476 member = g_dbus_message_get_member (message);
5477 signature = g_dbus_message_get_signature (message);
5478 is_root = (g_strcmp0 (requested_object_path, es->object_path) == 0);
5480 is_property_get = FALSE;
5481 is_property_set = FALSE;
5482 is_property_get_all = FALSE;
5483 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
5485 if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
5486 is_property_get = TRUE;
5487 else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
5488 is_property_set = TRUE;
5489 else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
5490 is_property_get_all = TRUE;
5495 requested_node = strrchr (requested_object_path, '/') + 1;
5497 if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
5499 /* We don't want to dispatch to unenumerated
5500 * nodes, so ensure that the child exists.
5505 children = es->vtable->enumerate (es->connection,
5510 exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
5511 g_strfreev (children);
5519 requested_node = NULL;
5522 /* get introspection data for the node */
5523 interfaces = es->vtable->introspect (es->connection,
5525 requested_object_path,
5529 if (interfaces == NULL)
5532 interface_info = NULL;
5533 for (n = 0; interfaces[n] != NULL; n++)
5535 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
5536 interface_info = interfaces[n];
5539 /* dispatch the call if the user wants to handle it */
5540 if (interface_info != NULL)
5542 /* figure out where to dispatch the method call */
5543 interface_user_data = NULL;
5544 interface_vtable = es->vtable->dispatch (es->connection,
5549 &interface_user_data,
5551 if (interface_vtable == NULL)
5554 CONNECTION_LOCK (connection);
5555 handled = validate_and_maybe_schedule_method_call (es->connection,
5562 interface_user_data);
5563 CONNECTION_UNLOCK (connection);
5565 /* handle org.freedesktop.DBus.Properties interface if not explicitly handled */
5566 else if (is_property_get || is_property_set || is_property_get_all)
5568 if (is_property_get)
5569 g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
5570 else if (is_property_set)
5571 g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
5572 else if (is_property_get_all)
5573 g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
5575 g_assert_not_reached ();
5577 /* see if the object supports this interface at all */
5578 for (n = 0; interfaces[n] != NULL; n++)
5580 if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
5581 interface_info = interfaces[n];
5584 /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
5585 * claims it won't support the interface
5587 if (interface_info == NULL)
5589 GDBusMessage *reply;
5590 reply = g_dbus_message_new_method_error (message,
5591 "org.freedesktop.DBus.Error.InvalidArgs",
5592 _("No such interface `%s'"),
5594 g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5595 g_object_unref (reply);
5600 /* figure out where to dispatch the property get/set/getall calls */
5601 interface_user_data = NULL;
5602 interface_vtable = es->vtable->dispatch (es->connection,
5607 &interface_user_data,
5609 if (interface_vtable == NULL)
5611 g_warning ("The subtree introspection function indicates that '%s' "
5612 "is a valid interface name, but calling the dispatch "
5613 "function on that interface gave us NULL", interface_name);
5617 if (is_property_get || is_property_set)
5619 CONNECTION_LOCK (connection);
5620 handled = validate_and_maybe_schedule_property_getset (es->connection,
5628 interface_user_data);
5629 CONNECTION_UNLOCK (connection);
5631 else if (is_property_get_all)
5633 CONNECTION_LOCK (connection);
5634 handled = validate_and_maybe_schedule_property_get_all (es->connection,
5641 interface_user_data);
5642 CONNECTION_UNLOCK (connection);
5647 if (interfaces != NULL)
5649 for (n = 0; interfaces[n] != NULL; n++)
5650 g_dbus_interface_info_unref (interfaces[n]);
5651 g_free (interfaces);
5659 GDBusMessage *message;
5660 ExportedSubtree *es;
5661 } SubtreeDeferredData;
5664 subtree_deferred_data_free (SubtreeDeferredData *data)
5666 g_object_unref (data->message);
5670 /* called without lock held in the thread where the caller registered the subtree */
5672 process_subtree_vtable_message_in_idle_cb (gpointer _data)
5674 SubtreeDeferredData *data = _data;
5679 if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
5680 g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
5681 g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
5682 handled = handle_subtree_introspect (data->es->connection,
5686 handled = handle_subtree_method_invocation (data->es->connection,
5692 CONNECTION_LOCK (data->es->connection);
5693 handled = handle_generic_unlocked (data->es->connection, data->message);
5694 CONNECTION_UNLOCK (data->es->connection);
5697 /* if we couldn't handle the request, just bail with the UnknownMethod error */
5700 GDBusMessage *reply;
5701 reply = g_dbus_message_new_method_error (data->message,
5702 "org.freedesktop.DBus.Error.UnknownMethod",
5703 _("Method `%s' on interface `%s' with signature `%s' does not exist"),
5704 g_dbus_message_get_member (data->message),
5705 g_dbus_message_get_interface (data->message),
5706 g_dbus_message_get_signature (data->message));
5707 g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5708 g_object_unref (reply);
5714 /* called in message handler thread with lock held */
5716 subtree_message_func (GDBusConnection *connection,
5717 ExportedSubtree *es,
5718 GDBusMessage *message)
5720 GSource *idle_source;
5721 SubtreeDeferredData *data;
5723 data = g_new0 (SubtreeDeferredData, 1);
5724 data->message = g_object_ref (message);
5727 /* defer this call to an idle handler in the right thread */
5728 idle_source = g_idle_source_new ();
5729 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
5730 g_source_set_callback (idle_source,
5731 process_subtree_vtable_message_in_idle_cb,
5733 (GDestroyNotify) subtree_deferred_data_free);
5734 g_source_attach (idle_source, es->context);
5735 g_source_unref (idle_source);
5737 /* since we own the entire subtree, handlers for objects not in the subtree have been
5738 * tried already by libdbus-1 - so we just need to ensure that we're always going
5739 * to reply to the message
5745 * g_dbus_connection_register_subtree:
5746 * @connection: A #GDBusConnection.
5747 * @object_path: The object path to register the subtree at.
5748 * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
5749 * @flags: Flags used to fine tune the behavior of the subtree.
5750 * @user_data: Data to pass to functions in @vtable.
5751 * @user_data_free_func: Function to call when the subtree is unregistered.
5752 * @error: Return location for error or %NULL.
5754 * Registers a whole subtree of <quote>dynamic</quote> objects.
5756 * The @enumerate and @introspection functions in @vtable are used to
5757 * convey, to remote callers, what nodes exist in the subtree rooted
5760 * When handling remote calls into any node in the subtree, first the
5761 * @enumerate function is used to check if the node exists. If the node exists
5762 * or the #G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES flag is set
5763 * the @introspection function is used to check if the node supports the
5764 * requested method. If so, the @dispatch function is used to determine
5765 * where to dispatch the call. The collected #GDBusInterfaceVTable and
5766 * #gpointer will be used to call into the interface vtable for processing
5769 * All calls into user-provided code will be invoked in the <link
5770 * linkend="g-main-context-push-thread-default">thread-default main
5771 * loop</link> of the thread you are calling this method from.
5773 * If an existing subtree is already registered at @object_path or
5774 * then @error is set to #G_IO_ERROR_EXISTS.
5776 * Note that it is valid to register regular objects (using
5777 * g_dbus_connection_register_object()) in a subtree registered with
5778 * g_dbus_connection_register_subtree() - if so, the subtree handler
5779 * is tried as the last resort. One way to think about a subtree
5780 * handler is to consider it a <quote>fallback handler</quote>
5781 * for object paths not registered via g_dbus_connection_register_object()
5782 * or other bindings.
5784 * Note that @vtable will be copied so you cannot change it after
5787 * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
5789 * Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
5790 * that can be used with g_dbus_connection_unregister_subtree() .
5795 g_dbus_connection_register_subtree (GDBusConnection *connection,
5796 const gchar *object_path,
5797 const GDBusSubtreeVTable *vtable,
5798 GDBusSubtreeFlags flags,
5800 GDestroyNotify user_data_free_func,
5804 ExportedSubtree *es;
5806 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
5807 g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
5808 g_return_val_if_fail (vtable != NULL, 0);
5809 g_return_val_if_fail (error == NULL || *error == NULL, 0);
5813 CONNECTION_LOCK (connection);
5815 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
5821 _("A subtree is already exported for %s"),
5826 es = g_new0 (ExportedSubtree, 1);
5827 es->object_path = g_strdup (object_path);
5828 es->connection = connection;
5830 es->vtable = _g_dbus_subtree_vtable_copy (vtable);
5832 es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
5833 es->user_data = user_data;
5834 es->user_data_free_func = user_data_free_func;
5835 es->context = g_main_context_get_thread_default ();
5836 if (es->context != NULL)
5837 g_main_context_ref (es->context);
5839 g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
5840 g_hash_table_insert (connection->map_id_to_es,
5841 GUINT_TO_POINTER (es->id),
5847 CONNECTION_UNLOCK (connection);
5852 /* ---------------------------------------------------------------------------------------------------- */
5855 * g_dbus_connection_unregister_subtree:
5856 * @connection: A #GDBusConnection.
5857 * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
5859 * Unregisters a subtree.
5861 * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
5866 g_dbus_connection_unregister_subtree (GDBusConnection *connection,
5867 guint registration_id)
5869 ExportedSubtree *es;
5872 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
5876 CONNECTION_LOCK (connection);
5878 es = g_hash_table_lookup (connection->map_id_to_es,
5879 GUINT_TO_POINTER (registration_id));
5883 g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
5884 g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
5889 CONNECTION_UNLOCK (connection);
5894 /* ---------------------------------------------------------------------------------------------------- */
5896 /* must be called with lock held */
5898 handle_generic_ping_unlocked (GDBusConnection *connection,
5899 const gchar *object_path,
5900 GDBusMessage *message)
5902 GDBusMessage *reply;
5903 reply = g_dbus_message_new_method_reply (message);
5904 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5905 g_object_unref (reply);
5908 /* must be called with lock held */
5910 handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
5911 const gchar *object_path,
5912 GDBusMessage *message)
5914 GDBusMessage *reply;
5917 if (connection->machine_id == NULL)
5922 connection->machine_id = _g_dbus_get_machine_id (&error);
5923 if (connection->machine_id == NULL)
5925 reply = g_dbus_message_new_method_error_literal (message,
5926 "org.freedesktop.DBus.Error.Failed",
5928 g_error_free (error);
5934 reply = g_dbus_message_new_method_reply (message);
5935 g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
5937 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5938 g_object_unref (reply);
5941 /* must be called with lock held */
5943 handle_generic_introspect_unlocked (GDBusConnection *connection,
5944 const gchar *object_path,
5945 GDBusMessage *message)
5950 GDBusMessage *reply;
5952 /* first the header */
5953 s = g_string_new (NULL);
5954 introspect_append_header (s);
5956 registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
5957 for (n = 0; registered != NULL && registered[n] != NULL; n++)
5958 g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
5959 g_strfreev (registered);
5960 g_string_append (s, "</node>\n");
5962 reply = g_dbus_message_new_method_reply (message);
5963 g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
5964 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
5965 g_object_unref (reply);
5966 g_string_free (s, TRUE);
5969 /* must be called with lock held */
5971 handle_generic_unlocked (GDBusConnection *connection,
5972 GDBusMessage *message)
5975 const gchar *interface_name;
5976 const gchar *member;
5977 const gchar *signature;
5980 CONNECTION_ENSURE_LOCK (connection);
5984 interface_name = g_dbus_message_get_interface (message);
5985 member = g_dbus_message_get_member (message);
5986 signature = g_dbus_message_get_signature (message);
5987 path = g_dbus_message_get_path (message);
5989 if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Introspectable") == 0 &&
5990 g_strcmp0 (member, "Introspect") == 0 &&
5991 g_strcmp0 (signature, "") == 0)
5993 handle_generic_introspect_unlocked (connection, path, message);
5996 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
5997 g_strcmp0 (member, "Ping") == 0 &&
5998 g_strcmp0 (signature, "") == 0)
6000 handle_generic_ping_unlocked (connection, path, message);
6003 else if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Peer") == 0 &&
6004 g_strcmp0 (member, "GetMachineId") == 0 &&
6005 g_strcmp0 (signature, "") == 0)
6007 handle_generic_get_machine_id_unlocked (connection, path, message);
6014 /* ---------------------------------------------------------------------------------------------------- */
6016 /* called in message handler thread with lock held */
6018 distribute_method_call (GDBusConnection *connection,
6019 GDBusMessage *message)
6021 GDBusMessage *reply;
6023 ExportedSubtree *es;
6024 const gchar *object_path;
6025 const gchar *interface_name;
6026 const gchar *member;
6027 const gchar *signature;
6029 gchar *subtree_path;
6032 g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
6034 interface_name = g_dbus_message_get_interface (message);
6035 member = g_dbus_message_get_member (message);
6036 signature = g_dbus_message_get_signature (message);
6037 path = g_dbus_message_get_path (message);
6038 subtree_path = g_strdup (path);
6039 needle = strrchr (subtree_path, '/');
6040 if (needle != NULL && needle != subtree_path)
6046 g_free (subtree_path);
6047 subtree_path = NULL;
6051 if (G_UNLIKELY (_g_dbus_debug_incoming ()))
6053 _g_dbus_debug_print_lock ();
6054 g_print ("========================================================================\n"
6055 "GDBus-debug:Incoming:\n"
6056 " <<<< METHOD INVOCATION %s.%s()\n"
6058 " invoked by name %s\n"
6060 interface_name, member,
6062 g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
6063 g_dbus_message_get_serial (message));
6064 _g_dbus_debug_print_unlock ();
6068 g_debug ("interface = `%s'", interface_name);
6069 g_debug ("member = `%s'", member);
6070 g_debug ("signature = `%s'", signature);
6071 g_debug ("path = `%s'", path);
6072 g_debug ("subtree_path = `%s'", subtree_path != NULL ? subtree_path : "N/A");
6075 object_path = g_dbus_message_get_path (message);
6076 g_assert (object_path != NULL);
6078 eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
6081 if (obj_message_func (connection, eo, message))
6085 es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
6088 if (subtree_message_func (connection, es, message))
6092 if (subtree_path != NULL)
6094 es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
6097 if (subtree_message_func (connection, es, message))
6102 if (handle_generic_unlocked (connection, message))
6105 /* if we end up here, the message has not been not handled - so return an error saying this */
6106 reply = g_dbus_message_new_method_error (message,
6107 "org.freedesktop.DBus.Error.UnknownMethod",
6108 _("No such interface `%s' on object at path %s"),
6111 g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
6112 g_object_unref (reply);
6115 g_free (subtree_path);
6118 /* ---------------------------------------------------------------------------------------------------- */
6120 static GDBusConnection **
6121 message_bus_get_singleton (GBusType bus_type,
6124 GDBusConnection **ret;
6125 const gchar *starter_bus;
6131 case G_BUS_TYPE_SESSION:
6132 ret = &the_session_bus;
6135 case G_BUS_TYPE_SYSTEM:
6136 ret = &the_system_bus;
6139 case G_BUS_TYPE_STARTER:
6140 starter_bus = g_getenv ("DBUS_STARTER_BUS_TYPE");
6141 if (g_strcmp0 (starter_bus, "session") == 0)
6143 ret = message_bus_get_singleton (G_BUS_TYPE_SESSION, error);
6146 else if (g_strcmp0 (starter_bus, "system") == 0)
6148 ret = message_bus_get_singleton (G_BUS_TYPE_SYSTEM, error);
6153 if (starter_bus != NULL)
6157 G_IO_ERROR_INVALID_ARGUMENT,
6158 _("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
6159 " - unknown value `%s'"),
6164 g_set_error_literal (error,
6166 G_IO_ERROR_INVALID_ARGUMENT,
6167 _("Cannot determine bus address because the DBUS_STARTER_BUS_TYPE environment "
6168 "variable is not set"));
6174 g_assert_not_reached ();
6182 static GDBusConnection *
6183 get_uninitialized_connection (GBusType bus_type,
6184 GCancellable *cancellable,
6187 GDBusConnection **singleton;
6188 GDBusConnection *ret;
6192 G_LOCK (message_bus_lock);
6193 singleton = message_bus_get_singleton (bus_type, error);
6194 if (singleton == NULL)
6197 if (*singleton == NULL)
6200 address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
6201 if (address == NULL)
6203 ret = *singleton = g_object_new (G_TYPE_DBUS_CONNECTION,
6205 "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
6206 G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
6207 "exit-on-close", TRUE,
6213 ret = g_object_ref (*singleton);
6216 g_assert (ret != NULL);
6219 G_UNLOCK (message_bus_lock);
6225 * @bus_type: A #GBusType.
6226 * @cancellable: A #GCancellable or %NULL.
6227 * @error: Return location for error or %NULL.
6229 * Synchronously connects to the message bus specified by @bus_type.
6230 * Note that the returned object may shared with other callers,
6231 * e.g. if two separate parts of a process calls this function with
6232 * the same @bus_type, they will share the same object.
6234 * This is a synchronous failable function. See g_bus_get() and
6235 * g_bus_get_finish() for the asynchronous version.
6237 * The returned object is a singleton, that is, shared with other
6238 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6239 * event that you need a private message bus connection, use
6240 * g_dbus_address_get_for_bus_sync() and
6241 * g_dbus_connection_new_for_address().
6243 * Note that the returned #GDBusConnection object will (usually) have
6244 * the #GDBusConnection:exit-on-close property set to %TRUE.
6246 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
6251 g_bus_get_sync (GBusType bus_type,
6252 GCancellable *cancellable,
6255 GDBusConnection *connection;
6257 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6259 connection = get_uninitialized_connection (bus_type, cancellable, error);
6260 if (connection == NULL)
6263 if (!g_initable_init (G_INITABLE (connection), cancellable, error))
6265 g_object_unref (connection);
6274 bus_get_async_initable_cb (GObject *source_object,
6278 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (user_data);
6282 if (!g_async_initable_init_finish (G_ASYNC_INITABLE (source_object),
6286 g_assert (error != NULL);
6287 g_simple_async_result_set_from_error (simple, error);
6288 g_error_free (error);
6289 g_object_unref (source_object);
6293 g_simple_async_result_set_op_res_gpointer (simple,
6297 g_simple_async_result_complete_in_idle (simple);
6298 g_object_unref (simple);
6303 * @bus_type: A #GBusType.
6304 * @cancellable: A #GCancellable or %NULL.
6305 * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
6306 * @user_data: The data to pass to @callback.
6308 * Asynchronously connects to the message bus specified by @bus_type.
6310 * When the operation is finished, @callback will be invoked. You can
6311 * then call g_bus_get_finish() to get the result of the operation.
6313 * This is a asynchronous failable function. See g_bus_get_sync() for
6314 * the synchronous version.
6319 g_bus_get (GBusType bus_type,
6320 GCancellable *cancellable,
6321 GAsyncReadyCallback callback,
6324 GDBusConnection *connection;
6325 GSimpleAsyncResult *simple;
6328 simple = g_simple_async_result_new (NULL,
6334 connection = get_uninitialized_connection (bus_type, cancellable, &error);
6335 if (connection == NULL)
6337 g_assert (error != NULL);
6338 g_simple_async_result_set_from_error (simple, error);
6339 g_error_free (error);
6340 g_simple_async_result_complete_in_idle (simple);
6341 g_object_unref (simple);
6345 g_async_initable_init_async (G_ASYNC_INITABLE (connection),
6348 bus_get_async_initable_cb,
6355 * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
6356 * @error: Return location for error or %NULL.
6358 * Finishes an operation started with g_bus_get().
6360 * The returned object is a singleton, that is, shared with other
6361 * callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
6362 * event that you need a private message bus connection, use
6363 * g_dbus_address_get_for_bus() and
6364 * g_dbus_connection_new_for_address().
6366 * Note that the returned #GDBusConnection object will (usually) have
6367 * the #GDBusConnection:exit-on-close property set to %TRUE.
6369 * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
6374 g_bus_get_finish (GAsyncResult *res,
6377 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
6379 GDBusConnection *ret;
6381 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
6383 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_bus_get);
6387 if (g_simple_async_result_propagate_error (simple, error))
6390 object = g_simple_async_result_get_op_res_gpointer (simple);
6391 g_assert (object != NULL);
6392 ret = g_object_ref (G_DBUS_CONNECTION (object));
6398 /* ---------------------------------------------------------------------------------------------------- */