/* GDBus - GLib D-Bus Library
*
- * Copyright (C) 2008-2009 Red Hat, Inc.
+ * Copyright (C) 2008-2010 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: David Zeuthen <davidz@redhat.com>
*/
*
* - would be nice to expose GDBusAuthMechanism and an extension point
*
+ * - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
+ * the mechanism VFuncs need to be able to set an error.
+ *
+ * - Need to document other mechanisms/sources for determining the D-Bus
+ * address of a well-known bus.
+ *
+ * - e.g. on Win32 we need code like from here
+ *
+ * http://cgit.freedesktop.org/~david/gdbus-standalone/tree/gdbus/gdbusaddress.c#n900
+ *
+ * that was never copied over here because it originally was copy-paste
+ * from the GPLv2 / AFL 2.1 libdbus sources.
+ *
+ * - on OS X we need to look in launchd for the address
+ *
+ * https://bugs.freedesktop.org/show_bug.cgi?id=14259
+ *
+ * - on X11 we need to look in a X11 property on the X server
+ * - (we can also just use dbus-launch(1) from the D-Bus
+ * distribution)
+ *
+ * - (ideally) this requires D-Bus spec work because none of
+ * this has never really been specced out properly (except
+ * the X11 bits)
+ *
+ * - Related to the above, we also need to be able to launch a message bus
+ * instance.... Since we don't want to write our own bus daemon we should
+ * launch dbus-daemon(1) (thus: Win32 and OS X need to bundle it)
+ *
+ * - probably want a G_DBUS_NONCE_TCP_TMPDIR environment variable
+ * to specify where the nonce is stored. This will allow people to use
+ * G_DBUS_NONCE_TCP_TMPDIR=/mnt/secure.company.server/dbus-nonce-dir
+ * to easily achieve secure RPC via nonce-tcp.
+ *
* - need to expose an extension point for resolving D-Bus address and
* turning them into GIOStream objects. This will allow us to implement
* e.g. X11 D-Bus transports without dlopen()'ing or linking against
* - see g_dbus_address_connect() in gdbusaddress.c
*
* - would be cute to use kernel-specific APIs to resolve fds for
- * debug output when using G_DBUS_DEBUG=messages, e.g. in addition to
+ * debug output when using G_DBUS_DEBUG=message, e.g. in addition to
*
* fd 21: dev=8:1,mode=0100644,ino=1171231,uid=0,gid=0,rdev=0:0,size=234,atime=1273070640,mtime=1267126160,ctime=1267126160
*
* 3 -> /proc/18068/fd
*
* e.g. not of much use.
+ *
+ * - GDBus High-Level docs
+ * - Proxy: properties, signals...
+ * - Connection: IOStream based, ::close, connection setup steps
+ * mainloop integration, threading
+ * - Differences from libdbus (extend "Migrating from")
+ * - the message handling thread
+ * - Using GVariant instead of GValue
+ * - Explain why the high-level API is a good thing and what
+ * kind of pitfalls it avoids
+ * - Export objects before claiming names
+ * - Talk about auto-starting services (cf. GBusNameWatcherFlags)
+ *
+ * - use abstract sockets in test code
+ * - right now it doesn't work, dbus-daemon(1) fails with
+ *
+ * /gdbus/connection/filter: Failed to start message bus: Failed to bind
+ * socket "/tmp/g-dbus-tests-pid-28531": Address already in use
+ * ** WARNING **: Error reading address from dbus daemon, 0 bytes read
+ *
+ * or similar.
*/
#include "config.h"
#include <stdlib.h>
-
-#include <glib/gi18n.h>
-
-#ifdef G_OS_UNIX
-#include <gio/gunixconnection.h>
-#include <gio/gunixfdmessage.h>
-#endif
-
-#include <unistd.h>
-#include <sys/types.h>
-#include <stdlib.h>
+#include <string.h>
#include "gdbusauth.h"
-
#include "gdbusutils.h"
#include "gdbusaddress.h"
#include "gdbusmessage.h"
#include "gdbusmethodinvocation.h"
#include "gdbusprivate.h"
#include "gdbusauthobserver.h"
-#include "gio-marshal.h"
+#include "ginitable.h"
+#include "gasyncinitable.h"
+#include "giostream.h"
+#include "gasyncresult.h"
+#include "gsimpleasyncresult.h"
+
+#ifdef G_OS_UNIX
+#include "gunixconnection.h"
+#include "gunixfdmessage.h"
+#endif
+
+#include "glibintl.h"
/**
* SECTION:gdbusconnection
* @short_description: D-Bus Connections
- * @include: gdbus/gdbus.h
- *
- * <para><note>
- * This class is rarely used directly in D-Bus clients. If you are
- * writing an D-Bus client, it is often easier to use the
- * g_bus_own_name(), g_bus_watch_name() or g_bus_watch_proxy() APIs.
- * </note></para>
+ * @include: gio/gio.h
*
* The #GDBusConnection type is used for D-Bus connections to remote
- * peers such as a message buses.
+ * peers such as a message buses. It is a low-level API that offers a
+ * lot of flexibility. For instance, it lets you establish a connection
+ * over any transport that can by represented as an #GIOStream.
+ *
+ * This class is rarely used directly in D-Bus clients. If you are writing
+ * an D-Bus client, it is often easier to use the g_bus_own_name(),
+ * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
+ *
+ * As an exception to the usual GLib rule that a particular object must not
+ * be used by two threads at the same time, #GDBusConnection's methods may be
+ * called from any thread. This is so that g_bus_get() and g_bus_get_sync()
+ * can safely return the same #GDBusConnection when called from any thread.
+ *
+ * Most of the ways to obtain a #GDBusConnection automatically initialize it
+ * (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
+ * g_bus_get(), and the synchronous versions of those methods, give you an
+ * initialized connection. Language bindings for GIO should use
+ * g_initable_new() or g_async_initable_new_async(), which also initialize the
+ * connection.
+ *
+ * If you construct an uninitialized #GDBusConnection, such as via
+ * g_object_new(), you must initialize it via g_initable_init() or
+ * g_async_initable_init_async() before using its methods or properties.
+ * Calling methods or accessing properties on a #GDBusConnection that has not
+ * completed initialization successfully is considered to be invalid, and leads
+ * to undefined behaviour. In particular, if initialization fails with a
+ * #GError, the only valid thing you can do with that #GDBusConnection is to
+ * free it with g_object_unref().
+ *
+ * ## An example D-Bus server # {#gdbus-server}
*
- * <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>
+ * Here is an example for a D-Bus server:
+ * [gdbus-example-server.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-server.c)
*
- * <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>
+ * ## An example for exporting a subtree # {#gdbus-subtree-server}
*
- * <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>
+ * Here is an example for exporting a subtree:
+ * [gdbus-example-subtree.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-subtree.c)
+ *
+ * ## An example for file descriptor passing # {#gdbus-unix-fd-client}
+ *
+ * Here is an example for passing UNIX file descriptors:
+ * [gdbus-unix-fd-client.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-unix-fd-client.c)
+ *
+ * ## An example for exporting a GObject # {#gdbus-export}
+ *
+ * Here is an example for exporting a #GObject:
+ * [gdbus-example-export.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-export.c)
*/
/* ---------------------------------------------------------------------------------------------------- */
+typedef struct _GDBusConnectionClass GDBusConnectionClass;
+
+/**
+ * GDBusConnectionClass:
+ * @closed: Signal class handler for the #GDBusConnection::closed signal.
+ *
+ * Class structure for #GDBusConnection.
+ *
+ * Since: 2.26
+ */
+struct _GDBusConnectionClass
+{
+ /*< private >*/
+ GObjectClass parent_class;
+
+ /*< public >*/
+ /* Signals */
+ void (*closed) (GDBusConnection *connection,
+ gboolean remote_peer_vanished,
+ GError *error);
+};
+
G_LOCK_DEFINE_STATIC (message_bus_lock);
-static GDBusConnection *the_session_bus = NULL;
-static GDBusConnection *the_system_bus = NULL;
+static GWeakRef the_session_bus;
+static GWeakRef the_system_bus;
+
+/* Extra pseudo-member of GDBusSendMessageFlags.
+ * Set by initable_init() to indicate that despite not being initialized yet,
+ * enough of the only-valid-after-init members are set that we can send a
+ * message, and we're being called from its thread, so no memory barrier is
+ * required before accessing them.
+ */
+#define SEND_MESSAGE_FLAGS_INITIALIZING (1<<31)
+
+/* Same as SEND_MESSAGE_FLAGS_INITIALIZING, but in GDBusCallFlags */
+#define CALL_FLAGS_INITIALIZING (1<<31)
+
+/* ---------------------------------------------------------------------------------------------------- */
+
+typedef struct
+{
+ GDestroyNotify callback;
+ gpointer user_data;
+ GMainContext *context;
+} CallDestroyNotifyData;
+
+static gboolean
+call_destroy_notify_data_in_idle (gpointer user_data)
+{
+ CallDestroyNotifyData *data = user_data;
+ data->callback (data->user_data);
+ return FALSE;
+}
+
+static void
+call_destroy_notify_data_free (CallDestroyNotifyData *data)
+{
+ if (data->context != NULL)
+ g_main_context_unref (data->context);
+ g_free (data);
+}
+
+/*
+ * call_destroy_notify: <internal>
+ * @context: (allow-none): A #GMainContext or %NULL.
+ * @callback: (allow-none): A #GDestroyNotify or %NULL.
+ * @user_data: Data to pass to @callback.
+ *
+ * Schedules @callback to run in @context.
+ */
+static void
+call_destroy_notify (GMainContext *context,
+ GDestroyNotify callback,
+ gpointer user_data)
+{
+ GSource *idle_source;
+ CallDestroyNotifyData *data;
+
+ if (callback == NULL)
+ goto out;
+
+ data = g_new0 (CallDestroyNotifyData, 1);
+ data->callback = callback;
+ data->user_data = user_data;
+ data->context = context;
+ if (data->context != NULL)
+ g_main_context_ref (data->context);
+
+ idle_source = g_idle_source_new ();
+ g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
+ g_source_set_callback (idle_source,
+ call_destroy_notify_data_in_idle,
+ data,
+ (GDestroyNotify) call_destroy_notify_data_free);
+ g_source_set_name (idle_source, "[gio] call_destroy_notify_data_in_idle");
+ g_source_attach (idle_source, data->context);
+ g_source_unref (idle_source);
+
+ out:
+ ;
+}
/* ---------------------------------------------------------------------------------------------------- */
static gboolean
-_g_strv_has_string (const gchar* const * haystack,
- const gchar *needle)
+_g_strv_has_string (const gchar* const *haystack,
+ const gchar *needle)
{
guint n;
#else
// TODO: for some reason this doesn't work on Windows
#define CONNECTION_ENSURE_LOCK(obj) do { \
- if (G_UNLIKELY (g_mutex_trylock((obj)->priv->lock))) \
+ if (G_UNLIKELY (g_mutex_trylock(&(obj)->lock))) \
{ \
g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
"CONNECTION_ENSURE_LOCK: GDBusConnection object lock is not locked"); \
#endif
#define CONNECTION_LOCK(obj) do { \
- g_mutex_lock ((obj)->priv->lock); \
+ g_mutex_lock (&(obj)->lock); \
} while (FALSE)
#define CONNECTION_UNLOCK(obj) do { \
- g_mutex_unlock ((obj)->priv->lock); \
+ g_mutex_unlock (&(obj)->lock); \
} while (FALSE)
-struct _GDBusConnectionPrivate
+/* Flags in connection->atomic_flags */
+enum {
+ FLAG_INITIALIZED = 1 << 0,
+ FLAG_EXIT_ON_CLOSE = 1 << 1,
+ FLAG_CLOSED = 1 << 2
+};
+
+/**
+ * GDBusConnection:
+ *
+ * The #GDBusConnection structure contains only private data and
+ * should only be accessed using the provided API.
+ *
+ * Since: 2.26
+ */
+struct _GDBusConnection
{
+ /*< private >*/
+ GObject parent_instance;
+
/* ------------------------------------------------------------------------ */
/* -- General object state ------------------------------------------------ */
/* ------------------------------------------------------------------------ */
- /* object-wide lock */
- GMutex *lock;
+ /* General-purpose lock for most fields */
+ GMutex lock;
/* A lock used in the init() method of the GInitable interface - see comments
- * in initable_init() for why a separate lock is needed
+ * in initable_init() for why a separate lock is needed.
+ *
+ * If you need both @lock and @init_lock, you must take @init_lock first.
*/
- GMutex *init_lock;
+ GMutex init_lock;
/* Set (by loading the contents of /var/lib/dbus/machine-id) the first time
- * someone calls org.freedesktop.DBus.GetMachineId()
+ * someone calls org.freedesktop.DBus.Peer.GetMachineId(). Protected by @lock.
*/
gchar *machine_id;
- /* The underlying stream used for communication */
+ /* The underlying stream used for communication
+ * Read-only after initable_init(), so it may be read if you either
+ * hold @init_lock or check for initialization first.
+ */
GIOStream *stream;
- /* The object used for authentication (if any) */
+ /* The object used for authentication (if any).
+ * Read-only after initable_init(), so it may be read if you either
+ * hold @init_lock or check for initialization first.
+ */
GDBusAuth *auth;
- /* Set to TRUE if the connection has been closed */
- gboolean closed;
-
- /* Last serial used */
+ /* Last serial used. Protected by @lock. */
guint32 last_serial;
- /* The object used to send/receive message */
+ /* The object used to send/receive messages.
+ * Read-only after initable_init(), so it may be read if you either
+ * hold @init_lock or check for initialization first.
+ */
GDBusWorker *worker;
/* If connected to a message bus, this contains the unique name assigned to
- * us by the bus (e.g. ":1.42")
+ * us by the bus (e.g. ":1.42").
+ * Read-only after initable_init(), so it may be read if you either
+ * hold @init_lock or check for initialization first.
*/
gchar *bus_unique_name;
/* The GUID returned by the other side if we authenticed as a client or
- * the GUID to use if authenticating as a server
+ * the GUID to use if authenticating as a server.
+ * Read-only after initable_init(), so it may be read if you either
+ * hold @init_lock or check for initialization first.
*/
gchar *guid;
- /* set to TRUE exactly when initable_init() has finished running */
- gboolean is_initialized;
+ /* FLAG_INITIALIZED is set exactly when initable_init() has finished running.
+ * Inspect @initialization_error to see whether it succeeded or failed.
+ *
+ * FLAG_EXIT_ON_CLOSE is the exit-on-close property.
+ *
+ * FLAG_CLOSED is the closed property. It may be read at any time, but
+ * may only be written while holding @lock.
+ */
+ volatile gint atomic_flags;
- /* If the connection could not be established during initable_init(), this GError will set */
+ /* If the connection could not be established during initable_init(),
+ * this GError will be set.
+ * Read-only after initable_init(), so it may be read if you either
+ * hold @init_lock or check for initialization first.
+ */
GError *initialization_error;
- /* The result of g_main_context_get_thread_default() when the object
+ /* The result of g_main_context_ref_thread_default() when the object
* was created (the GObject _init() function) - this is used for delivery
* of the :closed GObject signal.
+ *
+ * Only set in the GObject init function, so no locks are needed.
*/
GMainContext *main_context_at_construction;
- /* construct properties */
+ /* Read-only construct properties, no locks needed */
gchar *address;
GDBusConnectionFlags flags;
- /* Map used for managing method replies */
+ /* Map used for managing method replies, protected by @lock */
GHashTable *map_method_serial_to_send_message_data; /* guint32 -> SendMessageData* */
- /* Maps used for managing signal subscription */
- GHashTable *map_rule_to_signal_data; /* gchar* -> SignalData */
- GHashTable *map_id_to_signal_data; /* guint -> SignalData */
- GHashTable *map_sender_to_signal_data_array; /* gchar* -> GPtrArray* of SignalData */
+ /* Maps used for managing signal subscription, protected by @lock */
+ GHashTable *map_rule_to_signal_data; /* match rule (gchar*) -> SignalData */
+ GHashTable *map_id_to_signal_data; /* id (guint) -> SignalData */
+ GHashTable *map_sender_unique_name_to_signal_data_array; /* unique sender (gchar*) -> GPtrArray* of SignalData */
- /* Maps used for managing exported objects and subtrees */
+ /* Maps used for managing exported objects and subtrees,
+ * protected by @lock
+ */
GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
GHashTable *map_id_to_ei; /* guint -> ExportedInterface* */
GHashTable *map_object_path_to_es; /* gchar* -> ExportedSubtree* */
GHashTable *map_id_to_es; /* guint -> ExportedSubtree* */
- /* Structure used for message filters */
- GPtrArray *filters;
+ /* Map used for storing last used serials for each thread, protected by @lock */
+ GHashTable *map_thread_to_last_serial;
- /* Whether to exit on close */
- gboolean exit_on_close;
+ /* Structure used for message filters, protected by @lock */
+ GPtrArray *filters;
- /* Capabilities negotiated during authentication */
+ /* Capabilities negotiated during authentication
+ * Read-only after initable_init(), so it may be read without holding a
+ * lock, if you check for initialization first.
+ */
GDBusCapabilityFlags capabilities;
+ /* Protected by @init_lock */
GDBusAuthObserver *authentication_observer;
- GCredentials *crendentials;
+
+ /* Read-only after initable_init(), so it may be read if you either
+ * hold @init_lock or check for initialization first.
+ */
+ GCredentials *credentials;
+
+ /* set to TRUE when finalizing */
+ gboolean finalizing;
};
typedef struct ExportedObject ExportedObject;
static void purge_all_signal_subscriptions (GDBusConnection *connection);
static void purge_all_filters (GDBusConnection *connection);
+static void schedule_method_call (GDBusConnection *connection,
+ GDBusMessage *message,
+ guint registration_id,
+ guint subtree_registration_id,
+ const GDBusInterfaceInfo *interface_info,
+ const GDBusMethodInfo *method_info,
+ const GDBusPropertyInfo *property_info,
+ GVariant *parameters,
+ const GDBusInterfaceVTable *vtable,
+ GMainContext *main_context,
+ gpointer user_data);
+
#define _G_ENSURE_LOCK(name) do { \
if (G_UNLIKELY (G_TRYLOCK(name))) \
{ \
g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
- "_G_ENSURE_LOCK: Lock `" #name "' is not locked"); \
+ "_G_ENSURE_LOCK: Lock '" #name "' is not locked"); \
} \
} while (FALSE) \
static guint signals[LAST_SIGNAL] = { 0 };
-static void initable_iface_init (GInitableIface *initable_iface);
+static void initable_iface_init (GInitableIface *initable_iface);
static void async_initable_iface_init (GAsyncInitableIface *async_initable_iface);
G_DEFINE_TYPE_WITH_CODE (GDBusConnection, g_dbus_connection, G_TYPE_OBJECT,
G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
);
+/*
+ * Check that all members of @connection that can only be accessed after
+ * the connection is initialized can safely be accessed. If not,
+ * log a critical warning. This function is a memory barrier.
+ *
+ * Returns: %TRUE if initialized
+ */
+static gboolean
+check_initialized (GDBusConnection *connection)
+{
+ /* The access to @atomic_flags isn't conditional, so that this function
+ * provides a memory barrier for thread-safety even if checks are disabled.
+ * (If you don't want this stricter guarantee, you can call
+ * g_return_if_fail (check_initialized (c)).)
+ *
+ * This isn't strictly necessary now that we've decided use of an
+ * uninitialized GDBusConnection is undefined behaviour, but it seems
+ * better to be as deterministic as is feasible.
+ *
+ * (Anything that could suffer a crash from seeing undefined values
+ * must have a race condition - thread A initializes the connection while
+ * thread B calls a method without initialization, hoping that thread A will
+ * win the race - so its behaviour is undefined anyway.)
+ */
+ gint flags = g_atomic_int_get (&connection->atomic_flags);
+
+ g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
+
+ /* We can safely access this, due to the memory barrier above */
+ g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
+
+ return TRUE;
+}
+
+typedef enum {
+ MAY_BE_UNINITIALIZED = (1<<1)
+} CheckUnclosedFlags;
+
+/*
+ * Check the same thing as check_initialized(), and also that the
+ * connection is not closed. If the connection is uninitialized,
+ * raise a critical warning (it's programmer error); if it's closed,
+ * raise a recoverable GError (it's a runtime error).
+ *
+ * This function is a memory barrier.
+ *
+ * Returns: %TRUE if initialized and not closed
+ */
+static gboolean
+check_unclosed (GDBusConnection *connection,
+ CheckUnclosedFlags check,
+ GError **error)
+{
+ /* check_initialized() is effectively inlined, so we don't waste time
+ * doing two memory barriers
+ */
+ gint flags = g_atomic_int_get (&connection->atomic_flags);
+
+ if (!(check & MAY_BE_UNINITIALIZED))
+ {
+ g_return_val_if_fail (flags & FLAG_INITIALIZED, FALSE);
+ g_return_val_if_fail (connection->initialization_error == NULL, FALSE);
+ }
+
+ if (flags & FLAG_CLOSED)
+ {
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_CLOSED,
+ _("The connection is closed"));
+ return FALSE;
+ }
+
+ return TRUE;
+}
+
+static GHashTable *alive_connections = NULL;
+
static void
g_dbus_connection_dispose (GObject *object)
{
GDBusConnection *connection = G_DBUS_CONNECTION (object);
G_LOCK (message_bus_lock);
- //g_debug ("disposing %p", connection);
- if (connection == the_session_bus)
- {
- the_session_bus = NULL;
- }
- else if (connection == the_system_bus)
+ CONNECTION_LOCK (connection);
+ if (connection->worker != NULL)
{
- the_system_bus = NULL;
+ _g_dbus_worker_stop (connection->worker);
+ connection->worker = NULL;
+ if (alive_connections != NULL)
+ g_warn_if_fail (g_hash_table_remove (alive_connections, connection));
}
- if (connection->priv->worker != NULL)
+ else
{
- _g_dbus_worker_stop (connection->priv->worker);
- connection->priv->worker = NULL;
+ if (alive_connections != NULL)
+ g_warn_if_fail (g_hash_table_lookup (alive_connections, connection) == NULL);
}
+ CONNECTION_UNLOCK (connection);
G_UNLOCK (message_bus_lock);
if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->dispose != NULL)
{
GDBusConnection *connection = G_DBUS_CONNECTION (object);
- if (connection->priv->authentication_observer != NULL)
- g_object_unref (connection->priv->authentication_observer);
+ connection->finalizing = TRUE;
+
+ purge_all_signal_subscriptions (connection);
+
+ purge_all_filters (connection);
+ g_ptr_array_unref (connection->filters);
+
+ if (connection->authentication_observer != NULL)
+ g_object_unref (connection->authentication_observer);
- if (connection->priv->auth != NULL)
- g_object_unref (connection->priv->auth);
+ if (connection->auth != NULL)
+ g_object_unref (connection->auth);
- //g_debug ("finalizing %p", connection);
- if (connection->priv->stream != NULL)
+ if (connection->credentials)
+ g_object_unref (connection->credentials);
+
+ if (connection->stream != NULL)
{
- /* We don't really care if closing the stream succeeds or not */
- g_io_stream_close_async (connection->priv->stream,
- G_PRIORITY_DEFAULT,
- NULL, /* GCancellable */
- NULL, /* GAsyncReadyCallback */
- NULL); /* userdata */
- g_object_unref (connection->priv->stream);
- connection->priv->stream = NULL;
+ g_object_unref (connection->stream);
+ connection->stream = NULL;
}
- g_free (connection->priv->address);
+ g_free (connection->address);
- g_free (connection->priv->guid);
- g_free (connection->priv->bus_unique_name);
+ g_free (connection->guid);
+ g_free (connection->bus_unique_name);
- if (connection->priv->initialization_error != NULL)
- g_error_free (connection->priv->initialization_error);
+ if (connection->initialization_error != NULL)
+ g_error_free (connection->initialization_error);
- g_hash_table_unref (connection->priv->map_method_serial_to_send_message_data);
+ g_hash_table_unref (connection->map_method_serial_to_send_message_data);
- purge_all_signal_subscriptions (connection);
- g_hash_table_unref (connection->priv->map_rule_to_signal_data);
- g_hash_table_unref (connection->priv->map_id_to_signal_data);
- g_hash_table_unref (connection->priv->map_sender_to_signal_data_array);
+ g_hash_table_unref (connection->map_rule_to_signal_data);
+ g_hash_table_unref (connection->map_id_to_signal_data);
+ g_hash_table_unref (connection->map_sender_unique_name_to_signal_data_array);
- g_hash_table_unref (connection->priv->map_id_to_ei);
- g_hash_table_unref (connection->priv->map_object_path_to_eo);
- g_hash_table_unref (connection->priv->map_id_to_es);
- g_hash_table_unref (connection->priv->map_object_path_to_es);
+ g_hash_table_unref (connection->map_id_to_ei);
+ g_hash_table_unref (connection->map_object_path_to_eo);
+ g_hash_table_unref (connection->map_id_to_es);
+ g_hash_table_unref (connection->map_object_path_to_es);
- purge_all_filters (connection);
- g_ptr_array_unref (connection->priv->filters);
+ g_hash_table_unref (connection->map_thread_to_last_serial);
- if (connection->priv->main_context_at_construction != NULL)
- g_main_context_unref (connection->priv->main_context_at_construction);
+ g_main_context_unref (connection->main_context_at_construction);
- g_free (connection->priv->machine_id);
+ g_free (connection->machine_id);
- g_mutex_free (connection->priv->init_lock);
- g_mutex_free (connection->priv->lock);
+ g_mutex_clear (&connection->init_lock);
+ g_mutex_clear (&connection->lock);
- if (G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize != NULL)
- G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
+ G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
}
+/* called in any user thread, with the connection's lock not held */
static void
g_dbus_connection_get_property (GObject *object,
guint prop_id,
}
}
+/* called in any user thread, with the connection's lock not held */
static void
g_dbus_connection_set_property (GObject *object,
guint prop_id,
switch (prop_id)
{
case PROP_STREAM:
- connection->priv->stream = g_value_dup_object (value);
+ connection->stream = g_value_dup_object (value);
break;
case PROP_GUID:
- connection->priv->guid = g_value_dup_string (value);
+ connection->guid = g_value_dup_string (value);
break;
case PROP_ADDRESS:
- connection->priv->address = g_value_dup_string (value);
+ connection->address = g_value_dup_string (value);
break;
case PROP_FLAGS:
- connection->priv->flags = g_value_get_flags (value);
+ connection->flags = g_value_get_flags (value);
break;
case PROP_EXIT_ON_CLOSE:
break;
case PROP_AUTHENTICATION_OBSERVER:
- connection->priv->authentication_observer = g_value_dup_object (value);
+ connection->authentication_observer = g_value_dup_object (value);
break;
default:
}
}
+/* Base-class implementation of GDBusConnection::closed.
+ *
+ * Called in a user thread, by the main context that was thread-default when
+ * the object was constructed.
+ */
static void
g_dbus_connection_real_closed (GDBusConnection *connection,
gboolean remote_peer_vanished,
GError *error)
{
- if (remote_peer_vanished && connection->priv->exit_on_close)
+ gint flags = g_atomic_int_get (&connection->atomic_flags);
+
+ /* Because atomic int access is a memory barrier, we can safely read
+ * initialization_error without a lock, as long as we do it afterwards.
+ */
+ if (remote_peer_vanished &&
+ (flags & FLAG_EXIT_ON_CLOSE) != 0 &&
+ (flags & FLAG_INITIALIZED) != 0 &&
+ connection->initialization_error == NULL)
{
- g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
+ if (error != NULL)
+ {
+ g_printerr ("%s: Remote peer vanished with error: %s (%s, %d). Exiting.\n",
+ G_STRFUNC,
+ error->message,
+ g_quark_to_string (error->domain), error->code);
+ }
+ else
+ {
+ g_printerr ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
+ }
raise (SIGTERM);
}
}
{
GObjectClass *gobject_class;
- g_type_class_add_private (klass, sizeof (GDBusConnectionPrivate));
-
gobject_class = G_OBJECT_CLASS (klass);
gobject_class->finalize = g_dbus_connection_finalize;
* GDBusConnection:stream:
*
* The underlying #GIOStream used for I/O.
+ *
+ * If this is passed on construction and is a #GSocketConnection,
+ * then the corresponding #GSocket will be put into non-blocking mode.
+ *
+ * While the #GDBusConnection is active, it will interact with this
+ * stream from a worker thread, so it is not safe to interact with
+ * the stream directly.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_STREAM,
g_param_spec_object ("stream",
- _("IO Stream"),
- _("The underlying streams used for I/O"),
+ P_("IO Stream"),
+ P_("The underlying streams used for I/O"),
G_TYPE_IO_STREAM,
G_PARAM_READABLE |
G_PARAM_WRITABLE |
*
* A D-Bus address specifying potential endpoints that can be used
* when establishing the connection.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_ADDRESS,
g_param_spec_string ("address",
- _("Address"),
- _("D-Bus address specifying potential socket endpoints"),
+ P_("Address"),
+ P_("D-Bus address specifying potential socket endpoints"),
NULL,
G_PARAM_WRITABLE |
G_PARAM_CONSTRUCT_ONLY |
* GDBusConnection:flags:
*
* Flags from the #GDBusConnectionFlags enumeration.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_FLAGS,
g_param_spec_flags ("flags",
- _("Flags"),
- _("Flags"),
+ P_("Flags"),
+ P_("Flags"),
G_TYPE_DBUS_CONNECTION_FLAGS,
G_DBUS_CONNECTION_FLAGS_NONE,
G_PARAM_WRITABLE |
* If you are constructing a #GDBusConnection and pass
* %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT in the
* #GDBusConnection:flags property you will be able to read the GUID
- * of the other peer here after the connection has been succesfully
+ * of the other peer here after the connection has been successfully
* initialized.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_GUID,
g_param_spec_string ("guid",
- _("GUID"),
- _("GUID of the server peer"),
+ P_("GUID"),
+ P_("GUID of the server peer"),
NULL,
G_PARAM_READABLE |
G_PARAM_WRITABLE |
*
* The unique name as assigned by the message bus or %NULL if the
* connection is not open or not a message bus connection.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_UNIQUE_NAME,
g_param_spec_string ("unique-name",
- _("unique-name"),
- _("Unique name of bus connection"),
+ P_("unique-name"),
+ P_("Unique name of bus connection"),
NULL,
G_PARAM_READABLE |
G_PARAM_STATIC_NAME |
* GDBusConnection:closed:
*
* A boolean specifying whether the connection has been closed.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_CLOSED,
g_param_spec_boolean ("closed",
- _("Closed"),
- _("Whether the connection is closed"),
+ P_("Closed"),
+ P_("Whether the connection is closed"),
FALSE,
G_PARAM_READABLE |
G_PARAM_STATIC_NAME |
* GDBusConnection:exit-on-close:
*
* A boolean specifying whether the process will be terminated (by
- * calling <literal>raise(SIGTERM)</literal>) if the connection
- * is closed by the remote peer.
+ * calling `raise(SIGTERM)`) if the connection is closed by the
+ * remote peer.
+ *
+ * Note that #GDBusConnection objects returned by g_bus_get_finish()
+ * and g_bus_get_sync() will (usually) have this property set to %TRUE.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_EXIT_ON_CLOSE,
g_param_spec_boolean ("exit-on-close",
- _("Exit on close"),
- _("Whether the process is terminated when the connection is closed"),
+ P_("Exit on close"),
+ P_("Whether the process is terminated when the connection is closed"),
FALSE,
G_PARAM_READABLE |
G_PARAM_WRITABLE |
*
* Flags from the #GDBusCapabilityFlags enumeration
* representing connection features negotiated with the other peer.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_CAPABILITY_FLAGS,
g_param_spec_flags ("capabilities",
- _("Capabilities"),
- _("Capabilities"),
+ P_("Capabilities"),
+ P_("Capabilities"),
G_TYPE_DBUS_CAPABILITY_FLAGS,
G_DBUS_CAPABILITY_FLAGS_NONE,
G_PARAM_READABLE |
* GDBusConnection:authentication-observer:
*
* A #GDBusAuthObserver object to assist in the authentication process or %NULL.
+ *
+ * Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_AUTHENTICATION_OBSERVER,
g_param_spec_object ("authentication-observer",
- _("Authentication Observer"),
- _("Object used to assist in the authentication process"),
+ P_("Authentication Observer"),
+ P_("Object used to assist in the authentication process"),
G_TYPE_DBUS_AUTH_OBSERVER,
G_PARAM_WRITABLE |
G_PARAM_CONSTRUCT_ONLY |
/**
* GDBusConnection::closed:
- * @connection: The #GDBusConnection emitting the signal.
+ * @connection: the #GDBusConnection emitting the signal
* @remote_peer_vanished: %TRUE if @connection is closed because the
- * remote peer closed its end of the connection.
- * @error: A #GError with more details about the event or %NULL.
+ * remote peer closed its end of the connection
+ * @error: (allow-none): a #GError with more details about the event or %NULL
*
* Emitted when the connection is closed.
*
* The cause of this event can be
- * <itemizedlist>
- * <listitem><para>
- * If g_dbus_connection_close() is called. In this case
- * @remote_peer_vanished is set to %FALSE and @error is %NULL.
- * </para></listitem>
- * <listitem><para>
- * If the remote peer closes the connection. In this case
- * @remote_peer_vanished is set to %TRUE and @error is set.
- * </para></listitem>
- * <listitem><para>
- * If the remote peer sends invalid or malformed data. In this
- * case @remote_peer_vanished is set to %FALSE and @error
- * is set.
- * </para></listitem>
- * </itemizedlist>
+ *
+ * - If g_dbus_connection_close() is called. In this case
+ * @remote_peer_vanished is set to %FALSE and @error is %NULL.
+ *
+ * - If the remote peer closes the connection. In this case
+ * @remote_peer_vanished is set to %TRUE and @error is set.
+ *
+ * - If the remote peer sends invalid or malformed data. In this
+ * case @remote_peer_vanished is set to %FALSE and @error is set.
*
* Upon receiving this signal, you should give up your reference to
* @connection. You are guaranteed that this signal is emitted only
* once.
+ *
+ * Since: 2.26
*/
signals[CLOSED_SIGNAL] = g_signal_new ("closed",
G_TYPE_DBUS_CONNECTION,
G_STRUCT_OFFSET (GDBusConnectionClass, closed),
NULL,
NULL,
- _gio_marshal_VOID__BOOLEAN_BOXED,
+ NULL,
G_TYPE_NONE,
2,
G_TYPE_BOOLEAN,
static void
g_dbus_connection_init (GDBusConnection *connection)
{
- connection->priv = G_TYPE_INSTANCE_GET_PRIVATE (connection, G_TYPE_DBUS_CONNECTION, GDBusConnectionPrivate);
+ g_mutex_init (&connection->lock);
+ g_mutex_init (&connection->init_lock);
- connection->priv->lock = g_mutex_new ();
- connection->priv->init_lock = g_mutex_new ();
+ connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
- connection->priv->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
+ connection->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
+ g_str_equal);
+ connection->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
+ g_direct_equal);
+ connection->map_sender_unique_name_to_signal_data_array = g_hash_table_new_full (g_str_hash,
+ g_str_equal,
+ g_free,
+ (GDestroyNotify) g_ptr_array_unref);
- connection->priv->map_rule_to_signal_data = g_hash_table_new (g_str_hash,
- g_str_equal);
- connection->priv->map_id_to_signal_data = g_hash_table_new (g_direct_hash,
- g_direct_equal);
- connection->priv->map_sender_to_signal_data_array = g_hash_table_new_full (g_str_hash,
- g_str_equal,
- g_free,
- NULL);
+ connection->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
+ g_str_equal,
+ NULL,
+ (GDestroyNotify) exported_object_free);
- connection->priv->map_object_path_to_eo = g_hash_table_new_full (g_str_hash,
- g_str_equal,
- NULL,
- (GDestroyNotify) exported_object_free);
+ connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
+ g_direct_equal);
- connection->priv->map_id_to_ei = g_hash_table_new (g_direct_hash,
- g_direct_equal);
+ connection->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
+ g_str_equal,
+ NULL,
+ (GDestroyNotify) exported_subtree_free);
- connection->priv->map_object_path_to_es = g_hash_table_new_full (g_str_hash,
- g_str_equal,
- NULL,
- (GDestroyNotify) exported_subtree_free);
+ connection->map_id_to_es = g_hash_table_new (g_direct_hash,
+ g_direct_equal);
- connection->priv->map_id_to_es = g_hash_table_new (g_direct_hash,
- g_direct_equal);
+ connection->map_thread_to_last_serial = g_hash_table_new (g_direct_hash,
+ g_direct_equal);
- connection->priv->main_context_at_construction = g_main_context_get_thread_default ();
- if (connection->priv->main_context_at_construction != NULL)
- g_main_context_ref (connection->priv->main_context_at_construction);
+ connection->main_context_at_construction = g_main_context_ref_thread_default ();
- connection->priv->filters = g_ptr_array_new ();
+ connection->filters = g_ptr_array_new ();
}
+/**
+ * g_dbus_connection_get_stream:
+ * @connection: a #GDBusConnection
+ *
+ * Gets the underlying stream used for IO.
+ *
+ * While the #GDBusConnection is active, it will interact with this
+ * stream from a worker thread, so it is not safe to interact with
+ * the stream directly.
+ *
+ * Returns: (transfer none): the stream used for IO
+ *
+ * Since: 2.26
+ */
GIOStream *
g_dbus_connection_get_stream (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- return connection->priv->stream;
+
+ /* do not use g_return_val_if_fail(), we want the memory barrier */
+ if (!check_initialized (connection))
+ return NULL;
+
+ return connection->stream;
}
+/**
+ * g_dbus_connection_start_message_processing:
+ * @connection: a #GDBusConnection
+ *
+ * If @connection was created with
+ * %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method
+ * starts processing messages. Does nothing on if @connection wasn't
+ * created with this flag or if the method has already been called.
+ *
+ * Since: 2.26
+ */
+void
+g_dbus_connection_start_message_processing (GDBusConnection *connection)
+{
+ g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
+
+ /* do not use g_return_val_if_fail(), we want the memory barrier */
+ if (!check_initialized (connection))
+ return;
+
+ g_assert (connection->worker != NULL);
+ _g_dbus_worker_unfreeze (connection->worker);
+}
/**
* g_dbus_connection_is_closed:
- * @connection: A #GDBusConnection.
+ * @connection: a #GDBusConnection
*
* Gets whether @connection is closed.
*
- * Returns: %TRUE if the connection is closed, %FALSE otherwise.
- **/
+ * Returns: %TRUE if the connection is closed, %FALSE otherwise
+ *
+ * Since: 2.26
+ */
gboolean
g_dbus_connection_is_closed (GDBusConnection *connection)
{
+ gint flags;
+
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
- return connection->priv->closed;
+
+ flags = g_atomic_int_get (&connection->atomic_flags);
+
+ return (flags & FLAG_CLOSED) ? TRUE : FALSE;
}
/**
* g_dbus_connection_get_capabilities:
- * @connection: A #GDBusConnection.
+ * @connection: a #GDBusConnection
*
* Gets the capabilities negotiated with the remote peer
*
- * Returns: One or more flags from the #GDBusCapabilityFlags enumeration.
+ * Returns: zero or more flags from the #GDBusCapabilityFlags enumeration
+ *
+ * Since: 2.26
*/
GDBusCapabilityFlags
g_dbus_connection_get_capabilities (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), G_DBUS_CAPABILITY_FLAGS_NONE);
- return connection->priv->capabilities;
-}
+ /* do not use g_return_val_if_fail(), we want the memory barrier */
+ if (!check_initialized (connection))
+ return G_DBUS_CAPABILITY_FLAGS_NONE;
+
+ return connection->capabilities;
+}
/* ---------------------------------------------------------------------------------------------------- */
-typedef struct
+/* Called in a temporary thread without holding locks. */
+static void
+flush_in_thread_func (GSimpleAsyncResult *res,
+ GObject *object,
+ GCancellable *cancellable)
{
- GDBusConnection *connection;
GError *error;
- gboolean remote_peer_vanished;
-} EmitClosedData;
-static void
-emit_closed_data_free (EmitClosedData *data)
-{
- g_object_unref (data->connection);
- if (data->error != NULL)
- g_error_free (data->error);
- g_free (data);
+ error = NULL;
+ if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
+ cancellable,
+ &error))
+ g_simple_async_result_take_error (res, error);
}
-static gboolean
-emit_closed_in_idle (gpointer user_data)
+/**
+ * g_dbus_connection_flush:
+ * @connection: a #GDBusConnection
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: (allow-none): a #GAsyncReadyCallback to call when the
+ * request is satisfied or %NULL if you don't care about the result
+ * @user_data: The data to pass to @callback
+ *
+ * Asynchronously flushes @connection, that is, writes all queued
+ * outgoing message to the transport and then flushes the transport
+ * (using g_output_stream_flush_async()). This is useful in programs
+ * that wants to emit a D-Bus signal and then exit immediately. Without
+ * flushing the connection, there is no guaranteed that the message has
+ * been sent to the networking buffers in the OS kernel.
+ *
+ * This is an asynchronous method. When the operation is finished,
+ * @callback will be invoked in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread you are calling this method from. You can
+ * then call g_dbus_connection_flush_finish() to get the result of the
+ * operation. See g_dbus_connection_flush_sync() for the synchronous
+ * version.
+ *
+ * Since: 2.26
+ */
+void
+g_dbus_connection_flush (GDBusConnection *connection,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
- EmitClosedData *data = user_data;
- gboolean result;
+ GSimpleAsyncResult *simple;
- g_object_notify (G_OBJECT (data->connection), "closed");
- g_signal_emit (data->connection,
- signals[CLOSED_SIGNAL],
- 0,
- data->remote_peer_vanished,
- data->error,
- &result);
- return FALSE;
+ g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
+
+ simple = g_simple_async_result_new (G_OBJECT (connection),
+ callback,
+ user_data,
+ g_dbus_connection_flush);
+ g_simple_async_result_set_check_cancellable (simple, cancellable);
+ g_simple_async_result_run_in_thread (simple,
+ flush_in_thread_func,
+ G_PRIORITY_DEFAULT,
+ cancellable);
+ g_object_unref (simple);
}
-/* Can be called from any thread, must hold lock */
+/**
+ * g_dbus_connection_flush_finish:
+ * @connection: a #GDBusConnection
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
+ * to g_dbus_connection_flush()
+ * @error: return location for error or %NULL
+ *
+ * Finishes an operation started with g_dbus_connection_flush().
+ *
+ * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
+ *
+ * Since: 2.26
+ */
+gboolean
+g_dbus_connection_flush_finish (GDBusConnection *connection,
+ GAsyncResult *res,
+ GError **error)
+{
+ GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
+ gboolean ret;
+
+ ret = FALSE;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
+ g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
+
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_flush);
+
+ if (g_simple_async_result_propagate_error (simple, error))
+ goto out;
+
+ ret = TRUE;
+
+ out:
+ return ret;
+}
+
+/**
+ * g_dbus_connection_flush_sync:
+ * @connection: a #GDBusConnection
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
+ *
+ * Synchronously flushes @connection. The calling thread is blocked
+ * until this is done. See g_dbus_connection_flush() for the
+ * asynchronous version of this method and more details about what it
+ * does.
+ *
+ * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
+ *
+ * Since: 2.26
+ */
+gboolean
+g_dbus_connection_flush_sync (GDBusConnection *connection,
+ GCancellable *cancellable,
+ GError **error)
+{
+ gboolean ret;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
+
+ ret = FALSE;
+
+ /* This is only a best-effort attempt to see whether the connection is
+ * closed, so it doesn't need the lock. If the connection closes just
+ * after this check, but before scheduling the flush operation, the
+ * result will be more or less the same as if the connection closed while
+ * the flush operation was pending - it'll fail with either CLOSED or
+ * CANCELLED.
+ */
+ if (!check_unclosed (connection, 0, error))
+ goto out;
+
+ g_assert (connection->worker != NULL);
+
+ ret = _g_dbus_worker_flush_sync (connection->worker,
+ cancellable,
+ error);
+
+ out:
+ return ret;
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
+typedef struct
+{
+ GDBusConnection *connection;
+ GError *error;
+ gboolean remote_peer_vanished;
+} EmitClosedData;
+
+static void
+emit_closed_data_free (EmitClosedData *data)
+{
+ g_object_unref (data->connection);
+ if (data->error != NULL)
+ g_error_free (data->error);
+ g_free (data);
+}
+
+/* Called in a user thread that has acquired the main context that was
+ * thread-default when the object was constructed
+ */
+static gboolean
+emit_closed_in_idle (gpointer user_data)
+{
+ EmitClosedData *data = user_data;
+ gboolean result;
+
+ g_object_notify (G_OBJECT (data->connection), "closed");
+ g_signal_emit (data->connection,
+ signals[CLOSED_SIGNAL],
+ 0,
+ data->remote_peer_vanished,
+ data->error,
+ &result);
+ return FALSE;
+}
+
+/* Can be called from any thread, must hold lock.
+ * FLAG_CLOSED must already have been set.
+ */
static void
-set_closed_unlocked (GDBusConnection *connection,
- gboolean remote_peer_vanished,
- GError *error)
+schedule_closed_unlocked (GDBusConnection *connection,
+ gboolean remote_peer_vanished,
+ GError *error)
{
GSource *idle_source;
EmitClosedData *data;
CONNECTION_ENSURE_LOCK (connection);
- g_assert (!connection->priv->closed);
-
- connection->priv->closed = TRUE;
-
data = g_new0 (EmitClosedData, 1);
data->connection = g_object_ref (connection);
data->remote_peer_vanished = remote_peer_vanished;
emit_closed_in_idle,
data,
(GDestroyNotify) emit_closed_data_free);
- g_source_attach (idle_source, connection->priv->main_context_at_construction);
+ g_source_set_name (idle_source, "[gio] emit_closed_in_idle");
+ g_source_attach (idle_source, connection->main_context_at_construction);
g_source_unref (idle_source);
}
/**
* g_dbus_connection_close:
- * @connection: A #GDBusConnection.
+ * @connection: a #GDBusConnection
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
+ * satisfied or %NULL if you don't care about the result
+ * @user_data: The data to pass to @callback
*
* Closes @connection. Note that this never causes the process to
* exit (this might only happen if the other end of a shared message
- * bus connection disconnects).
+ * bus connection disconnects, see #GDBusConnection:exit-on-close).
+ *
+ * Once the connection is closed, operations such as sending a message
+ * will return with the error %G_IO_ERROR_CLOSED. Closing a connection
+ * will not automatically flush the connection so queued messages may
+ * be lost. Use g_dbus_connection_flush() if you need such guarantees.
*
- * If @connection is already closed, this method does nothing.
+ * If @connection is already closed, this method fails with
+ * %G_IO_ERROR_CLOSED.
+ *
+ * When @connection has been closed, the #GDBusConnection::closed
+ * signal is emitted in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread that @connection was constructed in.
+ *
+ * This is an asynchronous method. When the operation is finished,
+ * @callback will be invoked in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread you are calling this method from. You can
+ * then call g_dbus_connection_close_finish() to get the result of the
+ * operation. See g_dbus_connection_close_sync() for the synchronous
+ * version.
+ *
+ * Since: 2.26
*/
void
-g_dbus_connection_close (GDBusConnection *connection)
+g_dbus_connection_close (GDBusConnection *connection,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
+ GSimpleAsyncResult *simple;
+
g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
+ /* do not use g_return_val_if_fail(), we want the memory barrier */
+ if (!check_initialized (connection))
+ return;
+
+ g_assert (connection->worker != NULL);
+
+ simple = g_simple_async_result_new (G_OBJECT (connection),
+ callback,
+ user_data,
+ g_dbus_connection_close);
+ g_simple_async_result_set_check_cancellable (simple, cancellable);
+ _g_dbus_worker_close (connection->worker, cancellable, simple);
+ g_object_unref (simple);
+}
+
+/**
+ * g_dbus_connection_close_finish:
+ * @connection: a #GDBusConnection
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
+ * to g_dbus_connection_close()
+ * @error: return location for error or %NULL
+ *
+ * Finishes an operation started with g_dbus_connection_close().
+ *
+ * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
+ *
+ * Since: 2.26
+ */
+gboolean
+g_dbus_connection_close_finish (GDBusConnection *connection,
+ GAsyncResult *res,
+ GError **error)
+{
+ GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
+ gboolean ret;
+
+ ret = FALSE;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
+ g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
+
+ g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_dbus_connection_close);
+
+ if (g_simple_async_result_propagate_error (simple, error))
+ goto out;
+
+ ret = TRUE;
+
+ out:
+ return ret;
+}
+
+typedef struct {
+ GMainLoop *loop;
+ GAsyncResult *result;
+} SyncCloseData;
+
+/* Can be called by any thread, without the connection lock */
+static void
+sync_close_cb (GObject *source_object,
+ GAsyncResult *res,
+ gpointer user_data)
+{
+ SyncCloseData *data = user_data;
+
+ data->result = g_object_ref (res);
+ g_main_loop_quit (data->loop);
+}
+
+/**
+ * g_dbus_connection_close_sync:
+ * @connection: a #GDBusConnection
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
+ *
+ * Synchronously closees @connection. The calling thread is blocked
+ * until this is done. See g_dbus_connection_close() for the
+ * asynchronous version of this method and more details about what it
+ * does.
+ *
+ * Returns: %TRUE if the operation succeeded, %FALSE if @error is set
+ *
+ * Since: 2.26
+ */
+gboolean
+g_dbus_connection_close_sync (GDBusConnection *connection,
+ GCancellable *cancellable,
+ GError **error)
+{
+ gboolean ret;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
+
+ ret = FALSE;
+
+ if (check_unclosed (connection, 0, error))
+ {
+ GMainContext *context;
+ SyncCloseData data;
+
+ context = g_main_context_new ();
+ g_main_context_push_thread_default (context);
+ data.loop = g_main_loop_new (context, TRUE);
+ data.result = NULL;
+
+ g_dbus_connection_close (connection, cancellable, sync_close_cb, &data);
+ g_main_loop_run (data.loop);
+ ret = g_dbus_connection_close_finish (connection, data.result, error);
+
+ g_object_unref (data.result);
+ g_main_loop_unref (data.loop);
+ g_main_context_pop_thread_default (context);
+ g_main_context_unref (context);
+ }
+
+ return ret;
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
+/**
+ * g_dbus_connection_get_last_serial:
+ * @connection: a #GDBusConnection
+ *
+ * Retrieves the last serial number assigned to a #GDBusMessage on
+ * the current thread. This includes messages sent via both low-level
+ * API such as g_dbus_connection_send_message() as well as
+ * high-level API such as g_dbus_connection_emit_signal(),
+ * g_dbus_connection_call() or g_dbus_proxy_call().
+ *
+ * Returns: the last used serial or zero when no message has been sent
+ * within the current thread
+ *
+ * Since: 2.34
+ */
+guint32
+g_dbus_connection_get_last_serial (GDBusConnection *connection)
+{
+ guint32 ret;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
+
CONNECTION_LOCK (connection);
- if (!connection->priv->closed)
- {
- GError *error = NULL;
-
- /* TODO: do this async */
- //g_debug ("closing connection %p's stream %p", connection, connection->priv->stream);
- if (!g_io_stream_close (connection->priv->stream, NULL, &error))
- {
- g_warning ("Error closing stream: %s", error->message);
- g_error_free (error);
- }
-
- set_closed_unlocked (connection, FALSE, NULL);
- }
+ ret = GPOINTER_TO_UINT (g_hash_table_lookup (connection->map_thread_to_last_serial,
+ g_thread_self ()));
CONNECTION_UNLOCK (connection);
+
+ return ret;
}
/* ---------------------------------------------------------------------------------------------------- */
+/* Can be called by any thread, with the connection lock held */
static gboolean
-g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
- GDBusMessage *message,
- volatile guint32 *out_serial,
- GError **error)
+g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
+ GDBusMessage *message,
+ GDBusSendMessageFlags flags,
+ volatile guint32 *out_serial,
+ GError **error)
{
guchar *blob;
gsize blob_size;
if (out_serial != NULL)
*out_serial = 0;
- if (connection->priv->closed)
- {
- g_set_error_literal (error,
- G_IO_ERROR,
- G_IO_ERROR_CLOSED,
- _("The connection is closed"));
- goto out;
- }
+ /* If we're in initable_init(), don't check for being initialized, to avoid
+ * chicken-and-egg problems. initable_init() is responsible for setting up
+ * our prerequisites (mainly connection->worker), and only calling us
+ * from its own thread (so no memory barrier is needed).
+ */
+ if (!check_unclosed (connection,
+ (flags & SEND_MESSAGE_FLAGS_INITIALIZING) ? MAY_BE_UNINITIALIZED : 0,
+ error))
+ goto out;
blob = g_dbus_message_to_blob (message,
&blob_size,
+ connection->capabilities,
error);
if (blob == NULL)
goto out;
- serial_to_use = ++connection->priv->last_serial; /* TODO: handle overflow */
+ if (flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL)
+ serial_to_use = g_dbus_message_get_serial (message);
+ else
+ serial_to_use = ++connection->last_serial; /* TODO: handle overflow */
switch (blob[0])
{
g_printerr ("----\n");
#endif
- /* TODO: use connection->priv->auth to encode the blob */
+ /* TODO: use connection->auth to encode the blob */
if (out_serial != NULL)
- {
- *out_serial = serial_to_use;
- }
- g_dbus_message_set_serial (message, serial_to_use);
+ *out_serial = serial_to_use;
+
+ /* store used serial for the current thread */
+ /* TODO: watch the thread disposal and remove associated record
+ * from hashtable
+ * - see https://bugzilla.gnome.org/show_bug.cgi?id=676825#c7
+ */
+ g_hash_table_replace (connection->map_thread_to_last_serial,
+ g_thread_self (),
+ GUINT_TO_POINTER (serial_to_use));
+
+ if (!(flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL))
+ g_dbus_message_set_serial (message, serial_to_use);
- _g_dbus_worker_send_message (connection->priv->worker,
+ g_dbus_message_lock (message);
+ _g_dbus_worker_send_message (connection->worker,
message,
(gchar*) blob,
blob_size);
/**
* g_dbus_connection_send_message:
- * @connection: A #GDBusConnection.
- * @message: A #GDBusMessage
- * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
- * @error: Return location for error or %NULL.
+ * @connection: a #GDBusConnection
+ * @message: a #GDBusMessage
+ * @flags: flags affecting how the message is sent
+ * @out_serial: (out) (allow-none): return location for serial number assigned
+ * to @message when sending it or %NULL
+ * @error: Return location for error or %NULL
*
* Asynchronously sends @message to the peer represented by @connection.
*
- * If @out_serial is not %NULL, then the serial number assigned to
- * @message by @connection will be written to this location prior to
+ * Unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
+ * will be assigned by @connection and set on @message via
+ * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
+ * serial number used will be written to this location prior to
* submitting the message to the underlying transport.
*
* If @connection is closed then the operation will fail with
- * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
- * fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
+ * %G_IO_ERROR_CLOSED. If @message is not well-formed,
* the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
*
- * See <xref linkend="gdbus-server"/> and <xref
- * linkend="gdbus-unix-fd-client"/> for an example of how to use this
- * low-level API to send and receive UNIX file descriptors.
+ * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
+ * for an example of how to use this low-level API to send and receive
+ * UNIX file descriptors.
+ *
+ * Note that @message must be unlocked, unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
*
* Returns: %TRUE if the message was well-formed and queued for
- * transmission, %FALSE if @error is set.
+ * transmission, %FALSE if @error is set
+ *
+ * Since: 2.26
*/
gboolean
-g_dbus_connection_send_message (GDBusConnection *connection,
- GDBusMessage *message,
- volatile guint32 *out_serial,
- GError **error)
+g_dbus_connection_send_message (GDBusConnection *connection,
+ GDBusMessage *message,
+ GDBusSendMessageFlags flags,
+ volatile guint32 *out_serial,
+ GError **error)
{
gboolean ret;
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
+ g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), FALSE);
g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
CONNECTION_LOCK (connection);
- ret = g_dbus_connection_send_message_unlocked (connection, message, out_serial, error);
+ ret = g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, error);
CONNECTION_UNLOCK (connection);
return ret;
}
gboolean delivered;
} SendMessageData;
+/* Can be called from any thread with or without lock held */
static SendMessageData *
send_message_data_ref (SendMessageData *data)
{
return data;
}
+/* Can be called from any thread with or without lock held */
static void
send_message_data_unref (SendMessageData *data)
{
g_object_unref (data->connection);
if (data->cancellable != NULL)
g_object_unref (data->cancellable);
- if (data->main_context != NULL)
- g_main_context_unref (data->main_context);
+ g_main_context_unref (data->main_context);
g_free (data);
}
}
/* can be called from any thread with lock held - caller must have prepared GSimpleAsyncResult already */
static void
-send_message_with_reply_deliver (SendMessageData *data)
+send_message_with_reply_deliver (SendMessageData *data, gboolean remove)
{
CONNECTION_ENSURE_LOCK (data->connection);
data->cancellable_handler_id = 0;
}
- g_warn_if_fail (g_hash_table_remove (data->connection->priv->map_method_serial_to_send_message_data,
- GUINT_TO_POINTER (data->serial)));
+ if (remove)
+ {
+ g_warn_if_fail (g_hash_table_remove (data->connection->map_method_serial_to_send_message_data,
+ GUINT_TO_POINTER (data->serial)));
+ }
send_message_data_unref (data);
}
/* ---------------------------------------------------------------------------------------------------- */
-/* must hold lock */
+/* Can be called from any thread with lock held */
static void
send_message_data_deliver_reply_unlocked (SendMessageData *data,
GDBusMessage *reply)
g_object_ref (reply),
g_object_unref);
- send_message_with_reply_deliver (data);
+ send_message_with_reply_deliver (data, TRUE);
out:
;
/* ---------------------------------------------------------------------------------------------------- */
+/* Called from a user thread, lock is not held */
static gboolean
send_message_with_reply_cancelled_idle_cb (gpointer user_data)
{
G_IO_ERROR_CANCELLED,
_("Operation was cancelled"));
- send_message_with_reply_deliver (data);
+ send_message_with_reply_deliver (data, TRUE);
out:
CONNECTION_UNLOCK (data->connection);
send_message_with_reply_cancelled_idle_cb,
send_message_data_ref (data),
(GDestroyNotify) send_message_data_unref);
+ g_source_set_name (idle_source, "[gio] send_message_with_reply_cancelled_idle_cb");
g_source_attach (idle_source, data->main_context);
g_source_unref (idle_source);
}
/* ---------------------------------------------------------------------------------------------------- */
+/* Called from a user thread, lock is not held */
static gboolean
send_message_with_reply_timeout_cb (gpointer user_data)
{
G_IO_ERROR_TIMED_OUT,
_("Timeout was reached"));
- send_message_with_reply_deliver (data);
+ send_message_with_reply_deliver (data, TRUE);
out:
CONNECTION_UNLOCK (data->connection);
/* ---------------------------------------------------------------------------------------------------- */
+/* Called from a user thread, connection's lock is held */
static void
g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connection,
GDBusMessage *message,
+ GDBusSendMessageFlags flags,
gint timeout_msec,
volatile guint32 *out_serial,
GCancellable *cancellable,
out_serial = &serial;
if (timeout_msec == -1)
- timeout_msec = 30 * 1000; /* TODO: check 30 secs is the default timeout */
+ timeout_msec = 25 * 1000;
simple = g_simple_async_result_new (G_OBJECT (connection),
callback,
user_data,
g_dbus_connection_send_message_with_reply);
+ g_simple_async_result_set_check_cancellable (simple, cancellable);
if (g_cancellable_is_cancelled (cancellable))
{
goto out;
}
- if (connection->priv->closed)
- {
- g_simple_async_result_set_error (simple,
- G_IO_ERROR,
- G_IO_ERROR_CLOSED,
- _("The connection is closed"));
- g_simple_async_result_complete_in_idle (simple);
- g_object_unref (simple);
- goto out;
- }
-
error = NULL;
- if (!g_dbus_connection_send_message_unlocked (connection, message, out_serial, &error))
+ if (!g_dbus_connection_send_message_unlocked (connection, message, flags, out_serial, &error))
{
- g_simple_async_result_set_from_error (simple, error);
+ g_simple_async_result_take_error (simple, error);
g_simple_async_result_complete_in_idle (simple);
g_object_unref (simple);
goto out;
data->connection = g_object_ref (connection);
data->simple = simple;
data->serial = *out_serial;
- data->main_context = g_main_context_get_thread_default ();
- if (data->main_context != NULL)
- g_main_context_ref (data->main_context);
+ data->main_context = g_main_context_ref_thread_default ();
if (cancellable != NULL)
{
G_CALLBACK (send_message_with_reply_cancelled_cb),
send_message_data_ref (data),
(GDestroyNotify) send_message_data_unref);
- g_object_set_data_full (G_OBJECT (simple),
- "cancellable",
- g_object_ref (cancellable),
- (GDestroyNotify) g_object_unref);
}
- data->timeout_source = g_timeout_source_new (timeout_msec);
- g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
- g_source_set_callback (data->timeout_source,
- send_message_with_reply_timeout_cb,
- send_message_data_ref (data),
- (GDestroyNotify) send_message_data_unref);
- g_source_attach (data->timeout_source, data->main_context);
- g_source_unref (data->timeout_source);
+ if (timeout_msec != G_MAXINT)
+ {
+ data->timeout_source = g_timeout_source_new (timeout_msec);
+ g_source_set_priority (data->timeout_source, G_PRIORITY_DEFAULT);
+ g_source_set_callback (data->timeout_source,
+ send_message_with_reply_timeout_cb,
+ send_message_data_ref (data),
+ (GDestroyNotify) send_message_data_unref);
+ g_source_attach (data->timeout_source, data->main_context);
+ g_source_unref (data->timeout_source);
+ }
- g_hash_table_insert (connection->priv->map_method_serial_to_send_message_data,
+ g_hash_table_insert (connection->map_method_serial_to_send_message_data,
GUINT_TO_POINTER (*out_serial),
data);
/**
* g_dbus_connection_send_message_with_reply:
- * @connection: A #GDBusConnection.
- * @message: A #GDBusMessage.
- * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
- * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
- * @cancellable: A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
- * care about the result.
- * @user_data: The data to pass to @callback.
+ * @connection: a #GDBusConnection
+ * @message: a #GDBusMessage
+ * @flags: flags affecting how the message is sent
+ * @timeout_msec: the timeout in milliseconds, -1 to use the default
+ * timeout or %G_MAXINT for no timeout
+ * @out_serial: (out) (allow-none): return location for serial number assigned
+ * to @message when sending it or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
+ * is satisfied or %NULL if you don't care about the result
+ * @user_data: The data to pass to @callback
*
* Asynchronously sends @message to the peer represented by @connection.
*
- * If @out_serial is not %NULL, then the serial number assigned to
- * @message by @connection will be written to this location prior to
+ * Unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
+ * will be assigned by @connection and set on @message via
+ * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
+ * serial number used will be written to this location prior to
* submitting the message to the underlying transport.
*
* If @connection is closed then the operation will fail with
* fail with %G_IO_ERROR_CANCELLED. If @message is not well-formed,
* the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
*
- * This is an asynchronous method. When the operation is finished, @callback will be invoked
- * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
+ * This is an asynchronous method. When the operation is finished, @callback
+ * will be invoked in the
+ * [thread-default main context][g-main-context-push-thread-default]
* of the thread you are calling this method from. You can then call
* g_dbus_connection_send_message_with_reply_finish() to get the result of the operation.
* See g_dbus_connection_send_message_with_reply_sync() for the synchronous version.
*
- * See <xref linkend="gdbus-server"/> and <xref
- * linkend="gdbus-unix-fd-client"/> for an example of how to use this
- * low-level API to send and receive UNIX file descriptors.
+ * Note that @message must be unlocked, unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
+ *
+ * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
+ * for an example of how to use this low-level API to send and receive
+ * UNIX file descriptors.
+ *
+ * Since: 2.26
*/
void
-g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
- GDBusMessage *message,
- gint timeout_msec,
- volatile guint32 *out_serial,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
+ GDBusMessage *message,
+ GDBusSendMessageFlags flags,
+ gint timeout_msec,
+ volatile guint32 *out_serial,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
g_return_if_fail (G_IS_DBUS_MESSAGE (message));
+ g_return_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message));
g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
CONNECTION_LOCK (connection);
g_dbus_connection_send_message_with_reply_unlocked (connection,
message,
+ flags,
timeout_msec,
out_serial,
cancellable,
/**
* g_dbus_connection_send_message_with_reply_finish:
- * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
- * @error: Return location for error or %NULL.
+ * @connection: a #GDBusConnection
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ * g_dbus_connection_send_message_with_reply()
+ * @error: teturn location for error or %NULL
*
* Finishes an operation started with g_dbus_connection_send_message_with_reply().
*
* Note that @error is only set if a local in-process error
- * occured. That is to say that the returned #GDBusMessage object may
+ * occurred. That is to say that the returned #GDBusMessage object may
* be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
* g_dbus_message_to_gerror() to transcode this to a #GError.
*
- * See <xref linkend="gdbus-server"/> and <xref
- * linkend="gdbus-unix-fd-client"/> for an example of how to use this
- * low-level API to send and receive UNIX file descriptors.
+ * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
+ * for an example of how to use this low-level API to send and receive
+ * UNIX file descriptors.
+ *
+ * Returns: (transfer full): a locked #GDBusMessage or %NULL if @error is set
*
- * Returns: A #GDBusMessage or %NULL if @error is set.
+ * Since: 2.26
*/
GDBusMessage *
-g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
- GAsyncResult *res,
- GError **error)
+g_dbus_connection_send_message_with_reply_finish (GDBusConnection *connection,
+ GAsyncResult *res,
+ GError **error)
{
GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
GDBusMessage *reply;
- GCancellable *cancellable;
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
g_return_val_if_fail (error == NULL || *error == NULL, NULL);
goto out;
reply = g_object_ref (g_simple_async_result_get_op_res_gpointer (simple));
- cancellable = g_object_get_data (G_OBJECT (simple), "cancellable");
- if (cancellable != NULL && g_cancellable_is_cancelled (cancellable))
- {
- g_object_unref (reply);
- reply = NULL;
- g_set_error_literal (error,
- G_IO_ERROR,
- G_IO_ERROR_CANCELLED,
- _("Operation was cancelled"));
- }
+
out:
return reply;
}
GMainLoop *loop;
} SendMessageSyncData;
+/* Called from a user thread, lock is not held */
static void
send_message_with_reply_sync_cb (GDBusConnection *connection,
GAsyncResult *res,
/**
* g_dbus_connection_send_message_with_reply_sync:
- * @connection: A #GDBusConnection.
- * @message: A #GDBusMessage.
- * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
- * @out_serial: Return location for serial number assigned to @message when sending it or %NULL.
- * @cancellable: A #GCancellable or %NULL.
- * @error: Return location for error or %NULL.
+ * @connection: a #GDBusConnection
+ * @message: a #GDBusMessage
+ * @flags: flags affecting how the message is sent.
+ * @timeout_msec: the timeout in milliseconds, -1 to use the default
+ * timeout or %G_MAXINT for no timeout
+ * @out_serial: (out) (allow-none): return location for serial number
+ * assigned to @message when sending it or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
*
* Synchronously sends @message to the peer represented by @connection
* and blocks the calling thread until a reply is received or the
* timeout is reached. See g_dbus_connection_send_message_with_reply()
* for the asynchronous version of this method.
*
- * If @out_serial is not %NULL, then the serial number assigned to
- * @message by @connection will be written to this location prior to
+ * Unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number
+ * will be assigned by @connection and set on @message via
+ * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the
+ * serial number used will be written to this location prior to
* submitting the message to the underlying transport.
*
* If @connection is closed then the operation will fail with
* the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.
*
* Note that @error is only set if a local in-process error
- * occured. That is to say that the returned #GDBusMessage object may
+ * occurred. That is to say that the returned #GDBusMessage object may
* be of type %G_DBUS_MESSAGE_TYPE_ERROR. Use
* g_dbus_message_to_gerror() to transcode this to a #GError.
*
- * See <xref linkend="gdbus-server"/> and <xref
- * linkend="gdbus-unix-fd-client"/> for an example of how to use this
- * low-level API to send and receive UNIX file descriptors.
+ * See this [server][gdbus-server] and [client][gdbus-unix-fd-client]
+ * for an example of how to use this low-level API to send and receive
+ * UNIX file descriptors.
+ *
+ * Note that @message must be unlocked, unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
*
- * Returns: A #GDBusMessage that is the reply to @message or %NULL if @error is set.
+ * Returns: (transfer full): a locked #GDBusMessage that is the reply
+ * to @message or %NULL if @error is set
+ *
+ * Since: 2.26
*/
GDBusMessage *
-g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
- GDBusMessage *message,
- gint timeout_msec,
- volatile guint32 *out_serial,
- GCancellable *cancellable,
- GError **error)
+g_dbus_connection_send_message_with_reply_sync (GDBusConnection *connection,
+ GDBusMessage *message,
+ GDBusSendMessageFlags flags,
+ gint timeout_msec,
+ volatile guint32 *out_serial,
+ GCancellable *cancellable,
+ GError **error)
{
SendMessageSyncData *data;
GDBusMessage *reply;
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
+ g_return_val_if_fail ((flags & G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL) || !g_dbus_message_get_locked (message), NULL);
g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
g_return_val_if_fail (error == NULL || *error == NULL, NULL);
g_dbus_connection_send_message_with_reply (connection,
message,
+ flags,
timeout_msec,
out_serial,
cancellable,
GDestroyNotify user_data_free_func;
} FilterData;
-/* Called in worker's thread - we must not block */
+/* Called in GDBusWorker's thread - we must not block - with no lock held */
static void
on_worker_message_received (GDBusWorker *worker,
GDBusMessage *message,
gpointer user_data)
{
- GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
+ GDBusConnection *connection;
FilterCallback *filters;
- gboolean consumed_by_filter;
guint num_filters;
guint n;
+ gboolean alive;
+
+ G_LOCK (message_bus_lock);
+ alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
+ if (!alive)
+ {
+ G_UNLOCK (message_bus_lock);
+ return;
+ }
+ connection = G_DBUS_CONNECTION (user_data);
+ g_object_ref (connection);
+ G_UNLOCK (message_bus_lock);
//g_debug ("in on_worker_message_received");
- g_object_ref (connection);
+ g_object_ref (message);
+ g_dbus_message_lock (message);
+
+ //g_debug ("boo ref_count = %d %p %p", G_OBJECT (connection)->ref_count, connection, connection->worker);
/* First collect the set of callback functions */
CONNECTION_LOCK (connection);
- num_filters = connection->priv->filters->len;
+ num_filters = connection->filters->len;
filters = g_new0 (FilterCallback, num_filters);
for (n = 0; n < num_filters; n++)
{
- FilterData *data = connection->priv->filters->pdata[n];
+ FilterData *data = connection->filters->pdata[n];
filters[n].func = data->filter_function;
filters[n].user_data = data->user_data;
}
CONNECTION_UNLOCK (connection);
- /* the call the filters in order (without holding the lock) */
- consumed_by_filter = FALSE;
+ /* then call the filters in order (without holding the lock) */
for (n = 0; n < num_filters; n++)
{
- consumed_by_filter = filters[n].func (connection,
- message,
- filters[n].user_data);
- if (consumed_by_filter)
+ message = filters[n].func (connection,
+ message,
+ TRUE,
+ filters[n].user_data);
+ if (message == NULL)
break;
+ g_dbus_message_lock (message);
}
- /* Standard dispatch unless the filter ate the message */
- if (!consumed_by_filter)
+ /* Standard dispatch unless the filter ate the message - no need to
+ * do anything if the message was altered
+ */
+ if (message != NULL)
{
GDBusMessageType message_type;
- message_type = g_dbus_message_get_type (message);
+ message_type = g_dbus_message_get_message_type (message);
if (message_type == G_DBUS_MESSAGE_TYPE_METHOD_RETURN || message_type == G_DBUS_MESSAGE_TYPE_ERROR)
{
guint32 reply_serial;
reply_serial = g_dbus_message_get_reply_serial (message);
CONNECTION_LOCK (connection);
- send_message_data = g_hash_table_lookup (connection->priv->map_method_serial_to_send_message_data,
+ send_message_data = g_hash_table_lookup (connection->map_method_serial_to_send_message_data,
GUINT_TO_POINTER (reply_serial));
if (send_message_data != NULL)
{
}
}
+ if (message != NULL)
+ g_object_unref (message);
g_object_unref (connection);
g_free (filters);
}
-/* Called in worker's thread - we must not block */
-static void
-on_worker_closed (GDBusWorker *worker,
- gboolean remote_peer_vanished,
- GError *error,
- gpointer user_data)
+/* Called in GDBusWorker's thread, lock is not held */
+static GDBusMessage *
+on_worker_message_about_to_be_sent (GDBusWorker *worker,
+ GDBusMessage *message,
+ gpointer user_data)
{
- GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
+ GDBusConnection *connection;
+ FilterCallback *filters;
+ guint num_filters;
+ guint n;
+ gboolean alive;
- //g_debug ("in on_worker_closed: %s", error->message);
+ G_LOCK (message_bus_lock);
+ alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
+ if (!alive)
+ {
+ G_UNLOCK (message_bus_lock);
+ return message;
+ }
+ connection = G_DBUS_CONNECTION (user_data);
+ g_object_ref (connection);
+ G_UNLOCK (message_bus_lock);
+
+ //g_debug ("in on_worker_message_about_to_be_sent");
+ /* First collect the set of callback functions */
CONNECTION_LOCK (connection);
- if (!connection->priv->closed)
- set_closed_unlocked (connection, remote_peer_vanished, error);
+ num_filters = connection->filters->len;
+ filters = g_new0 (FilterCallback, num_filters);
+ for (n = 0; n < num_filters; n++)
+ {
+ FilterData *data = connection->filters->pdata[n];
+ filters[n].func = data->filter_function;
+ filters[n].user_data = data->user_data;
+ }
CONNECTION_UNLOCK (connection);
-}
-/* ---------------------------------------------------------------------------------------------------- */
-
-/* Determines the biggest set of capabilities we can support on this connection */
-static GDBusCapabilityFlags
-get_offered_capabilities_max (GDBusConnection *connection)
+ /* then call the filters in order (without holding the lock) */
+ for (n = 0; n < num_filters; n++)
+ {
+ g_dbus_message_lock (message);
+ message = filters[n].func (connection,
+ message,
+ FALSE,
+ filters[n].user_data);
+ if (message == NULL)
+ break;
+ }
+
+ g_object_unref (connection);
+ g_free (filters);
+
+ return message;
+}
+
+/* called with connection lock held, in GDBusWorker thread */
+static gboolean
+cancel_method_on_close (gpointer key, gpointer value, gpointer user_data)
+{
+ SendMessageData *data = value;
+
+ if (data->delivered)
+ return FALSE;
+
+ g_simple_async_result_set_error (data->simple,
+ G_IO_ERROR,
+ G_IO_ERROR_CLOSED,
+ _("The connection is closed"));
+
+ /* Ask send_message_with_reply_deliver not to remove the element from the
+ * hash table - we're in the middle of a foreach; that would be unsafe.
+ * Instead, return TRUE from this function so that it gets removed safely.
+ */
+ send_message_with_reply_deliver (data, FALSE);
+ return TRUE;
+}
+
+/* Called in GDBusWorker's thread - we must not block - without lock held */
+static void
+on_worker_closed (GDBusWorker *worker,
+ gboolean remote_peer_vanished,
+ GError *error,
+ gpointer user_data)
+{
+ GDBusConnection *connection;
+ gboolean alive;
+ guint old_atomic_flags;
+
+ G_LOCK (message_bus_lock);
+ alive = (g_hash_table_lookup (alive_connections, user_data) != NULL);
+ if (!alive)
+ {
+ G_UNLOCK (message_bus_lock);
+ return;
+ }
+ connection = G_DBUS_CONNECTION (user_data);
+ g_object_ref (connection);
+ G_UNLOCK (message_bus_lock);
+
+ //g_debug ("in on_worker_closed: %s", error->message);
+
+ CONNECTION_LOCK (connection);
+ /* Even though this is atomic, we do it inside the lock to avoid breaking
+ * assumptions in remove_match_rule(). We'd need the lock in a moment
+ * anyway, so, no loss.
+ */
+ old_atomic_flags = g_atomic_int_or (&connection->atomic_flags, FLAG_CLOSED);
+
+ if (!(old_atomic_flags & FLAG_CLOSED))
+ {
+ g_hash_table_foreach_remove (connection->map_method_serial_to_send_message_data, cancel_method_on_close, NULL);
+ schedule_closed_unlocked (connection, remote_peer_vanished, error);
+ }
+ CONNECTION_UNLOCK (connection);
+
+ g_object_unref (connection);
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
+/* Determines the biggest set of capabilities we can support on this
+ * connection.
+ *
+ * Called with the init_lock held.
+ */
+static GDBusCapabilityFlags
+get_offered_capabilities_max (GDBusConnection *connection)
{
GDBusCapabilityFlags ret;
ret = G_DBUS_CAPABILITY_FLAGS_NONE;
#ifdef G_OS_UNIX
- if (G_IS_UNIX_CONNECTION (connection->priv->stream))
- {
- ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
- }
+ if (G_IS_UNIX_CONNECTION (connection->stream))
+ ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
#endif
return ret;
}
-
+/* Called in a user thread, lock is not held */
static gboolean
-initable_init (GInitable *initable,
- GCancellable *cancellable,
- GError **error)
+initable_init (GInitable *initable,
+ GCancellable *cancellable,
+ GError **error)
{
GDBusConnection *connection = G_DBUS_CONNECTION (initable);
gboolean ret;
* callbacks above needs the lock during initialization (for message
* bus connections we do a synchronous Hello() call on the bus).
*/
- g_mutex_lock (connection->priv->init_lock);
+ g_mutex_lock (&connection->init_lock);
ret = FALSE;
- if (connection->priv->is_initialized)
+ /* Make this a no-op if we're already initialized (successfully or
+ * unsuccessfully)
+ */
+ if ((g_atomic_int_get (&connection->atomic_flags) & FLAG_INITIALIZED))
{
- if (connection->priv->stream != NULL)
- ret = TRUE;
- else
- g_assert (connection->priv->initialization_error != NULL);
+ ret = (connection->initialization_error == NULL);
goto out;
}
- g_assert (connection->priv->initialization_error == NULL);
+
+ /* Because of init_lock, we can't get here twice in different threads */
+ g_assert (connection->initialization_error == NULL);
/* The user can pass multiple (but mutally exclusive) construct
* properties:
* - address (of type gchar*)
*
* At the end of the day we end up with a non-NULL GIOStream
- * object in connection->priv->stream.
+ * object in connection->stream.
*/
- if (connection->priv->address != NULL)
+ if (connection->address != NULL)
{
- g_assert (connection->priv->stream == NULL);
+ g_assert (connection->stream == NULL);
- if ((connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
- (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
+ if ((connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER) ||
+ (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS))
{
- g_set_error_literal (error,
+ g_set_error_literal (&connection->initialization_error,
G_IO_ERROR,
G_IO_ERROR_INVALID_ARGUMENT,
_("Unsupported flags encountered when constructing a client-side connection"));
goto out;
}
- connection->priv->stream = g_dbus_address_get_stream_sync (connection->priv->address,
- NULL, /* TODO: out_guid */
- cancellable,
- &connection->priv->initialization_error);
- if (connection->priv->stream == NULL)
+ connection->stream = g_dbus_address_get_stream_sync (connection->address,
+ NULL, /* TODO: out_guid */
+ cancellable,
+ &connection->initialization_error);
+ if (connection->stream == NULL)
goto out;
}
- else if (connection->priv->stream != NULL)
+ else if (connection->stream != NULL)
{
/* nothing to do */
}
}
/* Authenticate the connection */
- if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
- {
- g_assert (!(connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
- g_assert (connection->priv->guid != NULL);
- connection->priv->auth = _g_dbus_auth_new (connection->priv->stream);
- if (!_g_dbus_auth_run_server (connection->priv->auth,
- connection->priv->authentication_observer,
- connection->priv->guid,
- (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
+ if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER)
+ {
+ g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT));
+ g_assert (connection->guid != NULL);
+ connection->auth = _g_dbus_auth_new (connection->stream);
+ if (!_g_dbus_auth_run_server (connection->auth,
+ connection->authentication_observer,
+ connection->guid,
+ (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS),
get_offered_capabilities_max (connection),
- &connection->priv->capabilities,
- &connection->priv->crendentials,
+ &connection->capabilities,
+ &connection->credentials,
cancellable,
- &connection->priv->initialization_error))
+ &connection->initialization_error))
goto out;
}
- else if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
- {
- g_assert (!(connection->priv->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
- g_assert (connection->priv->guid == NULL);
- connection->priv->auth = _g_dbus_auth_new (connection->priv->stream);
- connection->priv->guid = _g_dbus_auth_run_client (connection->priv->auth,
- get_offered_capabilities_max (connection),
- &connection->priv->capabilities,
- cancellable,
- &connection->priv->initialization_error);
- if (connection->priv->guid == NULL)
+ else if (connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT)
+ {
+ g_assert (!(connection->flags & G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER));
+ g_assert (connection->guid == NULL);
+ connection->auth = _g_dbus_auth_new (connection->stream);
+ connection->guid = _g_dbus_auth_run_client (connection->auth,
+ connection->authentication_observer,
+ get_offered_capabilities_max (connection),
+ &connection->capabilities,
+ cancellable,
+ &connection->initialization_error);
+ if (connection->guid == NULL)
goto out;
}
- if (connection->priv->authentication_observer != NULL)
+ if (connection->authentication_observer != NULL)
{
- g_object_unref (connection->priv->authentication_observer);
- connection->priv->authentication_observer = NULL;
+ g_object_unref (connection->authentication_observer);
+ connection->authentication_observer = NULL;
}
- //g_output_stream_flush (G_SOCKET_CONNECTION (connection->priv->stream)
+ //g_output_stream_flush (G_SOCKET_CONNECTION (connection->stream)
- //g_debug ("haz unix fd passing powers: %d", connection->priv->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
+ //g_debug ("haz unix fd passing powers: %d", connection->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING);
- /* Hack used until
- *
- * https://bugzilla.gnome.org/show_bug.cgi?id=616458
- *
- * has been resolved
+#ifdef G_OS_UNIX
+ /* We want all IO operations to be non-blocking since they happen in
+ * the worker thread which is shared by _all_ connections.
*/
- if (G_IS_SOCKET_CONNECTION (connection->priv->stream))
+ if (G_IS_SOCKET_CONNECTION (connection->stream))
{
- g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->priv->stream)), FALSE);
+ g_socket_set_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (connection->stream)), FALSE);
}
+#endif
+
+ G_LOCK (message_bus_lock);
+ if (alive_connections == NULL)
+ alive_connections = g_hash_table_new (g_direct_hash, g_direct_equal);
+ g_hash_table_insert (alive_connections, connection, connection);
+ G_UNLOCK (message_bus_lock);
- connection->priv->worker = _g_dbus_worker_new (connection->priv->stream,
- connection->priv->capabilities,
- on_worker_message_received,
- on_worker_closed,
- connection);
+ connection->worker = _g_dbus_worker_new (connection->stream,
+ connection->capabilities,
+ ((connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) != 0),
+ on_worker_message_received,
+ on_worker_message_about_to_be_sent,
+ on_worker_closed,
+ connection);
- /* if a bus connection, invoke org.freedesktop.DBus.Hello - this is how we're getting a name */
- if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
+ /* if a bus connection, call org.freedesktop.DBus.Hello - this is how we're getting a name */
+ if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
{
GVariant *hello_result;
- const gchar *s;
-
- hello_result = g_dbus_connection_invoke_method_sync (connection,
- "org.freedesktop.DBus", /* name */
- "/org/freedesktop/DBus", /* path */
- "org.freedesktop.DBus", /* interface */
- "Hello",
- NULL, /* parameters */
- G_DBUS_INVOKE_METHOD_FLAGS_NONE,
- -1,
- NULL, /* TODO: cancellable */
- &connection->priv->initialization_error);
+
+ /* we could lift this restriction by adding code in gdbusprivate.c */
+ if (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING)
+ {
+ g_set_error_literal (&connection->initialization_error,
+ G_IO_ERROR,
+ G_IO_ERROR_FAILED,
+ "Cannot use DELAY_MESSAGE_PROCESSING with MESSAGE_BUS_CONNECTION");
+ goto out;
+ }
+
+ hello_result = g_dbus_connection_call_sync (connection,
+ "org.freedesktop.DBus", /* name */
+ "/org/freedesktop/DBus", /* path */
+ "org.freedesktop.DBus", /* interface */
+ "Hello",
+ NULL, /* parameters */
+ G_VARIANT_TYPE ("(s)"),
+ CALL_FLAGS_INITIALIZING,
+ -1,
+ NULL, /* TODO: cancellable */
+ &connection->initialization_error);
if (hello_result == NULL)
goto out;
- g_variant_get (hello_result, "(s)", &s);
- connection->priv->bus_unique_name = g_strdup (s);
+ g_variant_get (hello_result, "(s)", &connection->bus_unique_name);
g_variant_unref (hello_result);
- //g_debug ("unique name is `%s'", connection->priv->bus_unique_name);
+ //g_debug ("unique name is '%s'", connection->bus_unique_name);
}
- connection->priv->is_initialized = TRUE;
-
ret = TRUE;
out:
if (!ret)
{
- g_assert (connection->priv->initialization_error != NULL);
- g_propagate_error (error, g_error_copy (connection->priv->initialization_error));
+ g_assert (connection->initialization_error != NULL);
+ g_propagate_error (error, g_error_copy (connection->initialization_error));
}
- g_mutex_unlock (connection->priv->init_lock);
+ g_atomic_int_or (&connection->atomic_flags, FLAG_INITIALIZED);
+ g_mutex_unlock (&connection->init_lock);
return ret;
}
/* ---------------------------------------------------------------------------------------------------- */
static void
-async_init_thread (GSimpleAsyncResult *res,
- GObject *object,
- GCancellable *cancellable)
-{
- GError *error = NULL;
-
- if (!g_initable_init (G_INITABLE (object), cancellable, &error))
- {
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
- }
-}
-
-static void
-async_initable_init_async (GAsyncInitable *initable,
- gint io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
-{
- GSimpleAsyncResult *res;
-
- g_return_if_fail (G_IS_INITABLE (initable));
-
- res = g_simple_async_result_new (G_OBJECT (initable), callback, user_data,
- async_initable_init_async);
- g_simple_async_result_run_in_thread (res, async_init_thread,
- io_priority, cancellable);
- g_object_unref (res);
-}
-
-static gboolean
-async_initable_init_finish (GAsyncInitable *initable,
- GAsyncResult *res,
- GError **error)
-{
- return TRUE; /* Errors handled by base impl */
-}
-
-static void
async_initable_iface_init (GAsyncInitableIface *async_initable_iface)
{
- /* We basically just want to use GIO's default implementation - though that one is
- * unfortunately broken, see #615111. So we copy-paste a fixed-up version.
- */
- async_initable_iface->init_async = async_initable_init_async;
- async_initable_iface->init_finish = async_initable_init_finish;
+ /* Use default */
}
/* ---------------------------------------------------------------------------------------------------- */
/**
* g_dbus_connection_new:
- * @stream: A #GIOStream.
- * @guid: The GUID to use if a authenticating as a server or %NULL.
- * @flags: Flags describing how to make the connection.
- * @authentication_observer: A #GDBusAuthObserver or %NULL.
- * @cancellable: A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
- * @user_data: The data to pass to @callback.
+ * @stream: a #GIOStream
+ * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
+ * @flags: flags describing how to make the connection
+ * @observer: (allow-none): a #GDBusAuthObserver or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: the data to pass to @callback
*
* Asynchronously sets up a D-Bus connection for exchanging D-Bus messages
* with the end represented by @stream.
*
- * If %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER is set in @flags,
- * @auth_observer (if not %NULL) is used to assist in the client
+ * If @stream is a #GSocketConnection, then the corresponding #GSocket
+ * will be put into non-blocking mode.
+ *
+ * The D-Bus connection will interact with @stream from a worker thread.
+ * As a result, the caller should not interact with @stream after this
+ * method has been called, except by calling g_object_unref() on it.
+ *
+ * If @observer is not %NULL it may be used to control the
* authentication process.
*
* When the operation is finished, @callback will be invoked. You can
* This is a asynchronous failable constructor. See
* g_dbus_connection_new_sync() for the synchronous
* version.
+ *
+ * Since: 2.26
*/
void
-g_dbus_connection_new (GIOStream *stream,
- const gchar *guid,
- GDBusConnectionFlags flags,
- GDBusAuthObserver *authentication_observer,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_dbus_connection_new (GIOStream *stream,
+ const gchar *guid,
+ GDBusConnectionFlags flags,
+ GDBusAuthObserver *observer,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
g_return_if_fail (G_IS_IO_STREAM (stream));
g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
"stream", stream,
"guid", guid,
"flags", flags,
- "authentication-observer", authentication_observer,
+ "authentication-observer", observer,
NULL);
}
/**
* g_dbus_connection_new_finish:
- * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
- * @error: Return location for error or %NULL.
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback
+ * passed to g_dbus_connection_new().
+ * @error: return location for error or %NULL
*
* Finishes an operation started with g_dbus_connection_new().
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * Returns: a #GDBusConnection or %NULL if @error is set. Free
+ * with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
-g_dbus_connection_new_finish (GAsyncResult *res,
- GError **error)
+g_dbus_connection_new_finish (GAsyncResult *res,
+ GError **error)
{
GObject *object;
GObject *source_object;
/**
* g_dbus_connection_new_sync:
- * @stream: A #GIOStream.
- * @guid: The GUID to use if a authenticating as a server or %NULL.
- * @flags: Flags describing how to make the connection.
- * @authentication_observer: A #GDBusAuthObserver or %NULL.
- * @cancellable: A #GCancellable or %NULL.
- * @error: Return location for error or %NULL.
+ * @stream: a #GIOStream
+ * @guid: (allow-none): the GUID to use if a authenticating as a server or %NULL
+ * @flags: flags describing how to make the connection
+ * @observer: (allow-none): a #GDBusAuthObserver or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
*
* Synchronously sets up a D-Bus connection for exchanging D-Bus messages
* with the end represented by @stream.
*
- * If %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER is set in @flags,
- * @auth_observer (if not %NULL) is used to assist in the client
+ * If @stream is a #GSocketConnection, then the corresponding #GSocket
+ * will be put into non-blocking mode.
+ *
+ * The D-Bus connection will interact with @stream from a worker thread.
+ * As a result, the caller should not interact with @stream after this
+ * method has been called, except by calling g_object_unref() on it.
+ *
+ * If @observer is not %NULL it may be used to control the
* authentication process.
*
* This is a synchronous failable constructor. See
* g_dbus_connection_new() for the asynchronous version.
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * Returns: a #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
-g_dbus_connection_new_sync (GIOStream *stream,
- const gchar *guid,
- GDBusConnectionFlags flags,
- GDBusAuthObserver *authentication_observer,
- GCancellable *cancellable,
- GError **error)
+g_dbus_connection_new_sync (GIOStream *stream,
+ const gchar *guid,
+ GDBusConnectionFlags flags,
+ GDBusAuthObserver *observer,
+ GCancellable *cancellable,
+ GError **error)
{
g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
g_return_val_if_fail (error == NULL || *error == NULL, NULL);
"stream", stream,
"guid", guid,
"flags", flags,
- "authentication-observer", authentication_observer,
+ "authentication-observer", observer,
NULL);
}
/**
* g_dbus_connection_new_for_address:
- * @address: A D-Bus address.
- * @flags: Flags describing how to make the connection.
- * @cancellable: A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
- * @user_data: The data to pass to @callback.
+ * @address: a D-Bus address
+ * @flags: flags describing how to make the connection
+ * @observer: (allow-none): a #GDBusAuthObserver or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: the data to pass to @callback
*
* Asynchronously connects and sets up a D-Bus client connection for
* exchanging D-Bus messages with an endpoint specified by @address
* then call g_dbus_connection_new_finish() to get the result of the
* operation.
*
+ * If @observer is not %NULL it may be used to control the
+ * authentication process.
+ *
* This is a asynchronous failable constructor. See
* g_dbus_connection_new_for_address_sync() for the synchronous
* version.
+ *
+ * Since: 2.26
*/
void
-g_dbus_connection_new_for_address (const gchar *address,
- GDBusConnectionFlags flags,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_dbus_connection_new_for_address (const gchar *address,
+ GDBusConnectionFlags flags,
+ GDBusAuthObserver *observer,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
g_return_if_fail (address != NULL);
g_async_initable_new_async (G_TYPE_DBUS_CONNECTION,
user_data,
"address", address,
"flags", flags,
+ "authentication-observer", observer,
NULL);
}
/**
* g_dbus_connection_new_for_address_finish:
- * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new().
- * @error: Return location for error or %NULL.
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
+ * to g_dbus_connection_new()
+ * @error: return location for error or %NULL
*
* Finishes an operation started with g_dbus_connection_new_for_address().
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * Returns: a #GDBusConnection or %NULL if @error is set. Free with
+ * g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
-g_dbus_connection_new_for_address_finish (GAsyncResult *res,
- GError **error)
+g_dbus_connection_new_for_address_finish (GAsyncResult *res,
+ GError **error)
{
GObject *object;
GObject *source_object;
/**
* g_dbus_connection_new_for_address_sync:
- * @address: A D-Bus address.
- * @flags: Flags describing how to make the connection.
- * @cancellable: A #GCancellable or %NULL.
- * @error: Return location for error or %NULL.
+ * @address: a D-Bus address
+ * @flags: flags describing how to make the connection
+ * @observer: (allow-none): a #GDBusAuthObserver or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
*
* Synchronously connects and sets up a D-Bus client connection for
* exchanging D-Bus messages with an endpoint specified by @address
* This is a synchronous failable constructor. See
* g_dbus_connection_new_for_address() for the asynchronous version.
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * If @observer is not %NULL it may be used to control the
+ * authentication process.
+ *
+ * Returns: a #GDBusConnection or %NULL if @error is set. Free with
+ * g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
-g_dbus_connection_new_for_address_sync (const gchar *address,
- GDBusConnectionFlags flags,
- GCancellable *cancellable,
- GError **error)
+g_dbus_connection_new_for_address_sync (const gchar *address,
+ GDBusConnectionFlags flags,
+ GDBusAuthObserver *observer,
+ GCancellable *cancellable,
+ GError **error)
{
g_return_val_if_fail (address != NULL, NULL);
g_return_val_if_fail (error == NULL || *error == NULL, NULL);
error,
"address", address,
"flags", flags,
+ "authentication-observer", observer,
NULL);
}
/**
* g_dbus_connection_set_exit_on_close:
- * @connection: A #GDBusConnection.
- * @exit_on_close: Whether the process should be terminated
- * when @connection is closed by the remote peer.
+ * @connection: a #GDBusConnection
+ * @exit_on_close: whether the process should be terminated
+ * when @connection is closed by the remote peer
*
* Sets whether the process should be terminated when @connection is
* closed by the remote peer. See #GDBusConnection:exit-on-close for
* more details.
+ *
+ * Note that this function should be used with care. Most modern UNIX
+ * desktops tie the notion of a user session the session bus, and expect
+ * all of a users applications to quit when their bus connection goes away.
+ * If you are setting @exit_on_close to %FALSE for the shared session
+ * bus connection, you should make sure that your application exits
+ * when the user session ends.
+ *
+ * Since: 2.26
*/
void
g_dbus_connection_set_exit_on_close (GDBusConnection *connection,
gboolean exit_on_close)
{
g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
- connection->priv->exit_on_close = exit_on_close;
+
+ if (exit_on_close)
+ g_atomic_int_or (&connection->atomic_flags, FLAG_EXIT_ON_CLOSE);
+ else
+ g_atomic_int_and (&connection->atomic_flags, ~FLAG_EXIT_ON_CLOSE);
+
}
/**
* g_dbus_connection_get_exit_on_close:
- * @connection: A #GDBusConnection.
+ * @connection: a #GDBusConnection
*
* Gets whether the process is terminated when @connection is
* closed by the remote peer. See
* #GDBusConnection:exit-on-close for more details.
*
- * Returns: Whether the process is terminated when @connection is
- * closed by the remote peer.
+ * Returns: whether the process is terminated when @connection is
+ * closed by the remote peer
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_get_exit_on_close (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
- return connection->priv->exit_on_close;
+
+ if (g_atomic_int_get (&connection->atomic_flags) & FLAG_EXIT_ON_CLOSE)
+ return TRUE;
+ else
+ return FALSE;
}
/**
* g_dbus_connection_get_guid:
- * @connection: A #GDBusConnection.
+ * @connection: a #GDBusConnection
*
* The GUID of the peer performing the role of server when
* authenticating. See #GDBusConnection:guid for more details.
*
* Returns: The GUID. Do not free this string, it is owned by
- * @connection.
- **/
+ * @connection.
+ *
+ * Since: 2.26
+ */
const gchar *
g_dbus_connection_get_guid (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- return connection->priv->guid;
+ return connection->guid;
}
/**
* g_dbus_connection_get_unique_name:
- * @connection: A #GDBusConnection.
+ * @connection: a #GDBusConnection
*
* Gets the unique name of @connection as assigned by the message
* bus. This can also be used to figure out if @connection is a
* message bus connection.
*
- * Returns: The unique name or %NULL if @connection is not a message
- * bus connection. Do not free this string, it is owned by
- * @connection.
- **/
+ * Returns: the unique name or %NULL if @connection is not a message
+ * bus connection. Do not free this string, it is owned by
+ * @connection.
+ *
+ * Since: 2.26
+ */
const gchar *
g_dbus_connection_get_unique_name (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- return connection->priv->bus_unique_name;
+
+ /* do not use g_return_val_if_fail(), we want the memory barrier */
+ if (!check_initialized (connection))
+ return NULL;
+
+ return connection->bus_unique_name;
}
/**
* g_dbus_connection_get_peer_credentials:
- * @connection: A #GDBusConnection.
+ * @connection: a #GDBusConnection
*
* Gets the credentials of the authenticated peer. This will always
* return %NULL unless @connection acted as a server
* each application is a client. So this method will always return
* %NULL for message bus clients.
*
- * Returns: A #GCredentials or %NULL if not available. Do not free
- * this object, it is owned by @connection.
+ * Returns: (transfer none): a #GCredentials or %NULL if not available.
+ * Do not free this object, it is owned by @connection.
+ *
+ * Since: 2.26
*/
GCredentials *
g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- return connection->priv->crendentials;
+
+ /* do not use g_return_val_if_fail(), we want the memory barrier */
+ if (!check_initialized (connection))
+ return NULL;
+
+ return connection->credentials;
}
/* ---------------------------------------------------------------------------------------------------- */
/**
* g_dbus_connection_add_filter:
- * @connection: A #GDBusConnection.
- * @filter_function: A filter function.
- * @user_data: User data to pass to @filter_function.
- * @user_data_free_func: Function to free @user_data with when filter
- * is removed or %NULL.
+ * @connection: a #GDBusConnection
+ * @filter_function: a filter function
+ * @user_data: user data to pass to @filter_function
+ * @user_data_free_func: function to free @user_data with when filter
+ * is removed or %NULL
*
* Adds a message filter. Filters are handlers that are run on all
- * incoming messages, prior to standard dispatch. Filters are run in
- * the order that they were added. The same handler can be added as a
- * filter more than once, in which case it will be run more than once.
- * Filters added during a filter callback won't be run on the message
- * being processed.
+ * incoming and outgoing messages, prior to standard dispatch. Filters
+ * are run in the order that they were added. The same handler can be
+ * added as a filter more than once, in which case it will be run more
+ * than once. Filters added during a filter callback won't be run on
+ * the message being processed. Filter functions are allowed to modify
+ * and even drop messages.
*
* Note that filters are run in a dedicated message handling thread so
* they can't block and, generally, can't do anything but signal a
* worker thread. Also note that filters are rarely needed - use API
* such as g_dbus_connection_send_message_with_reply(),
- * g_dbus_connection_signal_subscribe() or
- * g_dbus_connection_invoke_method() instead.
+ * g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
+ *
+ * If a filter consumes an incoming message the message is not
+ * dispatched anywhere else - not even the standard dispatch machinery
+ * (that API such as g_dbus_connection_signal_subscribe() and
+ * g_dbus_connection_send_message_with_reply() relies on) will see the
+ * message. Similary, if a filter consumes an outgoing message, the
+ * message will not be sent to the other peer.
+ *
+ * Returns: a filter identifier that can be used with
+ * g_dbus_connection_remove_filter()
*
- * Returns: A filter identifier that can be used with
- * g_dbus_connection_remove_filter().
+ * Since: 2.26
*/
guint
g_dbus_connection_add_filter (GDBusConnection *connection,
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
g_return_val_if_fail (filter_function != NULL, 0);
+ g_return_val_if_fail (check_initialized (connection), 0);
CONNECTION_LOCK (connection);
data = g_new0 (FilterData, 1);
data->filter_function = filter_function;
data->user_data = user_data;
data->user_data_free_func = user_data_free_func;
- g_ptr_array_add (connection->priv->filters, data);
+ g_ptr_array_add (connection->filters, data);
CONNECTION_UNLOCK (connection);
return data->id;
purge_all_filters (GDBusConnection *connection)
{
guint n;
- for (n = 0; n < connection->priv->filters->len; n++)
+ for (n = 0; n < connection->filters->len; n++)
{
- FilterData *data = connection->priv->filters->pdata[n];
+ FilterData *data = connection->filters->pdata[n];
if (data->user_data_free_func != NULL)
data->user_data_free_func (data->user_data);
g_free (data);
}
}
+/**
+ * g_dbus_connection_remove_filter:
+ * @connection: a #GDBusConnection
+ * @filter_id: an identifier obtained from g_dbus_connection_add_filter()
+ *
+ * Removes a filter.
+ *
+ * Since: 2.26
+ */
void
-g_dbus_connection_remove_filter (GDBusConnection *connection,
- guint filter_id)
+g_dbus_connection_remove_filter (GDBusConnection *connection,
+ guint filter_id)
{
guint n;
FilterData *to_destroy;
g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
+ g_return_if_fail (check_initialized (connection));
CONNECTION_LOCK (connection);
to_destroy = NULL;
- for (n = 0; n < connection->priv->filters->len; n++)
+ for (n = 0; n < connection->filters->len; n++)
{
- FilterData *data = connection->priv->filters->pdata[n];
+ FilterData *data = connection->filters->pdata[n];
if (data->id == filter_id)
{
- g_ptr_array_remove_index (connection->priv->filters, n);
+ g_ptr_array_remove_index (connection->filters, n);
to_destroy = data;
break;
}
{
gchar *rule;
gchar *sender;
+ gchar *sender_unique_name; /* if sender is unique or org.freedesktop.DBus, then that name... otherwise blank */
gchar *interface_name;
gchar *member;
gchar *object_path;
gchar *arg0;
+ GDBusSignalFlags flags;
GArray *subscribers;
} SignalData;
} SignalSubscriber;
static void
-signal_data_free (SignalData *data)
-{
- g_free (data->rule);
- g_free (data->sender);
- g_free (data->interface_name);
- g_free (data->member);
- g_free (data->object_path);
- g_free (data->arg0);
- g_array_free (data->subscribers, TRUE);
- g_free (data);
+signal_data_free (SignalData *signal_data)
+{
+ g_free (signal_data->rule);
+ g_free (signal_data->sender);
+ g_free (signal_data->sender_unique_name);
+ g_free (signal_data->interface_name);
+ g_free (signal_data->member);
+ g_free (signal_data->object_path);
+ g_free (signal_data->arg0);
+ g_array_free (signal_data->subscribers, TRUE);
+ g_free (signal_data);
}
static gchar *
-args_to_rule (const gchar *sender,
- const gchar *interface_name,
- const gchar *member,
- const gchar *object_path,
- const gchar *arg0)
+args_to_rule (const gchar *sender,
+ const gchar *interface_name,
+ const gchar *member,
+ const gchar *object_path,
+ const gchar *arg0,
+ GDBusSignalFlags flags)
{
GString *rule;
rule = g_string_new ("type='signal'");
+ if (flags & G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE)
+ g_string_prepend_c (rule, '-');
if (sender != NULL)
g_string_append_printf (rule, ",sender='%s'", sender);
if (interface_name != NULL)
g_string_append_printf (rule, ",member='%s'", member);
if (object_path != NULL)
g_string_append_printf (rule, ",path='%s'", object_path);
+
if (arg0 != NULL)
- g_string_append_printf (rule, ",arg0='%s'", arg0);
+ {
+ if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
+ g_string_append_printf (rule, ",arg0path='%s'", arg0);
+ else if (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
+ g_string_append_printf (rule, ",arg0namespace='%s'", arg0);
+ else
+ g_string_append_printf (rule, ",arg0='%s'", arg0);
+ }
return g_string_free (rule, FALSE);
}
/* ---------------------------------------------------------------------------------------------------- */
-/* must hold lock when calling */
+/* Called in a user thread, lock is held */
static void
add_match_rule (GDBusConnection *connection,
const gchar *match_rule)
GError *error;
GDBusMessage *message;
+ if (match_rule[0] == '-')
+ return;
+
message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
"/org/freedesktop/DBus", /* path */
"org.freedesktop.DBus", /* interface */
"AddMatch");
g_dbus_message_set_body (message, g_variant_new ("(s)", match_rule));
-
error = NULL;
if (!g_dbus_connection_send_message_unlocked (connection,
message,
+ G_DBUS_SEND_MESSAGE_FLAGS_NONE,
NULL,
&error))
{
/* ---------------------------------------------------------------------------------------------------- */
-/* must hold lock when calling */
+/* Called in a user thread, lock is held */
static void
remove_match_rule (GDBusConnection *connection,
const gchar *match_rule)
GError *error;
GDBusMessage *message;
+ if (match_rule[0] == '-')
+ return;
+
message = g_dbus_message_new_method_call ("org.freedesktop.DBus", /* name */
"/org/freedesktop/DBus", /* path */
"org.freedesktop.DBus", /* interface */
error = NULL;
if (!g_dbus_connection_send_message_unlocked (connection,
message,
+ G_DBUS_SEND_MESSAGE_FLAGS_NONE,
NULL,
&error))
{
+ /* If we could get G_IO_ERROR_CLOSED here, it wouldn't be reasonable to
+ * critical; but we're holding the lock, and our caller checked whether
+ * we were already closed, so we can't get that error.
+ */
g_critical ("Error while sending RemoveMatch() message: %s", error->message);
g_error_free (error);
}
static gboolean
is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
{
- return g_strcmp0 (signal_data->sender, "org.freedesktop.DBus") == 0 &&
- g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
- g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
- (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
- g_strcmp0 (signal_data->member, "NameAcquired") == 0);
+ return g_strcmp0 (signal_data->sender_unique_name, "org.freedesktop.DBus") == 0 &&
+ g_strcmp0 (signal_data->interface_name, "org.freedesktop.DBus") == 0 &&
+ g_strcmp0 (signal_data->object_path, "/org/freedesktop/DBus") == 0 &&
+ (g_strcmp0 (signal_data->member, "NameLost") == 0 ||
+ g_strcmp0 (signal_data->member, "NameAcquired") == 0);
}
/* ---------------------------------------------------------------------------------------------------- */
/**
* g_dbus_connection_signal_subscribe:
- * @connection: A #GDBusConnection.
- * @sender: Sender name to match on. Must be either <literal>org.freedesktop.DBus</literal> (for listening to signals from the message bus daemon) or a unique name or %NULL to listen from all senders.
- * @interface_name: D-Bus interface name to match on or %NULL to match on all interfaces.
- * @member: D-Bus signal name to match on or %NULL to match on all signals.
- * @object_path: Object path to match on or %NULL to match on all object paths.
- * @arg0: Contents of first string argument to match on or %NULL to match on all kinds of arguments.
- * @callback: Callback to invoke when there is a signal matching the requested data.
- * @user_data: User data to pass to @callback.
- * @user_data_free_func: Function to free @user_data with when subscription is removed or %NULL.
- *
- * Subscribes to signals on @connection and invokes @callback with a
- * whenever the signal is received. Note that @callback
- * will be invoked in the <link
- * linkend="g-main-context-push-thread-default">thread-default main
- * loop</link> of the thread you are calling this method from.
- *
- * It is considered a programming error to use this function if @connection is closed.
- *
- * Note that if @sender is not <literal>org.freedesktop.DBus</literal> (for listening to signals from the
- * message bus daemon), then it needs to be a unique bus name or %NULL (for listening to signals from any
- * name) - you cannot pass a name like <literal>com.example.MyApp</literal>.
- * Use e.g. g_bus_watch_name() to find the unique name for the owner of the name you are interested in. Also note
- * that this function does not remove a subscription if @sender vanishes from the bus. You have to manually
- * call g_dbus_connection_signal_unsubscribe() to remove a subscription.
- *
- * Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
- **/
+ * @connection: a #GDBusConnection
+ * @sender: (allow-none): sender name to match on (unique or well-known name)
+ * or %NULL to listen from all senders
+ * @interface_name: (allow-none): D-Bus interface name to match on or %NULL to
+ * match on all interfaces
+ * @member: (allow-none): D-Bus signal name to match on or %NULL to match on
+ * all signals
+ * @object_path: (allow-none): object path to match on or %NULL to match on
+ * all object paths
+ * @arg0: (allow-none): contents of first string argument to match on or %NULL
+ * to match on all kinds of arguments
+ * @flags: flags describing how to subscribe to the signal (currently unused)
+ * @callback: callback to invoke when there is a signal matching the requested data
+ * @user_data: user data to pass to @callback
+ * @user_data_free_func: (allow-none): function to free @user_data with when
+ * subscription is removed or %NULL
+ *
+ * Subscribes to signals on @connection and invokes @callback with a whenever
+ * the signal is received. Note that @callback will be invoked in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread you are calling this method from.
+ *
+ * If @connection is not a message bus connection, @sender must be
+ * %NULL.
+ *
+ * If @sender is a well-known name note that @callback is invoked with
+ * the unique name for the owner of @sender, not the well-known name
+ * as one would expect. This is because the message bus rewrites the
+ * name. As such, to avoid certain race conditions, users should be
+ * tracking the name owner of the well-known name and use that when
+ * processing the received signal.
+ *
+ * If one of %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE or
+ * %G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH are given, @arg0 is
+ * interpreted as part of a namespace or path. The first argument
+ * of a signal is matched against that part as specified by D-Bus.
+ *
+ * Returns: a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe()
+ *
+ * Since: 2.26
+ */
guint
g_dbus_connection_signal_subscribe (GDBusConnection *connection,
const gchar *sender,
const gchar *member,
const gchar *object_path,
const gchar *arg0,
+ GDBusSignalFlags flags,
GDBusSignalCallback callback,
gpointer user_data,
GDestroyNotify user_data_free_func)
SignalData *signal_data;
SignalSubscriber subscriber;
GPtrArray *signal_data_array;
+ const gchar *sender_unique_name;
/* Right now we abort if AddMatch() fails since it can only fail with the bus being in
* an OOM condition. We might want to change that but that would involve making
*/
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
- g_return_val_if_fail (!g_dbus_connection_is_closed (connection), 0);
- g_return_val_if_fail (sender == NULL || ((strcmp (sender, "org.freedesktop.DBus") == 0 || sender[0] == ':') &&
- (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
+ g_return_val_if_fail (sender == NULL || (g_dbus_is_name (sender) && (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)), 0);
g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
g_return_val_if_fail (member == NULL || g_dbus_is_member_name (member), 0);
g_return_val_if_fail (object_path == NULL || g_variant_is_object_path (object_path), 0);
g_return_val_if_fail (callback != NULL, 0);
+ g_return_val_if_fail (check_initialized (connection), 0);
+ g_return_val_if_fail (!((flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH) && (flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)), 0);
+ g_return_val_if_fail (!(arg0 == NULL && (flags & (G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH | G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE))), 0);
CONNECTION_LOCK (connection);
- rule = args_to_rule (sender, interface_name, member, object_path, arg0);
+ /* If G_DBUS_SIGNAL_FLAGS_NO_MATCH_RULE was specified, we will end up
+ * with a '-' character to prefix the rule (which will otherwise be
+ * normal).
+ *
+ * This allows us to hash the rule and do our lifecycle tracking in
+ * the usual way, but the '-' prevents the match rule from ever
+ * actually being send to the bus (either for add or remove).
+ */
+ rule = args_to_rule (sender, interface_name, member, object_path, arg0, flags);
- if (sender == NULL)
- sender = "";
+ if (sender != NULL && (g_dbus_is_unique_name (sender) || g_strcmp0 (sender, "org.freedesktop.DBus") == 0))
+ sender_unique_name = sender;
+ else
+ sender_unique_name = "";
subscriber.callback = callback;
subscriber.user_data = user_data;
subscriber.user_data_free_func = user_data_free_func;
subscriber.id = _global_subscriber_id++; /* TODO: overflow etc. */
- subscriber.context = g_main_context_get_thread_default ();
- if (subscriber.context != NULL)
- g_main_context_ref (subscriber.context);
+ subscriber.context = g_main_context_ref_thread_default ();
/* see if we've already have this rule */
- signal_data = g_hash_table_lookup (connection->priv->map_rule_to_signal_data, rule);
+ signal_data = g_hash_table_lookup (connection->map_rule_to_signal_data, rule);
if (signal_data != NULL)
{
g_array_append_val (signal_data->subscribers, subscriber);
}
signal_data = g_new0 (SignalData, 1);
- signal_data->rule = rule;
- signal_data->sender = g_strdup (sender);
- signal_data->interface_name = g_strdup (interface_name);
- signal_data->member = g_strdup (member);
- signal_data->object_path = g_strdup (object_path);
- signal_data->arg0 = g_strdup (arg0);
- signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
+ signal_data->rule = rule;
+ signal_data->sender = g_strdup (sender);
+ signal_data->sender_unique_name = g_strdup (sender_unique_name);
+ signal_data->interface_name = g_strdup (interface_name);
+ signal_data->member = g_strdup (member);
+ signal_data->object_path = g_strdup (object_path);
+ signal_data->arg0 = g_strdup (arg0);
+ signal_data->flags = flags;
+ signal_data->subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
g_array_append_val (signal_data->subscribers, subscriber);
- g_hash_table_insert (connection->priv->map_rule_to_signal_data,
+ g_hash_table_insert (connection->map_rule_to_signal_data,
signal_data->rule,
signal_data);
/* Add the match rule to the bus...
*
* Avoid adding match rules for NameLost and NameAcquired messages - the bus will
- * always send such messages to to us.
+ * always send such messages to us.
*/
- if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
+ if (connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
{
if (!is_signal_data_for_name_lost_or_acquired (signal_data))
- {
- add_match_rule (connection, signal_data->rule);
- }
+ add_match_rule (connection, signal_data->rule);
}
- out:
- g_hash_table_insert (connection->priv->map_id_to_signal_data,
- GUINT_TO_POINTER (subscriber.id),
- signal_data);
-
- signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array,
- signal_data->sender);
+ signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
+ signal_data->sender_unique_name);
if (signal_data_array == NULL)
{
signal_data_array = g_ptr_array_new ();
- g_hash_table_insert (connection->priv->map_sender_to_signal_data_array,
- g_strdup (signal_data->sender),
+ g_hash_table_insert (connection->map_sender_unique_name_to_signal_data_array,
+ g_strdup (signal_data->sender_unique_name),
signal_data_array);
}
g_ptr_array_add (signal_data_array, signal_data);
+ out:
+ g_hash_table_insert (connection->map_id_to_signal_data,
+ GUINT_TO_POINTER (subscriber.id),
+ signal_data);
+
CONNECTION_UNLOCK (connection);
return subscriber.id;
/* ---------------------------------------------------------------------------------------------------- */
-/* must hold lock when calling this */
+/* called in any thread */
+/* must hold lock when calling this (except if connection->finalizing is TRUE) */
static void
-unsubscribe_id_internal (GDBusConnection *connection,
- guint subscription_id,
- GArray *out_removed_subscribers)
+unsubscribe_id_internal (GDBusConnection *connection,
+ guint subscription_id,
+ GArray *out_removed_subscribers)
{
SignalData *signal_data;
GPtrArray *signal_data_array;
guint n;
- signal_data = g_hash_table_lookup (connection->priv->map_id_to_signal_data,
+ signal_data = g_hash_table_lookup (connection->map_id_to_signal_data,
GUINT_TO_POINTER (subscription_id));
if (signal_data == NULL)
{
if (subscriber->id != subscription_id)
continue;
- g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_signal_data,
+ g_warn_if_fail (g_hash_table_remove (connection->map_id_to_signal_data,
GUINT_TO_POINTER (subscription_id)));
g_array_append_val (out_removed_subscribers, *subscriber);
g_array_remove_index (signal_data->subscribers, n);
if (signal_data->subscribers->len == 0)
- g_warn_if_fail (g_hash_table_remove (connection->priv->map_rule_to_signal_data, signal_data->rule));
+ {
+ g_warn_if_fail (g_hash_table_remove (connection->map_rule_to_signal_data, signal_data->rule));
- signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array,
- signal_data->sender);
- g_warn_if_fail (signal_data_array != NULL);
- g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
+ signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array,
+ signal_data->sender_unique_name);
+ g_warn_if_fail (signal_data_array != NULL);
+ g_warn_if_fail (g_ptr_array_remove (signal_data_array, signal_data));
- if (signal_data_array->len == 0)
- {
- g_warn_if_fail (g_hash_table_remove (connection->priv->map_sender_to_signal_data_array, signal_data->sender));
+ if (signal_data_array->len == 0)
+ {
+ g_warn_if_fail (g_hash_table_remove (connection->map_sender_unique_name_to_signal_data_array,
+ signal_data->sender_unique_name));
+ }
/* remove the match rule from the bus unless NameLost or NameAcquired (see subscribe()) */
- if (connection->priv->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION)
+ if ((connection->flags & G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION) &&
+ !is_signal_data_for_name_lost_or_acquired (signal_data) &&
+ !g_dbus_connection_is_closed (connection) &&
+ !connection->finalizing)
{
- if (!is_signal_data_for_name_lost_or_acquired (signal_data))
- {
- remove_match_rule (connection, signal_data->rule);
- }
+ /* The check for g_dbus_connection_is_closed() means that
+ * sending the RemoveMatch message can't fail with
+ * G_IO_ERROR_CLOSED, because we're holding the lock,
+ * so on_worker_closed() can't happen between the check we just
+ * did, and releasing the lock later.
+ */
+ remove_match_rule (connection, signal_data->rule);
}
signal_data_free (signal_data);
/**
* g_dbus_connection_signal_unsubscribe:
- * @connection: A #GDBusConnection.
- * @subscription_id: A subscription id obtained from g_dbus_connection_signal_subscribe().
+ * @connection: a #GDBusConnection
+ * @subscription_id: a subscription id obtained from
+ * g_dbus_connection_signal_subscribe()
*
* Unsubscribes from signals.
- **/
+ *
+ * Since: 2.26
+ */
void
-g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
- guint subscription_id)
+g_dbus_connection_signal_unsubscribe (GDBusConnection *connection,
+ guint subscription_id)
{
GArray *subscribers;
guint n;
g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
+ g_return_if_fail (check_initialized (connection));
subscribers = g_array_new (FALSE, FALSE, sizeof (SignalSubscriber));
{
SignalSubscriber *subscriber;
subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
- if (subscriber->user_data_free_func != NULL)
- subscriber->user_data_free_func (subscriber->user_data);
- if (subscriber->context != NULL)
- g_main_context_unref (subscriber->context);
+ call_destroy_notify (subscriber->context,
+ subscriber->user_data_free_func,
+ subscriber->user_data);
+ g_main_context_unref (subscriber->context);
}
g_array_free (subscribers, TRUE);
}
#if 0
- g_debug ("in emit_signal_instance_in_idle_cb (sender=%s path=%s interface=%s member=%s params=%s)",
+ g_print ("in emit_signal_instance_in_idle_cb (id=%d sender=%s path=%s interface=%s member=%s params=%s)\n",
+ signal_instance->subscription_id,
signal_instance->sender,
signal_instance->path,
signal_instance->interface,
/* Careful here, don't do the callback if we no longer has the subscription */
CONNECTION_LOCK (signal_instance->connection);
has_subscription = FALSE;
- if (g_hash_table_lookup (signal_instance->connection->priv->map_id_to_signal_data,
+ if (g_hash_table_lookup (signal_instance->connection->map_id_to_signal_data,
GUINT_TO_POINTER (signal_instance->subscription_id)) != NULL)
has_subscription = TRUE;
CONNECTION_UNLOCK (signal_instance->connection);
if (has_subscription)
- {
- signal_instance->callback (signal_instance->connection,
- signal_instance->sender,
- signal_instance->path,
- signal_instance->interface,
- signal_instance->member,
- parameters,
- signal_instance->user_data);
- }
- if (parameters != NULL)
- g_variant_unref (parameters);
+ signal_instance->callback (signal_instance->connection,
+ signal_instance->sender,
+ signal_instance->path,
+ signal_instance->interface,
+ signal_instance->member,
+ parameters,
+ signal_instance->user_data);
+
+ g_variant_unref (parameters);
return FALSE;
}
g_free (signal_instance);
}
-/* called in message handler thread WITH lock held */
+static gboolean
+namespace_rule_matches (const gchar *namespace,
+ const gchar *name)
+{
+ gint len_namespace;
+ gint len_name;
+
+ len_namespace = strlen (namespace);
+ len_name = strlen (name);
+
+ if (len_name < len_namespace)
+ return FALSE;
+
+ if (memcmp (namespace, name, len_namespace) != 0)
+ return FALSE;
+
+ return len_namespace == len_name || name[len_namespace] == '.';
+}
+
+static gboolean
+path_rule_matches (const gchar *path_a,
+ const gchar *path_b)
+{
+ gint len_a, len_b;
+
+ len_a = strlen (path_a);
+ len_b = strlen (path_b);
+
+ if (len_a < len_b && path_a[len_a - 1] != '/')
+ return FALSE;
+
+ if (len_b < len_a && path_b[len_b - 1] != '/')
+ return FALSE;
+
+ return memcmp (path_a, path_b, MIN (len_a, len_b)) == 0;
+}
+
+/* called in GDBusWorker thread WITH lock held */
static void
schedule_callbacks (GDBusConnection *connection,
GPtrArray *signal_data_array,
arg0 = g_dbus_message_get_arg0 (message);
#if 0
- g_debug ("sender = `%s'", sender);
- g_debug ("interface = `%s'", interface);
- g_debug ("member = `%s'", member);
- g_debug ("path = `%s'", path);
- g_debug ("arg0 = `%s'", arg0);
+ g_print ("In schedule_callbacks:\n"
+ " sender = '%s'\n"
+ " interface = '%s'\n"
+ " member = '%s'\n"
+ " path = '%s'\n"
+ " arg0 = '%s'\n",
+ sender,
+ interface,
+ member,
+ path,
+ arg0);
#endif
/* TODO: if this is slow, then we can change signal_data_array into
if (signal_data->object_path != NULL && g_strcmp0 (signal_data->object_path, path) != 0)
continue;
- if (signal_data->arg0 != NULL && g_strcmp0 (signal_data->arg0, arg0) != 0)
- continue;
+ if (signal_data->arg0 != NULL)
+ {
+ if (arg0 == NULL)
+ continue;
+
+ if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE)
+ {
+ if (!namespace_rule_matches (signal_data->arg0, arg0))
+ continue;
+ }
+ else if (signal_data->flags & G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH)
+ {
+ if (!path_rule_matches (signal_data->arg0, arg0))
+ continue;
+ }
+ else if (!g_str_equal (signal_data->arg0, arg0))
+ continue;
+ }
for (m = 0; m < signal_data->subscribers->len; m++)
{
emit_signal_instance_in_idle_cb,
signal_instance,
(GDestroyNotify) signal_instance_free);
+ g_source_set_name (idle_source, "[gio] emit_signal_instance_in_idle_cb");
g_source_attach (idle_source, subscriber->context);
g_source_unref (idle_source);
}
}
}
-/* called in message handler thread with lock held */
+/* called in GDBusWorker thread with lock held */
static void
-distribute_signals (GDBusConnection *connection,
- GDBusMessage *message)
+distribute_signals (GDBusConnection *connection,
+ GDBusMessage *message)
{
GPtrArray *signal_data_array;
const gchar *sender;
sender = g_dbus_message_get_sender (message);
- /* collect subcsribers that match on sender */
+ if (G_UNLIKELY (_g_dbus_debug_signal ()))
+ {
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Signal:\n"
+ " <<<< RECEIVED SIGNAL %s.%s\n"
+ " on object %s\n"
+ " sent by name %s\n",
+ g_dbus_message_get_interface (message),
+ g_dbus_message_get_member (message),
+ g_dbus_message_get_path (message),
+ sender != NULL ? sender : "(none)");
+ _g_dbus_debug_print_unlock ();
+ }
+
+ /* collect subscribers that match on sender */
if (sender != NULL)
{
- signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array, sender);
- if (signal_data_array != NULL) {
+ signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, sender);
+ if (signal_data_array != NULL)
schedule_callbacks (connection, signal_data_array, message, sender);
- }
}
- /* collect subcsribers not matching on sender */
- signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array, "");
+ /* collect subscribers not matching on sender */
+ signal_data_array = g_hash_table_lookup (connection->map_sender_unique_name_to_signal_data_array, "");
if (signal_data_array != NULL)
- {
- schedule_callbacks (connection, signal_data_array, message, sender);
- }
+ schedule_callbacks (connection, signal_data_array, message, sender);
}
/* ---------------------------------------------------------------------------------------------------- */
guint n;
ids = g_array_new (FALSE, FALSE, sizeof (guint));
- g_hash_table_iter_init (&iter, connection->priv->map_id_to_signal_data);
+ g_hash_table_iter_init (&iter, connection->map_id_to_signal_data);
while (g_hash_table_iter_next (&iter, &key, NULL))
{
guint subscription_id = GPOINTER_TO_UINT (key);
{
SignalSubscriber *subscriber;
subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
- if (subscriber->user_data_free_func != NULL)
- subscriber->user_data_free_func (subscriber->user_data);
- if (subscriber->context != NULL)
- g_main_context_unref (subscriber->context);
+ call_destroy_notify (subscriber->context,
+ subscriber->user_data_free_func,
+ subscriber->user_data);
+ g_main_context_unref (subscriber->context);
}
g_array_free (subscribers, TRUE);
/* ---------------------------------------------------------------------------------------------------- */
+static GDBusInterfaceVTable *
+_g_dbus_interface_vtable_copy (const GDBusInterfaceVTable *vtable)
+{
+ /* Don't waste memory by copying padding - remember to update this
+ * when changing struct _GDBusInterfaceVTable in gdbusconnection.h
+ */
+ return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
+}
+
+static void
+_g_dbus_interface_vtable_free (GDBusInterfaceVTable *vtable)
+{
+ g_free (vtable);
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
+static GDBusSubtreeVTable *
+_g_dbus_subtree_vtable_copy (const GDBusSubtreeVTable *vtable)
+{
+ /* Don't waste memory by copying padding - remember to update this
+ * when changing struct _GDBusSubtreeVTable in gdbusconnection.h
+ */
+ return g_memdup ((gconstpointer) vtable, 3 * sizeof (gpointer));
+}
+
+static void
+_g_dbus_subtree_vtable_free (GDBusSubtreeVTable *vtable)
+{
+ g_free (vtable);
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
struct ExportedObject
{
gchar *object_path;
guint id;
gchar *interface_name;
- const GDBusInterfaceVTable *vtable;
- const GDBusInterfaceInfo *introspection_data;
+ GDBusInterfaceVTable *vtable;
+ GDBusInterfaceInfo *interface_info;
GMainContext *context;
gpointer user_data;
static void
exported_interface_free (ExportedInterface *ei)
{
- if (ei->user_data_free_func != NULL)
+ g_dbus_interface_info_cache_release (ei->interface_info);
+ g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
+
+ call_destroy_notify (ei->context,
+ ei->user_data_free_func,
+ ei->user_data);
+
+ g_main_context_unref (ei->context);
+
+ g_free (ei->interface_name);
+ _g_dbus_interface_vtable_free (ei->vtable);
+ g_free (ei);
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
+/* Convenience function to check if @registration_id (if not zero) or
+ * @subtree_registration_id (if not zero) has been unregistered. If
+ * so, returns %TRUE.
+ *
+ * May be called by any thread. Caller must *not* hold lock.
+ */
+static gboolean
+has_object_been_unregistered (GDBusConnection *connection,
+ guint registration_id,
+ guint subtree_registration_id)
+{
+ gboolean ret;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
+
+ ret = FALSE;
+
+ CONNECTION_LOCK (connection);
+ if (registration_id != 0 && g_hash_table_lookup (connection->map_id_to_ei,
+ GUINT_TO_POINTER (registration_id)) == NULL)
{
- /* TODO: push to thread-default mainloop */
- ei->user_data_free_func (ei->user_data);
+ ret = TRUE;
}
- if (ei->context != NULL)
+ else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
+ GUINT_TO_POINTER (subtree_registration_id)) == NULL)
{
- g_main_context_unref (ei->context);
+ ret = TRUE;
}
- g_free (ei->interface_name);
- g_free (ei);
+ CONNECTION_UNLOCK (connection);
+
+ return ret;
}
/* ---------------------------------------------------------------------------------------------------- */
GDBusConnection *connection;
GDBusMessage *message;
gpointer user_data;
- const char *property_name;
+ const gchar *property_name;
const GDBusInterfaceVTable *vtable;
- const GDBusInterfaceInfo *interface_info;
+ GDBusInterfaceInfo *interface_info;
const GDBusPropertyInfo *property_info;
+ guint registration_id;
+ guint subtree_registration_id;
} PropertyData;
static void
GError *error;
GDBusMessage *reply;
- error = NULL;
- value = data->vtable->get_property (data->connection,
- g_dbus_message_get_sender (data->message),
- g_dbus_message_get_path (data->message),
- data->interface_info->name,
+ if (has_object_been_unregistered (data->connection,
+ data->registration_id,
+ data->subtree_registration_id))
+ {
+ reply = g_dbus_message_new_method_error (data->message,
+ "org.freedesktop.DBus.Error.UnknownMethod",
+ _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
+ g_dbus_message_get_path (data->message));
+ g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
+ g_object_unref (reply);
+ goto out;
+ }
+
+ error = NULL;
+ value = data->vtable->get_property (data->connection,
+ g_dbus_message_get_sender (data->message),
+ g_dbus_message_get_path (data->message),
+ data->interface_info->name,
data->property_name,
&error,
data->user_data);
{
g_assert_no_error (error);
- g_variant_ref_sink (value);
+ g_variant_take_ref (value);
reply = g_dbus_message_new_method_reply (data->message);
g_dbus_message_set_body (reply, g_variant_new ("(v)", value));
- g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
+ g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_variant_unref (value);
g_object_unref (reply);
}
else
{
gchar *dbus_error_name;
-
g_assert (error != NULL);
-
dbus_error_name = g_dbus_error_encode_gerror (error);
reply = g_dbus_message_new_method_error_literal (data->message,
dbus_error_name,
error->message);
- g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
+ g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_free (dbus_error_name);
g_error_free (error);
g_object_unref (reply);
}
+ out:
return FALSE;
}
NULL,
&value);
- /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
- * of the given value is wrong
- */
- if (g_strcmp0 (g_variant_get_type_string (value), data->property_info->signature) != 0)
- {
- reply = g_dbus_message_new_method_error (data->message,
- "org.freedesktop.DBus.Error.InvalidArgs",
- _("Error setting property `%s': Expected type `%s' but got `%s'"),
- data->property_info->name,
- data->property_info->signature,
- g_variant_get_type_string (value));
- goto out;
- }
-
if (!data->vtable->set_property (data->connection,
g_dbus_message_get_sender (data->message),
g_dbus_message_get_path (data->message),
reply = g_dbus_message_new_method_reply (data->message);
}
- out:
g_assert (reply != NULL);
- g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
+ g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
+ g_variant_unref (value);
return FALSE;
}
-/* called with lock held */
+/* called in any thread with connection's lock held */
static gboolean
validate_and_maybe_schedule_property_getset (GDBusConnection *connection,
GDBusMessage *message,
+ guint registration_id,
+ guint subtree_registration_id,
gboolean is_get,
- const GDBusInterfaceInfo *introspection_data,
+ GDBusInterfaceInfo *interface_info,
const GDBusInterfaceVTable *vtable,
GMainContext *main_context,
gpointer user_data)
if (is_get)
g_variant_get (g_dbus_message_get_body (message),
- "(ss)",
+ "(&s&s)",
&interface_name,
&property_name);
else
g_variant_get (g_dbus_message_get_body (message),
- "(ssv)",
+ "(&s&sv)",
&interface_name,
&property_name,
NULL);
-
- if (is_get)
- {
- if (vtable == NULL || vtable->get_property == NULL)
- goto out;
- }
- else
- {
- if (vtable == NULL || vtable->set_property == NULL)
- goto out;
- }
+ if (vtable == NULL)
+ goto out;
/* Check that the property exists - if not fail with org.freedesktop.DBus.Error.InvalidArgs
*/
property_info = NULL;
/* TODO: the cost of this is O(n) - it might be worth caching the result */
- property_info = g_dbus_interface_info_lookup_property (introspection_data, property_name);
+ property_info = g_dbus_interface_info_lookup_property (interface_info, property_name);
if (property_info == NULL)
{
reply = g_dbus_message_new_method_error (message,
"org.freedesktop.DBus.Error.InvalidArgs",
- _("No such property `%s'"),
+ _("No such property '%s'"),
property_name);
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
handled = TRUE;
goto out;
{
reply = g_dbus_message_new_method_error (message,
"org.freedesktop.DBus.Error.InvalidArgs",
- _("Property `%s' is not readable"),
+ _("Property '%s' is not readable"),
property_name);
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
handled = TRUE;
goto out;
{
reply = g_dbus_message_new_method_error (message,
"org.freedesktop.DBus.Error.InvalidArgs",
- _("Property `%s' is not writable"),
+ _("Property '%s' is not writable"),
property_name);
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
handled = TRUE;
goto out;
}
+ if (!is_get)
+ {
+ GVariant *value;
+
+ /* Fail with org.freedesktop.DBus.Error.InvalidArgs if the type
+ * of the given value is wrong
+ */
+ g_variant_get_child (g_dbus_message_get_body (message), 2, "v", &value);
+ if (g_strcmp0 (g_variant_get_type_string (value), property_info->signature) != 0)
+ {
+ reply = g_dbus_message_new_method_error (message,
+ "org.freedesktop.DBus.Error.InvalidArgs",
+ _("Error setting property '%s': Expected type '%s' but got '%s'"),
+ property_name, property_info->signature,
+ g_variant_get_type_string (value));
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
+ g_variant_unref (value);
+ g_object_unref (reply);
+ handled = TRUE;
+ goto out;
+ }
+
+ g_variant_unref (value);
+ }
+
+ /* If the vtable pointer for get_property() resp. set_property() is
+ * NULL then dispatch the call via the method_call() handler.
+ */
+ if (is_get)
+ {
+ if (vtable->get_property == NULL)
+ {
+ schedule_method_call (connection, message, registration_id, subtree_registration_id,
+ interface_info, NULL, property_info, g_dbus_message_get_body (message),
+ vtable, main_context, user_data);
+ handled = TRUE;
+ goto out;
+ }
+ }
+ else
+ {
+ if (vtable->set_property == NULL)
+ {
+ schedule_method_call (connection, message, registration_id, subtree_registration_id,
+ interface_info, NULL, property_info, g_dbus_message_get_body (message),
+ vtable, main_context, user_data);
+ handled = TRUE;
+ goto out;
+ }
+ }
+
/* ok, got the property info - call user code in an idle handler */
property_data = g_new0 (PropertyData, 1);
property_data->connection = g_object_ref (connection);
property_data->user_data = user_data;
property_data->property_name = property_name;
property_data->vtable = vtable;
- property_data->interface_info = introspection_data;
+ property_data->interface_info = interface_info;
property_data->property_info = property_info;
+ property_data->registration_id = registration_id;
+ property_data->subtree_registration_id = subtree_registration_id;
idle_source = g_idle_source_new ();
g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
is_get ? invoke_get_property_in_idle_cb : invoke_set_property_in_idle_cb,
property_data,
(GDestroyNotify) property_data_free);
+ if (is_get)
+ g_source_set_name (idle_source, "[gio] invoke_get_property_in_idle_cb");
+ else
+ g_source_set_name (idle_source, "[gio] invoke_set_property_in_idle_cb");
g_source_attach (idle_source, main_context);
g_source_unref (idle_source);
return handled;
}
-/* called with lock held */
+/* called in GDBusWorker thread with connection's lock held */
static gboolean
handle_getset_property (GDBusConnection *connection,
ExportedObject *eo,
if (is_get)
g_variant_get (g_dbus_message_get_body (message),
- "(ss)",
+ "(&s&s)",
&interface_name,
&property_name);
else
g_variant_get (g_dbus_message_get_body (message),
- "(ssv)",
+ "(&s&sv)",
&interface_name,
&property_name,
NULL);
GDBusMessage *reply;
reply = g_dbus_message_new_method_error (message,
"org.freedesktop.DBus.Error.InvalidArgs",
- _("No such interface `%s'"),
+ _("No such interface '%s'"),
interface_name);
- g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
handled = TRUE;
goto out;
handled = validate_and_maybe_schedule_property_getset (eo->connection,
message,
+ ei->id,
+ 0,
is_get,
- ei->introspection_data,
+ ei->interface_info,
ei->vtable,
ei->context,
ei->user_data);
GDBusMessage *message;
gpointer user_data;
const GDBusInterfaceVTable *vtable;
- const GDBusInterfaceInfo *interface_info;
+ GDBusInterfaceInfo *interface_info;
+ guint registration_id;
+ guint subtree_registration_id;
} PropertyGetAllData;
static void
invoke_get_all_properties_in_idle_cb (gpointer _data)
{
PropertyGetAllData *data = _data;
- GVariantBuilder *builder;
- GVariant *packed;
- GVariant *result;
- GError *error;
+ GVariantBuilder builder;
GDBusMessage *reply;
guint n;
- error = NULL;
+ if (has_object_been_unregistered (data->connection,
+ data->registration_id,
+ data->subtree_registration_id))
+ {
+ reply = g_dbus_message_new_method_error (data->message,
+ "org.freedesktop.DBus.Error.UnknownMethod",
+ _("No such interface 'org.freedesktop.DBus.Properties' on object at path %s"),
+ g_dbus_message_get_path (data->message));
+ g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
+ g_object_unref (reply);
+ goto out;
+ }
/* TODO: Right now we never fail this call - we just omit values if
* a get_property() call is failing.
* We could fail the whole call if just a single get_property() call
* returns an error. We need clarification in the D-Bus spec about this.
*/
- builder = g_variant_builder_new (G_VARIANT_TYPE_ARRAY);
+ g_variant_builder_init (&builder, G_VARIANT_TYPE ("(a{sv})"));
+ g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
for (n = 0; data->interface_info->properties != NULL && data->interface_info->properties[n] != NULL; n++)
{
const GDBusPropertyInfo *property_info = data->interface_info->properties[n];
if (value == NULL)
continue;
- g_variant_ref_sink (value);
- g_variant_builder_add (builder,
+ g_variant_take_ref (value);
+ g_variant_builder_add (&builder,
"{sv}",
property_info->name,
value);
g_variant_unref (value);
}
- result = g_variant_builder_end (builder);
-
- builder = g_variant_builder_new (G_VARIANT_TYPE_TUPLE);
- g_variant_builder_add_value (builder, result); /* steals result since result is floating */
- packed = g_variant_builder_end (builder);
+ g_variant_builder_close (&builder);
reply = g_dbus_message_new_method_reply (data->message);
- g_dbus_message_set_body (reply, packed);
- g_dbus_connection_send_message (data->connection, reply, NULL, NULL);
+ g_dbus_message_set_body (reply, g_variant_builder_end (&builder));
+ g_dbus_connection_send_message (data->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
+ out:
return FALSE;
}
-/* called with lock held */
+static gboolean
+interface_has_readable_properties (GDBusInterfaceInfo *interface_info)
+{
+ gint i;
+
+ if (!interface_info->properties)
+ return FALSE;
+
+ for (i = 0; interface_info->properties[i]; i++)
+ if (interface_info->properties[i]->flags & G_DBUS_PROPERTY_INFO_FLAGS_READABLE)
+ return TRUE;
+
+ return FALSE;
+}
+
+/* called in any thread with connection's lock held */
static gboolean
validate_and_maybe_schedule_property_get_all (GDBusConnection *connection,
GDBusMessage *message,
- const GDBusInterfaceInfo *introspection_data,
+ guint registration_id,
+ guint subtree_registration_id,
+ GDBusInterfaceInfo *interface_info,
const GDBusInterfaceVTable *vtable,
GMainContext *main_context,
gpointer user_data)
{
gboolean handled;
- const char *interface_name;
GSource *idle_source;
PropertyGetAllData *property_get_all_data;
handled = FALSE;
- g_variant_get (g_dbus_message_get_body (message),
- "(s)",
- &interface_name);
-
- if (vtable == NULL || vtable->get_property == NULL)
+ if (vtable == NULL)
goto out;
+ /* If the vtable pointer for get_property() is NULL but we have a
+ * non-zero number of readable properties, then dispatch the call via
+ * the method_call() handler.
+ */
+ if (vtable->get_property == NULL && interface_has_readable_properties (interface_info))
+ {
+ schedule_method_call (connection, message, registration_id, subtree_registration_id,
+ interface_info, NULL, NULL, g_dbus_message_get_body (message),
+ vtable, main_context, user_data);
+ handled = TRUE;
+ goto out;
+ }
+
/* ok, got the property info - call user in an idle handler */
property_get_all_data = g_new0 (PropertyGetAllData, 1);
property_get_all_data->connection = g_object_ref (connection);
property_get_all_data->message = g_object_ref (message);
property_get_all_data->user_data = user_data;
property_get_all_data->vtable = vtable;
- property_get_all_data->interface_info = introspection_data;
+ property_get_all_data->interface_info = interface_info;
+ property_get_all_data->registration_id = registration_id;
+ property_get_all_data->subtree_registration_id = subtree_registration_id;
idle_source = g_idle_source_new ();
g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
invoke_get_all_properties_in_idle_cb,
property_get_all_data,
(GDestroyNotify) property_get_all_data_free);
+ g_source_set_name (idle_source, "[gio] invoke_get_all_properties_in_idle_cb");
g_source_attach (idle_source, main_context);
g_source_unref (idle_source);
return handled;
}
-/* called with lock held */
+/* called in GDBusWorker thread with connection's lock held */
static gboolean
handle_get_all_properties (GDBusConnection *connection,
ExportedObject *eo,
handled = FALSE;
g_variant_get (g_dbus_message_get_body (message),
- "(s)",
+ "(&s)",
&interface_name);
/* Fail with org.freedesktop.DBus.Error.InvalidArgs if there is
"org.freedesktop.DBus.Error.InvalidArgs",
_("No such interface"),
interface_name);
- g_dbus_connection_send_message_unlocked (eo->connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (eo->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
handled = TRUE;
goto out;
handled = validate_and_maybe_schedule_property_get_all (eo->connection,
message,
- ei->introspection_data,
+ ei->id,
+ 0,
+ ei->interface_info,
ei->vtable,
ei->context,
ei->user_data);
/* ---------------------------------------------------------------------------------------------------- */
+static const gchar introspect_header[] =
+ "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
+ " \"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
+ "<!-- GDBus " PACKAGE_VERSION " -->\n"
+ "<node>\n";
+
+static const gchar introspect_tail[] =
+ "</node>\n";
+
+static const gchar introspect_properties_interface[] =
+ " <interface name=\"org.freedesktop.DBus.Properties\">\n"
+ " <method name=\"Get\">\n"
+ " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
+ " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
+ " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
+ " </method>\n"
+ " <method name=\"GetAll\">\n"
+ " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
+ " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
+ " </method>\n"
+ " <method name=\"Set\">\n"
+ " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
+ " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
+ " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
+ " </method>\n"
+ " <signal name=\"PropertiesChanged\">\n"
+ " <arg type=\"s\" name=\"interface_name\"/>\n"
+ " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
+ " <arg type=\"as\" name=\"invalidated_properties\"/>\n"
+ " </signal>\n"
+ " </interface>\n";
+
+static const gchar introspect_introspectable_interface[] =
+ " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
+ " <method name=\"Introspect\">\n"
+ " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
+ " </method>\n"
+ " </interface>\n"
+ " <interface name=\"org.freedesktop.DBus.Peer\">\n"
+ " <method name=\"Ping\"/>\n"
+ " <method name=\"GetMachineId\">\n"
+ " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
+ " </method>\n"
+ " </interface>\n";
+
static void
introspect_append_header (GString *s)
{
- g_string_append (s,
- "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
- "<!-- GDBus 0.1 -->\n"
- "<node>\n");
-}
-
-static void
-introspect_append_standard_interfaces (GString *s)
-{
- g_string_append (s,
- " <interface name=\"org.freedesktop.DBus.Properties\">\n"
- " <method name=\"Get\">\n"
- " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
- " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
- " <arg type=\"v\" name=\"value\" direction=\"out\"/>\n"
- " </method>\n"
- " <method name=\"GetAll\">\n"
- " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
- " <arg type=\"a{sv}\" name=\"properties\" direction=\"out\"/>\n"
- " </method>\n"
- " <method name=\"Set\">\n"
- " <arg type=\"s\" name=\"interface_name\" direction=\"in\"/>\n"
- " <arg type=\"s\" name=\"property_name\" direction=\"in\"/>\n"
- " <arg type=\"v\" name=\"value\" direction=\"in\"/>\n"
- " </method>\n"
- " <signal name=\"PropertiesChanged\">\n"
- " <arg type=\"s\" name=\"interface_name\"/>\n"
- " <arg type=\"a{sv}\" name=\"changed_properties\"/>\n"
- " </signal>\n"
- " </interface>\n"
- " <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
- " <method name=\"Introspect\">\n"
- " <arg type=\"s\" name=\"xml_data\" direction=\"out\"/>\n"
- " </method>\n"
- " </interface>\n"
- " <interface name=\"org.freedesktop.DBus.Peer\">\n"
- " <method name=\"Ping\"/>\n"
- " <method name=\"GetMachineId\">\n"
- " <arg type=\"s\" name=\"machine_uuid\" direction=\"out\"/>\n"
- " </method>\n"
- " </interface>\n");
+ g_string_append (s, introspect_header);
}
static void
maybe_add_path (const gchar *path, gsize path_len, const gchar *object_path, GHashTable *set)
{
- if (g_str_has_prefix (object_path, path) && strlen (object_path) >= path_len)
+ if (g_str_has_prefix (object_path, path) && strlen (object_path) > path_len && object_path[path_len-1] == '/')
{
const gchar *begin;
const gchar *end;
begin = object_path + path_len;
end = strchr (begin, '/');
-
if (end != NULL)
- {
- s = g_strndup (begin, end - begin);
- }
+ s = g_strndup (begin, end - begin);
else
- {
- s = g_strdup (begin);
- }
+ s = g_strdup (begin);
if (g_hash_table_lookup (set, s) == NULL)
- {
- g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
- }
+ g_hash_table_insert (set, s, GUINT_TO_POINTER (1));
else
- {
- g_free (s);
- }
+ g_free (s);
}
}
/* TODO: we want a nicer public interface for this */
+/* called in any thread with connection's lock held */
static gchar **
g_dbus_connection_list_registered_unlocked (GDBusConnection *connection,
const gchar *path)
set = g_hash_table_new (g_str_hash, g_str_equal);
- g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_eo);
+ g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_eo);
while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
maybe_add_path (path, path_len, object_path, set);
- g_hash_table_iter_init (&hash_iter, connection->priv->map_object_path_to_es);
+ g_hash_table_iter_init (&hash_iter, connection->map_object_path_to_es);
while (g_hash_table_iter_next (&hash_iter, (gpointer) &object_path, NULL))
maybe_add_path (path, path_len, object_path, set);
p = g_ptr_array_new ();
keys = g_hash_table_get_keys (set);
for (l = keys; l != NULL; l = l->next)
- {
- g_ptr_array_add (p, l->data);
- }
+ g_ptr_array_add (p, l->data);
g_hash_table_unref (set);
g_list_free (keys);
return ret;
}
+/* called in any thread with connection's lock not held */
static gchar **
g_dbus_connection_list_registered (GDBusConnection *connection,
const gchar *path)
return ret;
}
-/* called in message handler thread with lock held */
+/* called in GDBusWorker thread with connection's lock held */
static gboolean
handle_introspect (GDBusConnection *connection,
ExportedObject *eo,
gchar **registered;
/* first the header with the standard interfaces */
- s = g_string_new (NULL);
+ s = g_string_sized_new (sizeof (introspect_header) +
+ sizeof (introspect_properties_interface) +
+ sizeof (introspect_introspectable_interface) +
+ sizeof (introspect_tail));
introspect_append_header (s);
- introspect_append_standard_interfaces (s);
+ if (!g_hash_table_lookup (eo->map_if_name_to_ei,
+ "org.freedesktop.DBus.Properties"))
+ g_string_append (s, introspect_properties_interface);
+
+ if (!g_hash_table_lookup (eo->map_if_name_to_ei,
+ "org.freedesktop.DBus.Introspectable"))
+ g_string_append (s, introspect_introspectable_interface);
/* then include the registered interfaces */
g_hash_table_iter_init (&hash_iter, eo->map_if_name_to_ei);
while (g_hash_table_iter_next (&hash_iter, NULL, (gpointer) &ei))
- {
- g_dbus_interface_info_generate_xml (ei->introspection_data, 2, s);
- }
+ g_dbus_interface_info_generate_xml (ei->interface_info, 2, s);
/* finally include nodes registered below us */
registered = g_dbus_connection_list_registered_unlocked (connection, eo->object_path);
for (n = 0; registered != NULL && registered[n] != NULL; n++)
- {
- g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
- }
+ g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
g_strfreev (registered);
- g_string_append (s, "</node>\n");
+ g_string_append (s, introspect_tail);
reply = g_dbus_message_new_method_reply (message);
g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
g_string_free (s, TRUE);
/* called in thread where object was registered - no locks held */
static gboolean
-invoke_method_in_idle_cb (gpointer user_data)
+call_in_idle_cb (gpointer user_data)
{
GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (user_data);
GDBusInterfaceVTable *vtable;
+ guint registration_id;
+ guint subtree_registration_id;
+
+ registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-registration-id"));
+ subtree_registration_id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id"));
+
+ if (has_object_been_unregistered (g_dbus_method_invocation_get_connection (invocation),
+ registration_id,
+ subtree_registration_id))
+ {
+ GDBusMessage *reply;
+ reply = g_dbus_message_new_method_error (g_dbus_method_invocation_get_message (invocation),
+ "org.freedesktop.DBus.Error.UnknownMethod",
+ _("No such interface '%s' on object at path %s"),
+ g_dbus_method_invocation_get_interface_name (invocation),
+ g_dbus_method_invocation_get_object_path (invocation));
+ g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
+ g_object_unref (reply);
+ goto out;
+ }
vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
g_assert (vtable != NULL && vtable->method_call != NULL);
g_object_ref (invocation),
g_dbus_method_invocation_get_user_data (invocation));
+ out:
return FALSE;
}
-/* called in message handler thread with lock held */
+/* called in GDBusWorker thread with connection's lock held */
+static void
+schedule_method_call (GDBusConnection *connection,
+ GDBusMessage *message,
+ guint registration_id,
+ guint subtree_registration_id,
+ const GDBusInterfaceInfo *interface_info,
+ const GDBusMethodInfo *method_info,
+ const GDBusPropertyInfo *property_info,
+ GVariant *parameters,
+ const GDBusInterfaceVTable *vtable,
+ GMainContext *main_context,
+ gpointer user_data)
+{
+ GDBusMethodInvocation *invocation;
+ GSource *idle_source;
+
+ invocation = _g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
+ g_dbus_message_get_path (message),
+ g_dbus_message_get_interface (message),
+ g_dbus_message_get_member (message),
+ method_info,
+ property_info,
+ connection,
+ message,
+ parameters,
+ user_data);
+
+ /* TODO: would be nicer with a real MethodData like we already
+ * have PropertyData and PropertyGetAllData... */
+ g_object_set_data (G_OBJECT (invocation), "g-dbus-interface-vtable", (gpointer) vtable);
+ g_object_set_data (G_OBJECT (invocation), "g-dbus-registration-id", GUINT_TO_POINTER (registration_id));
+ g_object_set_data (G_OBJECT (invocation), "g-dbus-subtree-registration-id", GUINT_TO_POINTER (subtree_registration_id));
+
+ idle_source = g_idle_source_new ();
+ g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
+ g_source_set_callback (idle_source,
+ call_in_idle_cb,
+ invocation,
+ g_object_unref);
+ g_source_set_name (idle_source, "[gio] call_in_idle_cb");
+ g_source_attach (idle_source, main_context);
+ g_source_unref (idle_source);
+}
+
+/* called in GDBusWorker thread with connection's lock held */
static gboolean
validate_and_maybe_schedule_method_call (GDBusConnection *connection,
GDBusMessage *message,
- const GDBusInterfaceInfo *introspection_data,
+ guint registration_id,
+ guint subtree_registration_id,
+ GDBusInterfaceInfo *interface_info,
const GDBusInterfaceVTable *vtable,
GMainContext *main_context,
gpointer user_data)
{
- GDBusMethodInvocation *invocation;
- const GDBusMethodInfo *method_info;
+ GDBusMethodInfo *method_info;
GDBusMessage *reply;
GVariant *parameters;
- GSource *idle_source;
gboolean handled;
- gchar *in_signature;
+ GVariantType *in_type;
handled = FALSE;
/* TODO: the cost of this is O(n) - it might be worth caching the result */
- method_info = g_dbus_interface_info_lookup_method (introspection_data, g_dbus_message_get_member (message));
+ method_info = g_dbus_interface_info_lookup_method (interface_info, g_dbus_message_get_member (message));
/* if the method doesn't exist, return the org.freedesktop.DBus.Error.UnknownMethod
* error to the caller
{
reply = g_dbus_message_new_method_error (message,
"org.freedesktop.DBus.Error.UnknownMethod",
- _("No such method `%s'"),
+ _("No such method '%s'"),
g_dbus_message_get_member (message));
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
- g_object_unref (reply);
- handled = TRUE;
- goto out;
- }
-
- /* Check that the incoming args are of the right type - if they are not, return
- * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
- *
- * TODO: might also be worth caching the combined signature.
- */
- in_signature = _g_dbus_compute_complete_signature (method_info->in_args, FALSE);
- if (g_strcmp0 (g_dbus_message_get_signature (message), in_signature) != 0)
- {
- reply = g_dbus_message_new_method_error (message,
- "org.freedesktop.DBus.Error.InvalidArgs",
- _("Signature of message, `%s', does not match expected signature `%s'"),
- g_dbus_message_get_signature (message),
- in_signature);
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
- g_free (in_signature);
handled = TRUE;
goto out;
}
- g_free (in_signature);
parameters = g_dbus_message_get_body (message);
if (parameters == NULL)
g_variant_ref (parameters);
}
- /* schedule the call in idle */
- invocation = g_dbus_method_invocation_new (g_dbus_message_get_sender (message),
- g_dbus_message_get_path (message),
- g_dbus_message_get_interface (message),
- g_dbus_message_get_member (message),
- method_info,
- connection,
- message,
- parameters,
- user_data);
- g_variant_unref (parameters);
- g_object_set_data (G_OBJECT (invocation),
- "g-dbus-interface-vtable",
- (gpointer) vtable);
+ /* Check that the incoming args are of the right type - if they are not, return
+ * the org.freedesktop.DBus.Error.InvalidArgs error to the caller
+ */
+ in_type = _g_dbus_compute_complete_signature (method_info->in_args);
+ if (!g_variant_is_of_type (parameters, in_type))
+ {
+ gchar *type_string;
- idle_source = g_idle_source_new ();
- g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
- g_source_set_callback (idle_source,
- invoke_method_in_idle_cb,
- invocation,
- g_object_unref);
- g_source_attach (idle_source, main_context);
- g_source_unref (idle_source);
+ type_string = g_variant_type_dup_string (in_type);
+ reply = g_dbus_message_new_method_error (message,
+ "org.freedesktop.DBus.Error.InvalidArgs",
+ _("Type of message, '%s', does not match expected type '%s'"),
+ g_variant_get_type_string (parameters),
+ type_string);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
+ g_variant_type_free (in_type);
+ g_variant_unref (parameters);
+ g_object_unref (reply);
+ g_free (type_string);
+ handled = TRUE;
+ goto out;
+ }
+ g_variant_type_free (in_type);
+
+ /* schedule the call in idle */
+ schedule_method_call (connection, message, registration_id, subtree_registration_id,
+ interface_info, method_info, NULL, parameters,
+ vtable, main_context, user_data);
+ g_variant_unref (parameters);
handled = TRUE;
out:
-
return handled;
}
/* ---------------------------------------------------------------------------------------------------- */
-/* called in message handler thread with lock held */
+/* called in GDBusWorker thread with connection's lock held */
static gboolean
obj_message_func (GDBusConnection *connection,
ExportedObject *eo,
handled = validate_and_maybe_schedule_method_call (connection,
message,
- ei->introspection_data,
+ ei->id,
+ 0,
+ ei->interface_info,
ei->vtable,
ei->context,
ei->user_data);
/**
* g_dbus_connection_register_object:
- * @connection: A #GDBusConnection.
- * @object_path: The object path to register at.
- * @interface_name: The D-Bus interface to register.
- * @introspection_data: Introspection data for the interface.
- * @vtable: A #GDBusInterfaceVTable to call into or %NULL.
- * @user_data: Data to pass to functions in @vtable.
- * @user_data_free_func: Function to call when the object path is unregistered.
- * @error: Return location for error or %NULL.
+ * @connection: a #GDBusConnection
+ * @object_path: the object path to register at
+ * @interface_info: introspection data for the interface
+ * @vtable: (allow-none): a #GDBusInterfaceVTable to call into or %NULL
+ * @user_data: (allow-none): data to pass to functions in @vtable
+ * @user_data_free_func: function to call when the object path is unregistered
+ * @error: return location for error or %NULL
*
* Registers callbacks for exported objects at @object_path with the
- * D-Bus interface @interface_name.
+ * D-Bus interface that is described in @interface_info.
*
- * Calls to functions in @vtable (and @user_data_free_func) will
- * happen in the <link linkend="g-main-context-push-thread-default">thread-default main
- * loop</link> of the thread you are calling this method from.
+ * Calls to functions in @vtable (and @user_data_free_func) will happen
+ * in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread you are calling this method from.
*
* Note that all #GVariant values passed to functions in @vtable will match
- * the signature given in @introspection_data - if a remote caller passes
- * incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
+ * the signature given in @interface_info - if a remote caller passes
+ * incorrect values, the `org.freedesktop.DBus.Error.InvalidArgs`
* is returned to the remote caller.
*
* Additionally, if the remote caller attempts to invoke methods or
- * access properties not mentioned in @introspection_data the
- * <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
- * <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
+ * access properties not mentioned in @interface_info the
+ * `org.freedesktop.DBus.Error.UnknownMethod` resp.
+ * `org.freedesktop.DBus.Error.InvalidArgs` errors
* are returned to the caller.
*
* It is considered a programming error if the
* If an existing callback is already registered at @object_path and
* @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
*
- * See <xref linkend="gdbus-server"/> for an example of how to use this method.
+ * GDBus automatically implements the standard D-Bus interfaces
+ * org.freedesktop.DBus.Properties, org.freedesktop.DBus.Introspectable
+ * and org.freedesktop.Peer, so you don't have to implement those for the
+ * objects you export. You can implement org.freedesktop.DBus.Properties
+ * yourself, e.g. to handle getting and setting of properties asynchronously.
+ *
+ * Note that the reference count on @interface_info will be
+ * incremented by 1 (unless allocated statically, e.g. if the
+ * reference count is -1, see g_dbus_interface_info_ref()) for as long
+ * as the object is exported. Also note that @vtable will be copied.
+ *
+ * See this [server][gdbus-server] for an example of how to use this method.
*
* Returns: 0 if @error is set, otherwise a registration id (never 0)
- * that can be used with g_dbus_connection_unregister_object() .
+ * that can be used with g_dbus_connection_unregister_object()
+ *
+ * Since: 2.26
*/
guint
-g_dbus_connection_register_object (GDBusConnection *connection,
- const gchar *object_path,
- const gchar *interface_name,
- const GDBusInterfaceInfo *introspection_data,
- const GDBusInterfaceVTable *vtable,
- gpointer user_data,
- GDestroyNotify user_data_free_func,
- GError **error)
+g_dbus_connection_register_object (GDBusConnection *connection,
+ const gchar *object_path,
+ GDBusInterfaceInfo *interface_info,
+ const GDBusInterfaceVTable *vtable,
+ gpointer user_data,
+ GDestroyNotify user_data_free_func,
+ GError **error)
{
ExportedObject *eo;
ExportedInterface *ei;
guint ret;
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
- g_return_val_if_fail (!g_dbus_connection_is_closed (connection), 0);
g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
- g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), 0);
- g_return_val_if_fail (introspection_data != NULL, 0);
+ g_return_val_if_fail (interface_info != NULL, 0);
+ g_return_val_if_fail (g_dbus_is_interface_name (interface_info->name), 0);
g_return_val_if_fail (error == NULL || *error == NULL, 0);
+ g_return_val_if_fail (check_initialized (connection), 0);
ret = 0;
CONNECTION_LOCK (connection);
- eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
+ eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
if (eo == NULL)
{
eo = g_new0 (ExportedObject, 1);
g_str_equal,
NULL,
(GDestroyNotify) exported_interface_free);
- g_hash_table_insert (connection->priv->map_object_path_to_eo, eo->object_path, eo);
+ g_hash_table_insert (connection->map_object_path_to_eo, eo->object_path, eo);
}
- ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_name);
+ ei = g_hash_table_lookup (eo->map_if_name_to_ei, interface_info->name);
if (ei != NULL)
{
g_set_error (error,
G_IO_ERROR,
G_IO_ERROR_EXISTS,
_("An object is already exported for the interface %s at %s"),
- interface_name,
+ interface_info->name,
object_path);
goto out;
}
ei->eo = eo;
ei->user_data = user_data;
ei->user_data_free_func = user_data_free_func;
- ei->vtable = vtable;
- ei->introspection_data = introspection_data;
- ei->interface_name = g_strdup (interface_name);
- ei->context = g_main_context_get_thread_default ();
- if (ei->context != NULL)
- g_main_context_ref (ei->context);
+ ei->vtable = _g_dbus_interface_vtable_copy (vtable);
+ ei->interface_info = g_dbus_interface_info_ref (interface_info);
+ g_dbus_interface_info_cache_build (ei->interface_info);
+ ei->interface_name = g_strdup (interface_info->name);
+ ei->context = g_main_context_ref_thread_default ();
g_hash_table_insert (eo->map_if_name_to_ei,
(gpointer) ei->interface_name,
ei);
- g_hash_table_insert (connection->priv->map_id_to_ei,
+ g_hash_table_insert (connection->map_id_to_ei,
GUINT_TO_POINTER (ei->id),
ei);
/**
* g_dbus_connection_unregister_object:
- * @connection: A #GDBusConnection.
- * @registration_id: A registration id obtained from g_dbus_connection_register_object().
+ * @connection: a #GDBusConnection
+ * @registration_id: a registration id obtained from
+ * g_dbus_connection_register_object()
*
* Unregisters an object.
*
- * Returns: %TRUE if the object was unregistered, %FALSE otherwise.
+ * Returns: %TRUE if the object was unregistered, %FALSE otherwise
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_unregister_object (GDBusConnection *connection,
gboolean ret;
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (check_initialized (connection), FALSE);
ret = FALSE;
CONNECTION_LOCK (connection);
- ei = g_hash_table_lookup (connection->priv->map_id_to_ei,
+ ei = g_hash_table_lookup (connection->map_id_to_ei,
GUINT_TO_POINTER (registration_id));
if (ei == NULL)
- {
- goto out;
- }
+ goto out;
eo = ei->eo;
- g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
+ g_warn_if_fail (g_hash_table_remove (connection->map_id_to_ei, GUINT_TO_POINTER (ei->id)));
g_warn_if_fail (g_hash_table_remove (eo->map_if_name_to_ei, ei->interface_name));
/* unregister object path if we have no more exported interfaces */
if (g_hash_table_size (eo->map_if_name_to_ei) == 0)
- {
- g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_eo,
- eo->object_path));
- }
+ g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
+ eo->object_path));
ret = TRUE;
/**
* g_dbus_connection_emit_signal:
- * @connection: A #GDBusConnection.
- * @destination_bus_name: The unique bus name for the destination for the signal or %NULL to emit to all listeners.
- * @object_path: Path of remote object.
- * @interface_name: D-Bus interface to emit a signal on.
- * @signal_name: The name of the signal to emit.
- * @parameters: A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.
- * @error: Return location for error or %NULL.
+ * @connection: a #GDBusConnection
+ * @destination_bus_name: (allow-none): the unique bus name for the destination
+ * for the signal or %NULL to emit to all listeners
+ * @object_path: path of remote object
+ * @interface_name: D-Bus interface to emit a signal on
+ * @signal_name: the name of the signal to emit
+ * @parameters: (allow-none): a #GVariant tuple with parameters for the signal
+ * or %NULL if not passing parameters
+ * @error: Return location for error or %NULL
*
* Emits a signal.
*
+ * If the parameters GVariant is floating, it is consumed.
+ *
* This can only fail if @parameters is not compatible with the D-Bus protocol.
*
- * Returns: %TRUE unless @error is set.
+ * Returns: %TRUE unless @error is set
+ *
+ * Since: 2.26
*/
gboolean
-g_dbus_connection_emit_signal (GDBusConnection *connection,
- const gchar *destination_bus_name,
- const gchar *object_path,
- const gchar *interface_name,
- const gchar *signal_name,
- GVariant *parameters,
- GError **error)
+g_dbus_connection_emit_signal (GDBusConnection *connection,
+ const gchar *destination_bus_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *signal_name,
+ GVariant *parameters,
+ GError **error)
{
GDBusMessage *message;
gboolean ret;
g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), FALSE);
g_return_val_if_fail (signal_name != NULL && g_dbus_is_member_name (signal_name), FALSE);
g_return_val_if_fail (parameters == NULL || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), FALSE);
+ g_return_val_if_fail (check_initialized (connection), FALSE);
+
+ if (G_UNLIKELY (_g_dbus_debug_emission ()))
+ {
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Emission:\n"
+ " >>>> SIGNAL EMISSION %s.%s()\n"
+ " on object %s\n"
+ " destination %s\n",
+ interface_name, signal_name,
+ object_path,
+ destination_bus_name != NULL ? destination_bus_name : "(none)");
+ _g_dbus_debug_print_unlock ();
+ }
message = g_dbus_message_new_signal (object_path,
interface_name,
signal_name);
if (destination_bus_name != NULL)
- {
- g_dbus_message_set_header (message,
- G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
- g_variant_new_string (destination_bus_name));
- }
+ g_dbus_message_set_header (message,
+ G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION,
+ g_variant_new_string (destination_bus_name));
if (parameters != NULL)
g_dbus_message_set_body (message, parameters);
- ret = g_dbus_connection_send_message (connection, message, NULL, error);
+ ret = g_dbus_connection_send_message (connection, message, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, error);
g_object_unref (message);
return ret;
}
static void
-add_invoke_method_flags (GDBusMessage *message,
- GDBusInvokeMethodFlags flags)
+add_call_flags (GDBusMessage *message,
+ GDBusCallFlags flags)
{
- if (flags & G_DBUS_INVOKE_METHOD_FLAGS_NO_AUTO_START)
+ if (flags & G_DBUS_CALL_FLAGS_NO_AUTO_START)
g_dbus_message_set_flags (message, G_DBUS_MESSAGE_FLAGS_NO_AUTO_START);
}
-/**
- * g_dbus_connection_invoke_method:
- * @connection: A #GDBusConnection.
- * @bus_name: A unique or well-known bus name or %NULL if @connection is not a message bus connection.
- * @object_path: Path of remote object.
- * @interface_name: D-Bus interface to invoke method on.
- * @method_name: The name of the method to invoke.
- * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
- * @flags: Flags from the #GDBusInvokeMethodFlags enumeration.
- * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
- * @cancellable: A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't
- * care about the result of the method invocation.
- * @user_data: The data to pass to @callback.
- *
- * Asynchronously invokes the @method_name method on the
- * @interface_name D-Bus interface on the remote object at
- * @object_path owned by @bus_name.
- *
- * If @connection is closed then the operation will fail with
- * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
- * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
- * not compatible with the D-Bus protocol, the operation fails with
- * %G_IO_ERROR_INVALID_ARGUMENT.
- *
- * This is an asynchronous method. When the operation is finished, @callback will be invoked
- * in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
- * of the thread you are calling this method from. You can then call
- * g_dbus_connection_invoke_method_finish() to get the result of the operation.
- * See g_dbus_connection_invoke_method_sync() for the synchronous version of this
- * function.
- */
-void
-g_dbus_connection_invoke_method (GDBusConnection *connection,
- const gchar *bus_name,
- const gchar *object_path,
- const gchar *interface_name,
- const gchar *method_name,
- GVariant *parameters,
- GDBusInvokeMethodFlags flags,
- gint timeout_msec,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+static GVariant *
+decode_method_reply (GDBusMessage *reply,
+ const gchar *method_name,
+ const GVariantType *reply_type,
+ GUnixFDList **out_fd_list,
+ GError **error)
+{
+ GVariant *result;
+
+ result = NULL;
+ switch (g_dbus_message_get_message_type (reply))
+ {
+ case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
+ result = g_dbus_message_get_body (reply);
+ if (result == NULL)
+ {
+ result = g_variant_new ("()");
+ g_variant_ref_sink (result);
+ }
+ else
+ {
+ g_variant_ref (result);
+ }
+
+ if (!g_variant_is_of_type (result, reply_type))
+ {
+ gchar *type_string = g_variant_type_dup_string (reply_type);
+
+ g_set_error (error,
+ G_IO_ERROR,
+ G_IO_ERROR_INVALID_ARGUMENT,
+ _("Method '%s' returned type '%s', but expected '%s'"),
+ method_name, g_variant_get_type_string (result), type_string);
+
+ g_variant_unref (result);
+ g_free (type_string);
+ result = NULL;
+ }
+
+#ifdef G_OS_UNIX
+ if (result != NULL)
+ {
+ if (out_fd_list != NULL)
+ {
+ *out_fd_list = g_dbus_message_get_unix_fd_list (reply);
+ if (*out_fd_list != NULL)
+ g_object_ref (*out_fd_list);
+ }
+ }
+#endif
+ break;
+
+ case G_DBUS_MESSAGE_TYPE_ERROR:
+ g_dbus_message_to_gerror (reply, error);
+ break;
+
+ default:
+ g_assert_not_reached ();
+ break;
+ }
+
+ return result;
+}
+
+
+typedef struct
+{
+ GSimpleAsyncResult *simple;
+ GVariantType *reply_type;
+ gchar *method_name; /* for error message */
+ guint32 serial;
+
+ GVariant *value;
+ GUnixFDList *fd_list;
+} CallState;
+
+static void
+call_state_free (CallState *state)
+{
+ g_variant_type_free (state->reply_type);
+ g_free (state->method_name);
+
+ if (state->value != NULL)
+ g_variant_unref (state->value);
+ if (state->fd_list != NULL)
+ g_object_unref (state->fd_list);
+ g_slice_free (CallState, state);
+}
+
+/* called in any thread, with the connection's lock not held */
+static void
+g_dbus_connection_call_done (GObject *source,
+ GAsyncResult *result,
+ gpointer user_data)
+{
+ GSimpleAsyncResult *simple;
+ GDBusConnection *connection = G_DBUS_CONNECTION (source);
+ CallState *state = user_data;
+ GError *error;
+ GDBusMessage *reply;
+
+ error = NULL;
+ reply = g_dbus_connection_send_message_with_reply_finish (connection,
+ result,
+ &error);
+
+ if (G_UNLIKELY (_g_dbus_debug_call ()))
+ {
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Call:\n"
+ " <<<< ASYNC COMPLETE %s() (serial %d)\n"
+ " ",
+ state->method_name,
+ state->serial);
+ if (reply != NULL)
+ {
+ g_print ("SUCCESS\n");
+ }
+ else
+ {
+ g_print ("FAILED: %s\n",
+ error->message);
+ }
+ _g_dbus_debug_print_unlock ();
+ }
+
+ if (reply != NULL)
+ state->value = decode_method_reply (reply, state->method_name, state->reply_type, &state->fd_list, &error);
+
+ simple = state->simple; /* why? because state is freed before we unref simple.. */
+ if (error != NULL)
+ {
+ g_simple_async_result_take_error (state->simple, error);
+ g_simple_async_result_complete (state->simple);
+ call_state_free (state);
+ }
+ else
+ {
+ g_simple_async_result_set_op_res_gpointer (state->simple, state, (GDestroyNotify) call_state_free);
+ g_simple_async_result_complete (state->simple);
+ }
+ g_clear_object (&reply);
+ g_object_unref (simple);
+}
+
+/* called in any thread, with the connection's lock not held */
+static void
+g_dbus_connection_call_internal (GDBusConnection *connection,
+ const gchar *bus_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *method_name,
+ GVariant *parameters,
+ const GVariantType *reply_type,
+ GDBusCallFlags flags,
+ gint timeout_msec,
+ GUnixFDList *fd_list,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
{
GDBusMessage *message;
+ guint32 serial;
g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
g_return_if_fail (bus_name == NULL || g_dbus_is_name (bus_name));
g_return_if_fail (method_name != NULL && g_dbus_is_member_name (method_name));
g_return_if_fail (timeout_msec >= 0 || timeout_msec == -1);
g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
+ g_return_if_fail (check_initialized (connection));
+#ifdef G_OS_UNIX
+ g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
+#else
+ g_return_if_fail (fd_list == NULL);
+#endif
message = g_dbus_message_new_method_call (bus_name,
object_path,
interface_name,
method_name);
- add_invoke_method_flags (message, flags);
+ add_call_flags (message, flags);
if (parameters != NULL)
g_dbus_message_set_body (message, parameters);
- g_dbus_connection_send_message_with_reply (connection,
- message,
- timeout_msec,
- NULL, /* volatile guint32 *out_serial */
- cancellable,
- callback,
- user_data);
+#ifdef G_OS_UNIX
+ if (fd_list != NULL)
+ g_dbus_message_set_unix_fd_list (message, fd_list);
+#endif
+
+ /* If the user has no callback then we can just send the message with
+ * the G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set and skip all
+ * the logic for processing the reply. If the service sends the reply
+ * anyway then it will just be ignored.
+ */
+ if (callback != NULL)
+ {
+ CallState *state;
+
+ state = g_slice_new0 (CallState);
+ state->simple = g_simple_async_result_new (G_OBJECT (connection),
+ callback, user_data,
+ g_dbus_connection_call_internal);
+ g_simple_async_result_set_check_cancellable (state->simple, cancellable);
+ state->method_name = g_strjoin (".", interface_name, method_name, NULL);
+
+ if (reply_type == NULL)
+ reply_type = G_VARIANT_TYPE_ANY;
+
+ state->reply_type = g_variant_type_copy (reply_type);
+
+ g_dbus_connection_send_message_with_reply (connection,
+ message,
+ G_DBUS_SEND_MESSAGE_FLAGS_NONE,
+ timeout_msec,
+ &state->serial,
+ cancellable,
+ g_dbus_connection_call_done,
+ state);
+ serial = state->serial;
+ }
+ else
+ {
+ GDBusMessageFlags flags;
+
+ flags = g_dbus_message_get_flags (message);
+ flags |= G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
+ g_dbus_message_set_flags (message, flags);
- if (message != NULL)
+ g_dbus_connection_send_message (connection,
+ message,
+ G_DBUS_SEND_MESSAGE_FLAGS_NONE,
+ &serial, NULL);
+ }
+
+ if (G_UNLIKELY (_g_dbus_debug_call ()))
+ {
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Call:\n"
+ " >>>> ASYNC %s.%s()\n"
+ " on object %s\n"
+ " owned by name %s (serial %d)\n",
+ interface_name,
+ method_name,
+ object_path,
+ bus_name != NULL ? bus_name : "(none)",
+ serial);
+ _g_dbus_debug_print_unlock ();
+ }
+
+ if (message != NULL)
g_object_unref (message);
}
+/* called in any thread, with the connection's lock not held */
static GVariant *
-decode_method_reply (GDBusMessage *reply, GError **error)
+g_dbus_connection_call_finish_internal (GDBusConnection *connection,
+ GUnixFDList **out_fd_list,
+ GAsyncResult *res,
+ GError **error)
{
+ GSimpleAsyncResult *simple;
+ CallState *state;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
+ g_return_val_if_fail (g_simple_async_result_is_valid (res, G_OBJECT (connection),
+ g_dbus_connection_call_internal), NULL);
+ g_return_val_if_fail (error == NULL || *error == NULL, NULL);
+
+ simple = G_SIMPLE_ASYNC_RESULT (res);
+
+ if (g_simple_async_result_propagate_error (simple, error))
+ return NULL;
+
+ state = g_simple_async_result_get_op_res_gpointer (simple);
+ if (out_fd_list != NULL)
+ *out_fd_list = state->fd_list != NULL ? g_object_ref (state->fd_list) : NULL;
+ return g_variant_ref (state->value);
+}
+
+/* called in any user thread, with the connection's lock not held */
+static GVariant *
+g_dbus_connection_call_sync_internal (GDBusConnection *connection,
+ const gchar *bus_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *method_name,
+ GVariant *parameters,
+ const GVariantType *reply_type,
+ GDBusCallFlags flags,
+ gint timeout_msec,
+ GUnixFDList *fd_list,
+ GUnixFDList **out_fd_list,
+ GCancellable *cancellable,
+ GError **error)
+{
+ GDBusMessage *message;
+ GDBusMessage *reply;
GVariant *result;
+ GError *local_error;
+ GDBusSendMessageFlags send_flags;
+
+ message = NULL;
+ reply = NULL;
+ result = NULL;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
+ g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
+ g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
+ g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
+ g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
+ g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
+ g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
+#ifdef G_OS_UNIX
+ g_return_val_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list), NULL);
+#else
+ g_return_val_if_fail (fd_list == NULL, NULL);
+#endif
+ g_return_val_if_fail (error == NULL || *error == NULL, NULL);
+
+ if (!(flags & CALL_FLAGS_INITIALIZING))
+ g_return_val_if_fail (check_initialized (connection), FALSE);
+
+ if (reply_type == NULL)
+ reply_type = G_VARIANT_TYPE_ANY;
+
+ message = g_dbus_message_new_method_call (bus_name,
+ object_path,
+ interface_name,
+ method_name);
+ add_call_flags (message, flags);
+ if (parameters != NULL)
+ g_dbus_message_set_body (message, parameters);
+
+#ifdef G_OS_UNIX
+ if (fd_list != NULL)
+ g_dbus_message_set_unix_fd_list (message, fd_list);
+#endif
+
+ if (G_UNLIKELY (_g_dbus_debug_call ()))
+ {
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Call:\n"
+ " >>>> SYNC %s.%s()\n"
+ " on object %s\n"
+ " owned by name %s\n",
+ interface_name,
+ method_name,
+ object_path,
+ bus_name != NULL ? bus_name : "(none)");
+ _g_dbus_debug_print_unlock ();
+ }
+
+ local_error = NULL;
+
+ send_flags = G_DBUS_SEND_MESSAGE_FLAGS_NONE;
+
+ /* translate from one flavour of flags to another... */
+ if (flags & CALL_FLAGS_INITIALIZING)
+ send_flags |= SEND_MESSAGE_FLAGS_INITIALIZING;
+
+ reply = g_dbus_connection_send_message_with_reply_sync (connection,
+ message,
+ send_flags,
+ timeout_msec,
+ NULL, /* volatile guint32 *out_serial */
+ cancellable,
+ &local_error);
- result = NULL;
- switch (g_dbus_message_get_type (reply))
+ if (G_UNLIKELY (_g_dbus_debug_call ()))
{
- case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
- result = g_dbus_message_get_body (reply);
- if (result == NULL)
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Call:\n"
+ " <<<< SYNC COMPLETE %s.%s()\n"
+ " ",
+ interface_name,
+ method_name);
+ if (reply != NULL)
{
- result = g_variant_new ("()");
- g_variant_ref_sink (result);
+ g_print ("SUCCESS\n");
}
else
{
- g_variant_ref (result);
+ g_print ("FAILED: %s\n",
+ local_error->message);
}
- break;
- case G_DBUS_MESSAGE_TYPE_ERROR:
- g_dbus_message_to_gerror (reply, error);
- break;
+ _g_dbus_debug_print_unlock ();
+ }
- default:
- g_assert_not_reached ();
- break;
+ if (reply == NULL)
+ {
+ if (error != NULL)
+ *error = local_error;
+ else
+ g_error_free (local_error);
+ goto out;
}
+ result = decode_method_reply (reply, method_name, reply_type, out_fd_list, error);
+
+ out:
+ if (message != NULL)
+ g_object_unref (message);
+ if (reply != NULL)
+ g_object_unref (reply);
+
return result;
}
+/* ---------------------------------------------------------------------------------------------------- */
+
+/**
+ * g_dbus_connection_call:
+ * @connection: a #GDBusConnection
+ * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
+ * @connection is not a message bus connection
+ * @object_path: path of remote object
+ * @interface_name: D-Bus interface to invoke method on
+ * @method_name: the name of the method to invoke
+ * @parameters: (allow-none): a #GVariant tuple with parameters for the method
+ * or %NULL if not passing parameters
+ * @reply_type: (allow-none): the expected type of the reply, or %NULL
+ * @flags: flags from the #GDBusCallFlags enumeration
+ * @timeout_msec: the timeout in milliseconds, -1 to use the default
+ * timeout or %G_MAXINT for no timeout
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: (allow-none): a #GAsyncReadyCallback to call when the request
+ * is satisfied or %NULL if you don't care about the result of the
+ * method invocation
+ * @user_data: the data to pass to @callback
+ *
+ * Asynchronously invokes the @method_name method on the
+ * @interface_name D-Bus interface on the remote object at
+ * @object_path owned by @bus_name.
+ *
+ * If @connection is closed then the operation will fail with
+ * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will
+ * fail with %G_IO_ERROR_CANCELLED. If @parameters contains a value
+ * not compatible with the D-Bus protocol, the operation fails with
+ * %G_IO_ERROR_INVALID_ARGUMENT.
+ *
+ * If @reply_type is non-%NULL then the reply will be checked for having this type and an
+ * error will be raised if it does not match. Said another way, if you give a @reply_type
+ * then any non-%NULL return value will be of this type.
+ *
+ * If the @parameters #GVariant is floating, it is consumed. This allows
+ * convenient 'inline' use of g_variant_new(), e.g.:
+ * |[<!-- language="C" -->
+ * g_dbus_connection_call (connection,
+ * "org.freedesktop.StringThings",
+ * "/org/freedesktop/StringThings",
+ * "org.freedesktop.StringThings",
+ * "TwoStrings",
+ * g_variant_new ("(ss)",
+ * "Thing One",
+ * "Thing Two"),
+ * NULL,
+ * G_DBUS_CALL_FLAGS_NONE,
+ * -1,
+ * NULL,
+ * (GAsyncReadyCallback) two_strings_done,
+ * NULL);
+ * ]|
+ *
+ * This is an asynchronous method. When the operation is finished,
+ * @callback will be invoked in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread you are calling this method from. You can then call
+ * g_dbus_connection_call_finish() to get the result of the operation.
+ * See g_dbus_connection_call_sync() for the synchronous version of this
+ * function.
+ *
+ * If @callback is %NULL then the D-Bus method call message will be sent with
+ * the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.
+ *
+ * Since: 2.26
+ */
+void
+g_dbus_connection_call (GDBusConnection *connection,
+ const gchar *bus_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *method_name,
+ GVariant *parameters,
+ const GVariantType *reply_type,
+ GDBusCallFlags flags,
+ gint timeout_msec,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ g_dbus_connection_call_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, NULL, cancellable, callback, user_data);
+}
+
/**
- * g_dbus_connection_invoke_method_finish:
- * @connection: A #GDBusConnection.
- * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_invoke_method().
- * @error: Return location for error or %NULL.
+ * g_dbus_connection_call_finish:
+ * @connection: a #GDBusConnection
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call()
+ * @error: return location for error or %NULL
*
- * Finishes an operation started with g_dbus_connection_invoke_method().
+ * Finishes an operation started with g_dbus_connection_call().
*
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
- * return values. Free with g_variant_unref().
+ * return values. Free with g_variant_unref().
+ *
+ * Since: 2.26
*/
GVariant *
-g_dbus_connection_invoke_method_finish (GDBusConnection *connection,
- GAsyncResult *res,
- GError **error)
+g_dbus_connection_call_finish (GDBusConnection *connection,
+ GAsyncResult *res,
+ GError **error)
{
- GDBusMessage *reply;
- GVariant *result;
-
- g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
- g_return_val_if_fail (error == NULL || *error == NULL, NULL);
-
- result = NULL;
-
- reply = g_dbus_connection_send_message_with_reply_finish (connection, res, error);
- if (reply == NULL)
- goto out;
-
- result = decode_method_reply (reply, error);
-
- g_object_unref (reply);
-
- out:
- return result;
+ return g_dbus_connection_call_finish_internal (connection, NULL, res, error);
}
-/* ---------------------------------------------------------------------------------------------------- */
-
/**
- * g_dbus_connection_invoke_method_sync:
- * @connection: A #GDBusConnection.
- * @bus_name: A unique or well-known bus name.
- * @object_path: Path of remote object.
- * @interface_name: D-Bus interface to invoke method on.
- * @method_name: The name of the method to invoke.
- * @parameters: A #GVariant tuple with parameters for the method or %NULL if not passing parameters.
- * @flags: Flags from the #GDBusInvokeMethodFlags enumeration.
- * @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
- * @cancellable: A #GCancellable or %NULL.
- * @error: Return location for error or %NULL.
+ * g_dbus_connection_call_sync:
+ * @connection: a #GDBusConnection
+ * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
+ * @connection is not a message bus connection
+ * @object_path: path of remote object
+ * @interface_name: D-Bus interface to invoke method on
+ * @method_name: the name of the method to invoke
+ * @parameters: (allow-none): a #GVariant tuple with parameters for the method
+ * or %NULL if not passing parameters
+ * @reply_type: (allow-none): the expected type of the reply, or %NULL
+ * @flags: flags from the #GDBusCallFlags enumeration
+ * @timeout_msec: the timeout in milliseconds, -1 to use the default
+ * timeout or %G_MAXINT for no timeout
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
*
* Synchronously invokes the @method_name method on the
* @interface_name D-Bus interface on the remote object at
* operation will fail with %G_IO_ERROR_CANCELLED. If @parameters
* contains a value not compatible with the D-Bus protocol, the operation
* fails with %G_IO_ERROR_INVALID_ARGUMENT.
+
+ * If @reply_type is non-%NULL then the reply will be checked for having
+ * this type and an error will be raised if it does not match. Said
+ * another way, if you give a @reply_type then any non-%NULL return
+ * value will be of this type.
+ *
+ * If the @parameters #GVariant is floating, it is consumed.
+ * This allows convenient 'inline' use of g_variant_new(), e.g.:
+ * |[<!-- language="C" -->
+ * g_dbus_connection_call_sync (connection,
+ * "org.freedesktop.StringThings",
+ * "/org/freedesktop/StringThings",
+ * "org.freedesktop.StringThings",
+ * "TwoStrings",
+ * g_variant_new ("(ss)",
+ * "Thing One",
+ * "Thing Two"),
+ * NULL,
+ * G_DBUS_CALL_FLAGS_NONE,
+ * -1,
+ * NULL,
+ * &error);
+ * ]|
*
* The calling thread is blocked until a reply is received. See
- * g_dbus_connection_invoke_method() for the asynchronous version of
+ * g_dbus_connection_call() for the asynchronous version of
* this method.
*
* Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
- * return values. Free with g_variant_unref().
+ * return values. Free with g_variant_unref().
+ *
+ * Since: 2.26
*/
GVariant *
-g_dbus_connection_invoke_method_sync (GDBusConnection *connection,
- const gchar *bus_name,
- const gchar *object_path,
- const gchar *interface_name,
- const gchar *method_name,
- GVariant *parameters,
- GDBusInvokeMethodFlags flags,
- gint timeout_msec,
- GCancellable *cancellable,
- GError **error)
-{
- GDBusMessage *message;
- GDBusMessage *reply;
- GVariant *result;
-
- message = NULL;
- reply = NULL;
- result = NULL;
-
- g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- g_return_val_if_fail (bus_name == NULL || g_dbus_is_name (bus_name), NULL);
- g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), NULL);
- g_return_val_if_fail (interface_name != NULL && g_dbus_is_interface_name (interface_name), NULL);
- g_return_val_if_fail (method_name != NULL && g_dbus_is_member_name (method_name), NULL);
- g_return_val_if_fail (timeout_msec >= 0 || timeout_msec == -1, NULL);
- g_return_val_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
-
- message = g_dbus_message_new_method_call (bus_name,
- object_path,
- interface_name,
- method_name);
- add_invoke_method_flags (message, flags);
- if (parameters != NULL)
- g_dbus_message_set_body (message, parameters);
+g_dbus_connection_call_sync (GDBusConnection *connection,
+ const gchar *bus_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *method_name,
+ GVariant *parameters,
+ const GVariantType *reply_type,
+ GDBusCallFlags flags,
+ gint timeout_msec,
+ GCancellable *cancellable,
+ GError **error)
+{
+ return g_dbus_connection_call_sync_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, NULL, NULL, cancellable, error);
+}
- reply = g_dbus_connection_send_message_with_reply_sync (connection,
- message,
- timeout_msec,
- NULL, /* volatile guint32 *out_serial */
- cancellable,
- error);
+/* ---------------------------------------------------------------------------------------------------- */
- if (reply == NULL)
- goto out;
+#ifdef G_OS_UNIX
- result = decode_method_reply (reply, error);
+/**
+ * g_dbus_connection_call_with_unix_fd_list:
+ * @connection: a #GDBusConnection
+ * @bus_name: (allow-none): a unique or well-known bus name or %NULL if
+ * @connection is not a message bus connection
+ * @object_path: path of remote object
+ * @interface_name: D-Bus interface to invoke method on
+ * @method_name: the name of the method to invoke
+ * @parameters: (allow-none): a #GVariant tuple with parameters for the method
+ * or %NULL if not passing parameters
+ * @reply_type: (allow-none): the expected type of the reply, or %NULL
+ * @flags: flags from the #GDBusCallFlags enumeration
+ * @timeout_msec: the timeout in milliseconds, -1 to use the default
+ * timeout or %G_MAXINT for no timeout
+ * @fd_list: (allow-none): a #GUnixFDList or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is
+ * satisfied or %NULL if you don't * care about the result of the
+ * method invocation
+ * @user_data: The data to pass to @callback.
+ *
+ * Like g_dbus_connection_call() but also takes a #GUnixFDList object.
+ *
+ * This method is only available on UNIX.
+ *
+ * Since: 2.30
+ */
+void
+g_dbus_connection_call_with_unix_fd_list (GDBusConnection *connection,
+ const gchar *bus_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *method_name,
+ GVariant *parameters,
+ const GVariantType *reply_type,
+ GDBusCallFlags flags,
+ gint timeout_msec,
+ GUnixFDList *fd_list,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ g_dbus_connection_call_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, fd_list, cancellable, callback, user_data);
+}
- out:
- if (message != NULL)
- g_object_unref (message);
- if (reply != NULL)
- g_object_unref (reply);
+/**
+ * g_dbus_connection_call_with_unix_fd_list_finish:
+ * @connection: a #GDBusConnection
+ * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed to
+ * g_dbus_connection_call_with_unix_fd_list()
+ * @error: return location for error or %NULL
+ *
+ * Finishes an operation started with g_dbus_connection_call_with_unix_fd_list().
+ *
+ * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
+ * return values. Free with g_variant_unref().
+ *
+ * Since: 2.30
+ */
+GVariant *
+g_dbus_connection_call_with_unix_fd_list_finish (GDBusConnection *connection,
+ GUnixFDList **out_fd_list,
+ GAsyncResult *res,
+ GError **error)
+{
+ return g_dbus_connection_call_finish_internal (connection, out_fd_list, res, error);
+}
- return result;
+/**
+ * g_dbus_connection_call_with_unix_fd_list_sync:
+ * @connection: a #GDBusConnection
+ * @bus_name: (allow-none): a unique or well-known bus name or %NULL
+ * if @connection is not a message bus connection
+ * @object_path: path of remote object
+ * @interface_name: D-Bus interface to invoke method on
+ * @method_name: the name of the method to invoke
+ * @parameters: (allow-none): a #GVariant tuple with parameters for
+ * the method or %NULL if not passing parameters
+ * @reply_type: (allow-none): the expected type of the reply, or %NULL
+ * @flags: flags from the #GDBusCallFlags enumeration
+ * @timeout_msec: the timeout in milliseconds, -1 to use the default
+ * timeout or %G_MAXINT for no timeout
+ * @fd_list: (allow-none): a #GUnixFDList or %NULL
+ * @out_fd_list: (out) (allow-none): return location for a #GUnixFDList or %NULL
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
+ *
+ * Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects.
+ *
+ * This method is only available on UNIX.
+ *
+ * Returns: %NULL if @error is set. Otherwise a #GVariant tuple with
+ * return values. Free with g_variant_unref().
+ *
+ * Since: 2.30
+ */
+GVariant *
+g_dbus_connection_call_with_unix_fd_list_sync (GDBusConnection *connection,
+ const gchar *bus_name,
+ const gchar *object_path,
+ const gchar *interface_name,
+ const gchar *method_name,
+ GVariant *parameters,
+ const GVariantType *reply_type,
+ GDBusCallFlags flags,
+ gint timeout_msec,
+ GUnixFDList *fd_list,
+ GUnixFDList **out_fd_list,
+ GCancellable *cancellable,
+ GError **error)
+{
+ return g_dbus_connection_call_sync_internal (connection, bus_name, object_path, interface_name, method_name, parameters, reply_type, flags, timeout_msec, fd_list, out_fd_list, cancellable, error);
}
+#endif /* G_OS_UNIX */
+
/* ---------------------------------------------------------------------------------------------------- */
struct ExportedSubtree
guint id;
gchar *object_path;
GDBusConnection *connection;
- const GDBusSubtreeVTable *vtable;
+ GDBusSubtreeVTable *vtable;
GDBusSubtreeFlags flags;
GMainContext *context;
static void
exported_subtree_free (ExportedSubtree *es)
{
- if (es->user_data_free_func != NULL)
- {
- /* TODO: push to thread-default mainloop */
- es->user_data_free_func (es->user_data);
- }
- if (es->context != NULL)
- {
- g_main_context_unref (es->context);
- }
+ call_destroy_notify (es->context,
+ es->user_data_free_func,
+ es->user_data);
+
+ g_main_context_unref (es->context);
+
+ _g_dbus_subtree_vtable_free (es->vtable);
g_free (es->object_path);
g_free (es);
}
-/* called without lock held */
+/* called without lock held in the thread where the caller registered
+ * the subtree
+ */
static gboolean
-handle_subtree_introspect (GDBusConnection *connection,
- ExportedSubtree *es,
- GDBusMessage *message)
+handle_subtree_introspect (GDBusConnection *connection,
+ ExportedSubtree *es,
+ GDBusMessage *message)
{
GString *s;
gboolean handled;
const gchar *sender;
const gchar *requested_object_path;
const gchar *requested_node;
- GPtrArray *interfaces;
+ GDBusInterfaceInfo **interfaces;
guint n;
gchar **subnode_paths;
+ gboolean has_properties_interface;
+ gboolean has_introspectable_interface;
handled = FALSE;
}
else
{
- requested_node = "/";
+ requested_node = NULL;
}
interfaces = es->vtable->introspect (es->connection,
es->user_data);
if (interfaces != NULL)
{
- if (interfaces->len > 0)
+ has_properties_interface = FALSE;
+ has_introspectable_interface = FALSE;
+
+ for (n = 0; interfaces[n] != NULL; n++)
{
- /* we're in business */
- introspect_append_standard_interfaces (s);
+ if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Properties") == 0)
+ has_properties_interface = TRUE;
+ else if (strcmp (interfaces[n]->name, "org.freedesktop.DBus.Introspectable") == 0)
+ has_introspectable_interface = TRUE;
+ }
+ if (!has_properties_interface)
+ g_string_append (s, introspect_properties_interface);
+ if (!has_introspectable_interface)
+ g_string_append (s, introspect_introspectable_interface);
- for (n = 0; n < interfaces->len; n++)
- {
- const GDBusInterfaceInfo *interface_info = interfaces->pdata[n];
- g_dbus_interface_info_generate_xml (interface_info, 2, s);
- }
+ for (n = 0; interfaces[n] != NULL; n++)
+ {
+ g_dbus_interface_info_generate_xml (interfaces[n], 2, s);
+ g_dbus_interface_info_unref (interfaces[n]);
}
- g_ptr_array_unref (interfaces);
+ g_free (interfaces);
}
/* then include <node> entries from the Subtree for the root */
if (is_root)
{
for (n = 0; children != NULL && children[n] != NULL; n++)
- {
- g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
- }
+ g_string_append_printf (s, " <node name=\"%s\"/>\n", children[n]);
}
/* finally include nodes registered below us */
subnode_paths = g_dbus_connection_list_registered (es->connection, requested_object_path);
for (n = 0; subnode_paths != NULL && subnode_paths[n] != NULL; n++)
- {
- g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
- }
+ g_string_append_printf (s, " <node name=\"%s\"/>\n", subnode_paths[n]);
g_strfreev (subnode_paths);
g_string_append (s, "</node>\n");
reply = g_dbus_message_new_method_reply (message);
g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
- g_dbus_connection_send_message (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
handled = TRUE;
return handled;
}
-/* called without lock held */
+/* called without lock held in the thread where the caller registered
+ * the subtree
+ */
static gboolean
-handle_subtree_method_invocation (GDBusConnection *connection,
- ExportedSubtree *es,
- GDBusMessage *message)
+handle_subtree_method_invocation (GDBusConnection *connection,
+ ExportedSubtree *es,
+ GDBusMessage *message)
{
- gboolean handled;;
+ gboolean handled;
const gchar *sender;
const gchar *interface_name;
const gchar *member;
const gchar *requested_object_path;
const gchar *requested_node;
gboolean is_root;
- gchar **children;
- const GDBusInterfaceInfo *introspection_data;
+ GDBusInterfaceInfo *interface_info;
const GDBusInterfaceVTable *interface_vtable;
gpointer interface_user_data;
guint n;
- GPtrArray *interfaces;
+ GDBusInterfaceInfo **interfaces;
gboolean is_property_get;
gboolean is_property_set;
gboolean is_property_get_all;
if (g_strcmp0 (interface_name, "org.freedesktop.DBus.Properties") == 0)
{
if (g_strcmp0 (member, "Get") == 0 && g_strcmp0 (signature, "ss") == 0)
- {
- is_property_get = TRUE;
- }
+ is_property_get = TRUE;
else if (g_strcmp0 (member, "Set") == 0 && g_strcmp0 (signature, "ssv") == 0)
- {
- is_property_set = TRUE;
- }
+ is_property_set = TRUE;
else if (g_strcmp0 (member, "GetAll") == 0 && g_strcmp0 (signature, "s") == 0)
- {
- is_property_get_all = TRUE;
- }
+ is_property_get_all = TRUE;
}
- children = es->vtable->enumerate (es->connection,
- sender,
- es->object_path,
- es->user_data);
-
if (!is_root)
{
requested_node = strrchr (requested_object_path, '/') + 1;
- /* If not dynamic, skip if requested node is not part of children */
- if (!(es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES) &&
- !_g_strv_has_string ((const gchar * const *) children, requested_node))
- goto out;
+ if (~es->flags & G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES)
+ {
+ /* We don't want to dispatch to unenumerated
+ * nodes, so ensure that the child exists.
+ */
+ gchar **children;
+ gboolean exists;
+
+ children = es->vtable->enumerate (es->connection,
+ sender,
+ es->object_path,
+ es->user_data);
+
+ exists = _g_strv_has_string ((const gchar * const *) children, requested_node);
+ g_strfreev (children);
+
+ if (!exists)
+ goto out;
+ }
}
else
{
- requested_node = "/";
+ requested_node = NULL;
}
/* get introspection data for the node */
requested_object_path,
requested_node,
es->user_data);
- g_assert (interfaces != NULL);
- introspection_data = NULL;
- for (n = 0; n < interfaces->len; n++)
+
+ if (interfaces == NULL)
+ goto out;
+
+ interface_info = NULL;
+ for (n = 0; interfaces[n] != NULL; n++)
{
- const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
- if (g_strcmp0 (id_n->name, interface_name) == 0)
- {
- introspection_data = id_n;
- }
+ if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
+ interface_info = interfaces[n];
}
/* dispatch the call if the user wants to handle it */
- if (introspection_data != NULL)
+ if (interface_info != NULL)
{
/* figure out where to dispatch the method call */
interface_user_data = NULL;
CONNECTION_LOCK (connection);
handled = validate_and_maybe_schedule_method_call (es->connection,
message,
- introspection_data,
+ 0,
+ es->id,
+ interface_info,
interface_vtable,
es->context,
interface_user_data);
else if (is_property_get || is_property_set || is_property_get_all)
{
if (is_property_get)
- g_variant_get (g_dbus_message_get_body (message), "(ss)", &interface_name, NULL);
+ g_variant_get (g_dbus_message_get_body (message), "(&s&s)", &interface_name, NULL);
else if (is_property_set)
- g_variant_get (g_dbus_message_get_body (message), "(ssv)", &interface_name, NULL, NULL);
+ g_variant_get (g_dbus_message_get_body (message), "(&s&sv)", &interface_name, NULL, NULL);
else if (is_property_get_all)
- g_variant_get (g_dbus_message_get_body (message), "(s)", &interface_name, NULL, NULL);
+ g_variant_get (g_dbus_message_get_body (message), "(&s)", &interface_name, NULL, NULL);
else
g_assert_not_reached ();
/* see if the object supports this interface at all */
- for (n = 0; n < interfaces->len; n++)
+ for (n = 0; interfaces[n] != NULL; n++)
{
- const GDBusInterfaceInfo *id_n = (const GDBusInterfaceInfo *) interfaces->pdata[n];
- if (g_strcmp0 (id_n->name, interface_name) == 0)
- {
- introspection_data = id_n;
- }
+ if (g_strcmp0 (interfaces[n]->name, interface_name) == 0)
+ interface_info = interfaces[n];
}
/* Fail with org.freedesktop.DBus.Error.InvalidArgs if the user-code
* claims it won't support the interface
*/
- if (introspection_data == NULL)
+ if (interface_info == NULL)
{
GDBusMessage *reply;
reply = g_dbus_message_new_method_error (message,
"org.freedesktop.DBus.Error.InvalidArgs",
- _("No such interface `%s'"),
+ _("No such interface '%s'"),
interface_name);
- g_dbus_connection_send_message (es->connection, reply, NULL, NULL);
+ g_dbus_connection_send_message (es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
handled = TRUE;
goto out;
&interface_user_data,
es->user_data);
if (interface_vtable == NULL)
- goto out;
+ {
+ g_warning ("The subtree introspection function indicates that '%s' "
+ "is a valid interface name, but calling the dispatch "
+ "function on that interface gave us NULL", interface_name);
+ goto out;
+ }
if (is_property_get || is_property_set)
{
CONNECTION_LOCK (connection);
handled = validate_and_maybe_schedule_property_getset (es->connection,
message,
+ 0,
+ es->id,
is_property_get,
- introspection_data,
+ interface_info,
interface_vtable,
es->context,
interface_user_data);
CONNECTION_LOCK (connection);
handled = validate_and_maybe_schedule_property_get_all (es->connection,
message,
- introspection_data,
+ 0,
+ es->id,
+ interface_info,
interface_vtable,
es->context,
interface_user_data);
out:
if (interfaces != NULL)
- g_ptr_array_unref (interfaces);
- g_strfreev (children);
+ {
+ for (n = 0; interfaces[n] != NULL; n++)
+ g_dbus_interface_info_unref (interfaces[n]);
+ g_free (interfaces);
+ }
+
return handled;
}
if (g_strcmp0 (g_dbus_message_get_interface (data->message), "org.freedesktop.DBus.Introspectable") == 0 &&
g_strcmp0 (g_dbus_message_get_member (data->message), "Introspect") == 0 &&
g_strcmp0 (g_dbus_message_get_signature (data->message), "") == 0)
- {
- handled = handle_subtree_introspect (data->es->connection,
- data->es,
- data->message);
- }
+ handled = handle_subtree_introspect (data->es->connection,
+ data->es,
+ data->message);
else
- {
- handled = handle_subtree_method_invocation (data->es->connection,
- data->es,
- data->message);
- }
-
+ handled = handle_subtree_method_invocation (data->es->connection,
+ data->es,
+ data->message);
if (!handled)
{
GDBusMessage *reply;
reply = g_dbus_message_new_method_error (data->message,
"org.freedesktop.DBus.Error.UnknownMethod",
- _("Method `%s' on interface `%s' with signature `%s' does not exist"),
+ _("Method '%s' on interface '%s' with signature '%s' does not exist"),
g_dbus_message_get_member (data->message),
g_dbus_message_get_interface (data->message),
g_dbus_message_get_signature (data->message));
- g_dbus_connection_send_message (data->es->connection, reply, NULL, NULL);
+ g_dbus_connection_send_message (data->es->connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
}
return FALSE;
}
-/* called in message handler thread with lock held */
+/* called in GDBusWorker thread with connection's lock held */
static gboolean
subtree_message_func (GDBusConnection *connection,
ExportedSubtree *es,
process_subtree_vtable_message_in_idle_cb,
data,
(GDestroyNotify) subtree_deferred_data_free);
+ g_source_set_name (idle_source, "[gio] process_subtree_vtable_message_in_idle_cb");
g_source_attach (idle_source, es->context);
g_source_unref (idle_source);
/**
* g_dbus_connection_register_subtree:
- * @connection: A #GDBusConnection.
- * @object_path: The object path to register the subtree at.
- * @vtable: A #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree.
- * @flags: Flags used to fine tune the behavior of the subtree.
- * @user_data: Data to pass to functions in @vtable.
- * @user_data_free_func: Function to call when the subtree is unregistered.
- * @error: Return location for error or %NULL.
+ * @connection: a #GDBusConnection
+ * @object_path: the object path to register the subtree at
+ * @vtable: a #GDBusSubtreeVTable to enumerate, introspect and
+ * dispatch nodes in the subtree
+ * @flags: flags used to fine tune the behavior of the subtree
+ * @user_data: data to pass to functions in @vtable
+ * @user_data_free_func: function to call when the subtree is unregistered
+ * @error: return location for error or %NULL
*
- * Registers a whole subtree of <quote>dynamic</quote> objects.
+ * Registers a whole subtree of dynamic objects.
*
* The @enumerate and @introspection functions in @vtable are used to
* convey, to remote callers, what nodes exist in the subtree rooted
* #gpointer will be used to call into the interface vtable for processing
* the request.
*
- * All calls into user-provided code will be invoked in the <link
- * linkend="g-main-context-push-thread-default">thread-default main
- * loop</link> of the thread you are calling this method from.
+ * All calls into user-provided code will be invoked in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread you are calling this method from.
*
* If an existing subtree is already registered at @object_path or
* then @error is set to #G_IO_ERROR_EXISTS.
* g_dbus_connection_register_object()) in a subtree registered with
* g_dbus_connection_register_subtree() - if so, the subtree handler
* is tried as the last resort. One way to think about a subtree
- * handler is to consider it a <quote>fallback handler</quote>
- * for object paths not registered via g_dbus_connection_register_object()
- * or other bindings.
+ * handler is to consider it a fallback handler for object paths not
+ * registered via g_dbus_connection_register_object() or other bindings.
*
- * See <xref linkend="gdbus-subtree-server"/> for an example of how to use this method.
+ * Note that @vtable will be copied so you cannot change it after
+ * registration.
+ *
+ * See this [server][gdbus-subtree-server] for an example of how to use
+ * this method.
*
* Returns: 0 if @error is set, otherwise a subtree registration id (never 0)
* that can be used with g_dbus_connection_unregister_subtree() .
+ *
+ * Since: 2.26
*/
guint
-g_dbus_connection_register_subtree (GDBusConnection *connection,
- const gchar *object_path,
- const GDBusSubtreeVTable *vtable,
- GDBusSubtreeFlags flags,
- gpointer user_data,
- GDestroyNotify user_data_free_func,
- GError **error)
+g_dbus_connection_register_subtree (GDBusConnection *connection,
+ const gchar *object_path,
+ const GDBusSubtreeVTable *vtable,
+ GDBusSubtreeFlags flags,
+ gpointer user_data,
+ GDestroyNotify user_data_free_func,
+ GError **error)
{
guint ret;
ExportedSubtree *es;
g_return_val_if_fail (object_path != NULL && g_variant_is_object_path (object_path), 0);
g_return_val_if_fail (vtable != NULL, 0);
g_return_val_if_fail (error == NULL || *error == NULL, 0);
+ g_return_val_if_fail (check_initialized (connection), 0);
ret = 0;
CONNECTION_LOCK (connection);
- es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
+ es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
if (es != NULL)
{
g_set_error (error,
es->object_path = g_strdup (object_path);
es->connection = connection;
- es->vtable = vtable;
+ es->vtable = _g_dbus_subtree_vtable_copy (vtable);
es->flags = flags;
es->id = _global_subtree_registration_id++; /* TODO: overflow etc. */
es->user_data = user_data;
es->user_data_free_func = user_data_free_func;
- es->context = g_main_context_get_thread_default ();
- if (es->context != NULL)
- g_main_context_ref (es->context);
+ es->context = g_main_context_ref_thread_default ();
- g_hash_table_insert (connection->priv->map_object_path_to_es, es->object_path, es);
- g_hash_table_insert (connection->priv->map_id_to_es,
+ g_hash_table_insert (connection->map_object_path_to_es, es->object_path, es);
+ g_hash_table_insert (connection->map_id_to_es,
GUINT_TO_POINTER (es->id),
es);
/**
* g_dbus_connection_unregister_subtree:
- * @connection: A #GDBusConnection.
- * @registration_id: A subtree registration id obtained from g_dbus_connection_register_subtree().
+ * @connection: a #GDBusConnection
+ * @registration_id: a subtree registration id obtained from
+ * g_dbus_connection_register_subtree()
*
* Unregisters a subtree.
*
- * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise.
+ * Returns: %TRUE if the subtree was unregistered, %FALSE otherwise
+ *
+ * Since: 2.26
*/
gboolean
g_dbus_connection_unregister_subtree (GDBusConnection *connection,
gboolean ret;
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (check_initialized (connection), FALSE);
ret = FALSE;
CONNECTION_LOCK (connection);
- es = g_hash_table_lookup (connection->priv->map_id_to_es,
+ es = g_hash_table_lookup (connection->map_id_to_es,
GUINT_TO_POINTER (registration_id));
if (es == NULL)
- {
- goto out;
- }
+ goto out;
- g_warn_if_fail (g_hash_table_remove (connection->priv->map_id_to_es, GUINT_TO_POINTER (es->id)));
- g_warn_if_fail (g_hash_table_remove (connection->priv->map_object_path_to_es, es->object_path));
+ g_warn_if_fail (g_hash_table_remove (connection->map_id_to_es, GUINT_TO_POINTER (es->id)));
+ g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_es, es->object_path));
ret = TRUE;
/* ---------------------------------------------------------------------------------------------------- */
-/* must be called with lock held */
+/* may be called in any thread, with connection's lock held */
static void
-handle_generic_ping_unlocked (GDBusConnection *connection,
- const gchar *object_path,
- GDBusMessage *message)
+handle_generic_ping_unlocked (GDBusConnection *connection,
+ const gchar *object_path,
+ GDBusMessage *message)
{
GDBusMessage *reply;
reply = g_dbus_message_new_method_reply (message);
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
}
-/* must be called with lock held */
+/* may be called in any thread, with connection's lock held */
static void
-handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
- const gchar *object_path,
- GDBusMessage *message)
+handle_generic_get_machine_id_unlocked (GDBusConnection *connection,
+ const gchar *object_path,
+ GDBusMessage *message)
{
GDBusMessage *reply;
reply = NULL;
- if (connection->priv->machine_id == NULL)
+ if (connection->machine_id == NULL)
{
GError *error;
+
error = NULL;
- /* TODO: use PACKAGE_LOCALSTATEDIR ? */
- if (!g_file_get_contents ("/var/lib/dbus/machine-id",
- &connection->priv->machine_id,
- NULL,
- &error))
+ connection->machine_id = _g_dbus_get_machine_id (&error);
+ if (connection->machine_id == NULL)
{
- reply = g_dbus_message_new_method_error (message,
- "org.freedesktop.DBus.Error.Failed",
- _("Unable to load /var/lib/dbus/machine-id: %s"),
- error->message);
+ reply = g_dbus_message_new_method_error_literal (message,
+ "org.freedesktop.DBus.Error.Failed",
+ error->message);
g_error_free (error);
}
- else
- {
- g_strstrip (connection->priv->machine_id);
- /* TODO: validate value */
- }
}
if (reply == NULL)
{
reply = g_dbus_message_new_method_reply (message);
- g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->priv->machine_id));
+ g_dbus_message_set_body (reply, g_variant_new ("(s)", connection->machine_id));
}
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
}
-/* must be called with lock held */
+/* may be called in any thread, with connection's lock held */
static void
-handle_generic_introspect_unlocked (GDBusConnection *connection,
- const gchar *object_path,
- GDBusMessage *message)
+handle_generic_introspect_unlocked (GDBusConnection *connection,
+ const gchar *object_path,
+ GDBusMessage *message)
{
guint n;
GString *s;
registered = g_dbus_connection_list_registered_unlocked (connection, object_path);
for (n = 0; registered != NULL && registered[n] != NULL; n++)
- {
g_string_append_printf (s, " <node name=\"%s\"/>\n", registered[n]);
- }
g_strfreev (registered);
g_string_append (s, "</node>\n");
reply = g_dbus_message_new_method_reply (message);
g_dbus_message_set_body (reply, g_variant_new ("(s)", s->str));
- g_dbus_connection_send_message_unlocked (connection, reply, NULL, NULL);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
g_object_unref (reply);
g_string_free (s, TRUE);
}
-/* must be called with lock held */
+/* may be called in any thread, with connection's lock held */
static gboolean
handle_generic_unlocked (GDBusConnection *connection,
GDBusMessage *message)
/* ---------------------------------------------------------------------------------------------------- */
-/* called in message handler thread with lock held */
+/* called in GDBusWorker thread with connection's lock held */
static void
-distribute_method_call (GDBusConnection *connection,
- GDBusMessage *message)
+distribute_method_call (GDBusConnection *connection,
+ GDBusMessage *message)
{
+ GDBusMessage *reply;
ExportedObject *eo;
ExportedSubtree *es;
const gchar *object_path;
const gchar *interface_name;
const gchar *member;
- const gchar *signature;
const gchar *path;
gchar *subtree_path;
gchar *needle;
- g_assert (g_dbus_message_get_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
+ g_assert (g_dbus_message_get_message_type (message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL);
interface_name = g_dbus_message_get_interface (message);
member = g_dbus_message_get_member (message);
- signature = g_dbus_message_get_signature (message);
path = g_dbus_message_get_path (message);
subtree_path = g_strdup (path);
needle = strrchr (subtree_path, '/');
subtree_path = NULL;
}
-#if 0
- g_debug ("interface = `%s'", interface_name);
- g_debug ("member = `%s'", member);
- g_debug ("signature = `%s'", signature);
- g_debug ("path = `%s'", path);
- g_debug ("subtree_path = `%s'", subtree_path != NULL ? subtree_path : "N/A");
-#endif
+
+ if (G_UNLIKELY (_g_dbus_debug_incoming ()))
+ {
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Incoming:\n"
+ " <<<< METHOD INVOCATION %s.%s()\n"
+ " on object %s\n"
+ " invoked by name %s\n"
+ " serial %d\n",
+ interface_name, member,
+ path,
+ g_dbus_message_get_sender (message) != NULL ? g_dbus_message_get_sender (message) : "(none)",
+ g_dbus_message_get_serial (message));
+ _g_dbus_debug_print_unlock ();
+ }
object_path = g_dbus_message_get_path (message);
g_assert (object_path != NULL);
- eo = g_hash_table_lookup (connection->priv->map_object_path_to_eo, object_path);
+ eo = g_hash_table_lookup (connection->map_object_path_to_eo, object_path);
if (eo != NULL)
{
if (obj_message_func (connection, eo, message))
goto out;
}
- es = g_hash_table_lookup (connection->priv->map_object_path_to_es, object_path);
+ es = g_hash_table_lookup (connection->map_object_path_to_es, object_path);
if (es != NULL)
{
if (subtree_message_func (connection, es, message))
if (subtree_path != NULL)
{
- es = g_hash_table_lookup (connection->priv->map_object_path_to_es, subtree_path);
+ es = g_hash_table_lookup (connection->map_object_path_to_es, subtree_path);
if (es != NULL)
{
if (subtree_message_func (connection, es, message))
if (handle_generic_unlocked (connection, message))
goto out;
- /* if we end up here, the message has not been not handled */
+ /* if we end up here, the message has not been not handled - so return an error saying this */
+ reply = g_dbus_message_new_method_error (message,
+ "org.freedesktop.DBus.Error.UnknownMethod",
+ _("No such interface '%s' on object at path %s"),
+ interface_name,
+ object_path);
+ g_dbus_connection_send_message_unlocked (connection, reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
+ g_object_unref (reply);
out:
g_free (subtree_path);
/* ---------------------------------------------------------------------------------------------------- */
-static GDBusConnection **
+/* Called in any user thread, with the message_bus_lock held. */
+static GWeakRef *
message_bus_get_singleton (GBusType bus_type,
GError **error)
{
- GDBusConnection **ret;
+ GWeakRef *ret;
const gchar *starter_bus;
ret = NULL;
switch (bus_type)
{
- default:
- g_assert_not_reached ();
- break;
-
case G_BUS_TYPE_SESSION:
ret = &the_session_bus;
break;
G_IO_ERROR,
G_IO_ERROR_INVALID_ARGUMENT,
_("Cannot determine bus address from DBUS_STARTER_BUS_TYPE environment variable"
- " - unknown value `%s'"),
+ " - unknown value '%s'"),
starter_bus);
}
else
}
}
break;
+
+ default:
+ g_assert_not_reached ();
+ break;
}
+
out:
return ret;
}
+/* Called in any user thread, without holding locks. */
static GDBusConnection *
-get_uninitialized_connection (GBusType bus_type,
- GCancellable *cancellable,
- GError **error)
+get_uninitialized_connection (GBusType bus_type,
+ GCancellable *cancellable,
+ GError **error)
{
- GDBusConnection **singleton;
+ GWeakRef *singleton;
GDBusConnection *ret;
ret = NULL;
if (singleton == NULL)
goto out;
- if (*singleton == NULL)
+ ret = g_weak_ref_get (singleton);
+
+ if (ret == NULL)
{
gchar *address;
address = g_dbus_address_get_for_bus_sync (bus_type, cancellable, error);
if (address == NULL)
goto out;
- ret = *singleton = g_object_new (G_TYPE_DBUS_CONNECTION,
- "address", address,
- "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
- G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
- "exit-on-close", TRUE,
- NULL);
- }
- else
- {
- ret = g_object_ref (*singleton);
+ ret = g_object_new (G_TYPE_DBUS_CONNECTION,
+ "address", address,
+ "flags", G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT |
+ G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
+ "exit-on-close", TRUE,
+ NULL);
+
+ g_weak_ref_set (singleton, ret);
+ g_free (address);
}
g_assert (ret != NULL);
return ret;
}
+/* May be called from any thread. Must not hold message_bus_lock. */
+GDBusConnection *
+_g_bus_get_singleton_if_exists (GBusType bus_type)
+{
+ GWeakRef *singleton;
+ GDBusConnection *ret = NULL;
+
+ G_LOCK (message_bus_lock);
+ singleton = message_bus_get_singleton (bus_type, NULL);
+ if (singleton == NULL)
+ goto out;
+
+ ret = g_weak_ref_get (singleton);
+
+ out:
+ G_UNLOCK (message_bus_lock);
+ return ret;
+}
+
/**
* g_bus_get_sync:
- * @bus_type: A #GBusType.
- * @cancellable: A #GCancellable or %NULL.
- * @error: Return location for error or %NULL.
+ * @bus_type: a #GBusType
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @error: return location for error or %NULL
*
* Synchronously connects to the message bus specified by @bus_type.
* Note that the returned object may shared with other callers,
* The returned object is a singleton, that is, shared with other
* callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
* event that you need a private message bus connection, use
- * g_dbus_address_get_for_bus() and
+ * g_dbus_address_get_for_bus_sync() and
* g_dbus_connection_new_for_address().
*
* Note that the returned #GDBusConnection object will (usually) have
* the #GDBusConnection:exit-on-close property set to %TRUE.
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
+ * Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
-g_bus_get_sync (GBusType bus_type,
- GCancellable *cancellable,
- GError **error)
+g_bus_get_sync (GBusType bus_type,
+ GCancellable *cancellable,
+ GError **error)
{
GDBusConnection *connection;
&error))
{
g_assert (error != NULL);
- g_simple_async_result_set_from_error (simple, error);
- g_error_free (error);
+ g_simple_async_result_take_error (simple, error);
g_object_unref (source_object);
}
else
/**
* g_bus_get:
- * @bus_type: A #GBusType.
- * @cancellable: A #GCancellable or %NULL.
- * @callback: A #GAsyncReadyCallback to call when the request is satisfied.
- * @user_data: The data to pass to @callback.
+ * @bus_type: a #GBusType
+ * @cancellable: (allow-none): a #GCancellable or %NULL
+ * @callback: a #GAsyncReadyCallback to call when the request is satisfied
+ * @user_data: the data to pass to @callback
*
* Asynchronously connects to the message bus specified by @bus_type.
*
*
* This is a asynchronous failable function. See g_bus_get_sync() for
* the synchronous version.
+ *
+ * Since: 2.26
*/
void
g_bus_get (GBusType bus_type,
callback,
user_data,
g_bus_get);
+ g_simple_async_result_set_check_cancellable (simple, cancellable);
error = NULL;
connection = get_uninitialized_connection (bus_type, cancellable, &error);
if (connection == NULL)
{
g_assert (error != NULL);
- g_simple_async_result_set_from_error (simple, error);
- g_error_free (error);
+ g_simple_async_result_take_error (simple, error);
g_simple_async_result_complete_in_idle (simple);
g_object_unref (simple);
}
/**
* g_bus_get_finish:
- * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get().
- * @error: Return location for error or %NULL.
+ * @res: a #GAsyncResult obtained from the #GAsyncReadyCallback passed
+ * to g_bus_get()
+ * @error: return location for error or %NULL
*
* Finishes an operation started with g_bus_get().
*
* The returned object is a singleton, that is, shared with other
* callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
* event that you need a private message bus connection, use
- * g_dbus_address_get_for_bus() and
+ * g_dbus_address_get_for_bus_sync() and
* g_dbus_connection_new_for_address().
*
* Note that the returned #GDBusConnection object will (usually) have
* the #GDBusConnection:exit-on-close property set to %TRUE.
*
- * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref().
+ * Returns: (transfer full): a #GDBusConnection or %NULL if @error is set.
+ * Free with g_object_unref().
+ *
+ * Since: 2.26
*/
GDBusConnection *
g_bus_get_finish (GAsyncResult *res,