* - Need to rewrite GDBusAuth and rework GDBusAuthMechanism. In particular
* the mechanism VFuncs need to be able to set an error.
*
- * - The GDBusProxy::g-properties-changed signal currently looks like this
+ * - Need to document other mechanisms/sources for determining the D-Bus
+ * address of a well-known bus.
*
- * void user_function (GDBusProxy *proxy,
- * GHashTable *changed_properties,
- * gpointer user_data);
+ * - e.g. on Win32 we need code like from here
*
- * which is problematic because some people frown upon GHashTable
- * usage in public API (in particular some of the JS people). Maybe we
- * need to rework it, maybe it doesn't matter since GDBusProxy is
- * a low-level API and, for C code, we expect code generators to
- * spit out subclasses that automatically hook up to this signal
- * and does g_object_notify() anyway? Hmm...
+ * 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 (excect
+ * 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
* - 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 <string.h>
+#include <sys/types.h>
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
#include "gdbusauth.h"
#include "gdbusutils.h"
#include "gsimpleasyncresult.h"
#ifdef G_OS_UNIX
-#include <gio/gunixconnection.h>
-#include <gio/gunixfdmessage.h>
-#include <unistd.h>
-#include <sys/types.h>
+#include "gunixconnection.h"
+#include "gunixfdmessage.h"
#endif
#include "glibintl.h"
-#include "gioalias.h"
/**
* SECTION:gdbusconnection
*
* 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.
+ * g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
*
* <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>
*
* <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>
*
* <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>
+ *
+ * <example id="gdbus-export"><title>Exporting a GObject</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-export.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
*/
/* ---------------------------------------------------------------------------------------------------- */
+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;
/* ---------------------------------------------------------------------------------------------------- */
+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: A #GMainContext or %NULL.
+ * @callback: 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)
+{
+ if (callback == NULL)
+ goto out;
+
+ if (context == g_main_context_get_thread_default ())
+ {
+ callback (user_data);
+ }
+ else
+ {
+ GSource *idle_source;
+ CallDestroyNotifyData *data;
+
+ 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_attach (idle_source, data->context);
+ g_source_unref (idle_source);
+ }
+
+ out:
+ ;
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
static gboolean
_g_strv_has_string (const gchar* const *haystack,
const gchar *needle)
#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
+/**
+ * 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 ------------------------------------------------ */
/* ------------------------------------------------------------------------ */
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 */
+ 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 */
GHashTable *map_object_path_to_eo; /* gchar* -> ExportedObject* */
GDBusCapabilityFlags capabilities;
GDBusAuthObserver *authentication_observer;
- GCredentials *crendentials;
+ GCredentials *credentials;
+
+ /* set to TRUE when finalizing */
+ gboolean finalizing;
};
typedef struct ExportedObject ExportedObject;
G_IMPLEMENT_INTERFACE (G_TYPE_ASYNC_INITABLE, async_initable_iface_init)
);
+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;
{
the_system_bus = NULL;
}
- if (connection->priv->worker != NULL)
+ CONNECTION_LOCK (connection);
+ if (connection->worker != 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));
+ }
+ 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;
- if (connection->priv->auth != NULL)
- g_object_unref (connection->priv->auth);
+ purge_all_signal_subscriptions (connection);
- //g_debug ("finalizing %p", connection);
- if (connection->priv->stream != NULL)
+ purge_all_filters (connection);
+ g_ptr_array_unref (connection->filters);
+
+ if (connection->authentication_observer != NULL)
+ g_object_unref (connection->authentication_observer);
+
+ if (connection->auth != NULL)
+ g_object_unref (connection->auth);
+
+ 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_io_stream_close_async (connection->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->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_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);
- purge_all_filters (connection);
- g_ptr_array_unref (connection->priv->filters);
+ 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);
- if (connection->priv->main_context_at_construction != NULL)
- g_main_context_unref (connection->priv->main_context_at_construction);
+ if (connection->main_context_at_construction != NULL)
+ 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_free (connection->init_lock);
+ g_mutex_free (connection->lock);
G_OBJECT_CLASS (g_dbus_connection_parent_class)->finalize (object);
}
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:
gboolean remote_peer_vanished,
GError *error)
{
- if (remote_peer_vanished && connection->priv->exit_on_close)
+ if (remote_peer_vanished && connection->exit_on_close)
{
- g_print ("%s: Remote peer vanished. Exiting.\n", G_STRFUNC);
+ if (error != NULL)
+ {
+ g_print ("%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_print ("%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;
static void
g_dbus_connection_init (GDBusConnection *connection)
{
- connection->priv = G_TYPE_INSTANCE_GET_PRIVATE (connection, G_TYPE_DBUS_CONNECTION, GDBusConnectionPrivate);
-
- connection->priv->lock = g_mutex_new ();
- connection->priv->init_lock = g_mutex_new ();
+ connection->lock = g_mutex_new ();
+ connection->init_lock = g_mutex_new ();
- connection->priv->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
+ connection->map_method_serial_to_send_message_data = g_hash_table_new (g_direct_hash, g_direct_equal);
- 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_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_object_path_to_eo = g_hash_table_new_full (g_str_hash,
- g_str_equal,
- NULL,
- (GDestroyNotify) exported_object_free);
+ 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_id_to_ei = g_hash_table_new (g_direct_hash,
- g_direct_equal);
+ connection->map_id_to_ei = g_hash_table_new (g_direct_hash,
+ g_direct_equal);
- 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_object_path_to_es = g_hash_table_new_full (g_str_hash,
+ g_str_equal,
+ NULL,
+ (GDestroyNotify) exported_subtree_free);
- connection->priv->map_id_to_es = g_hash_table_new (g_direct_hash,
- g_direct_equal);
+ connection->map_id_to_es = 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_get_thread_default ();
+ if (connection->main_context_at_construction != NULL)
+ g_main_context_ref (connection->main_context_at_construction);
- connection->priv->filters = g_ptr_array_new ();
+ connection->filters = g_ptr_array_new ();
}
/**
g_dbus_connection_get_stream (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- return connection->priv->stream;
+ 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));
+ _g_dbus_worker_unfreeze (connection->worker);
+}
/**
* g_dbus_connection_is_closed:
g_dbus_connection_is_closed (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), FALSE);
- return connection->priv->closed;
+ return connection->closed;
}
/**
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;
+ return connection->capabilities;
}
+/* ---------------------------------------------------------------------------------------------------- */
+
+static void
+flush_in_thread_func (GSimpleAsyncResult *res,
+ GObject *object,
+ GCancellable *cancellable)
+{
+ GError *error;
+
+ error = NULL;
+ if (!g_dbus_connection_flush_sync (G_DBUS_CONNECTION (object),
+ cancellable,
+ &error))
+ {
+ g_simple_async_result_set_from_error (res, error);
+ g_error_free (error);
+ }
+}
+
+/**
+ * g_dbus_connection_flush:
+ * @connection: A #GDBusConnection.
+ * @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.
+ *
+ * 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 guarantee
+ * 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 <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_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)
+{
+ GSimpleAsyncResult *simple;
+
+ 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_run_in_thread (simple,
+ flush_in_thread_func,
+ G_PRIORITY_DEFAULT,
+ cancellable);
+ g_object_unref (simple);
+}
+
+/**
+ * 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: 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;
+
+ if (connection->closed)
+ {
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_CLOSED,
+ _("The connection is closed"));
+ goto out;
+ }
+
+ ret = _g_dbus_worker_flush_sync (connection->worker,
+ cancellable,
+ error);
+
+ out:
+ return ret;
+}
/* ---------------------------------------------------------------------------------------------------- */
CONNECTION_ENSURE_LOCK (connection);
- g_assert (!connection->priv->closed);
+ g_assert (!connection->closed);
- connection->priv->closed = TRUE;
+ connection->closed = TRUE;
data = g_new0 (EmitClosedData, 1);
data->connection = g_object_ref (connection);
emit_closed_in_idle,
data,
(GDestroyNotify) emit_closed_data_free);
- g_source_attach (idle_source, connection->priv->main_context_at_construction);
+ g_source_attach (idle_source, connection->main_context_at_construction);
g_source_unref (idle_source);
}
/* ---------------------------------------------------------------------------------------------------- */
+static void
+close_in_thread_func (GSimpleAsyncResult *res,
+ GObject *object,
+ GCancellable *cancellable)
+{
+ GError *error;
+
+ error = NULL;
+ if (!g_dbus_connection_close_sync (G_DBUS_CONNECTION (object),
+ cancellable,
+ &error))
+ {
+ g_simple_async_result_set_from_error (res, error);
+ g_error_free (error);
+ }
+}
+
/**
* g_dbus_connection_close:
* @connection: A #GDBusConnection.
+ * @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.
*
* 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 fails with
+ * %G_IO_ERROR_CLOSED.
+ *
+ * When @connection has been closed, the #GDBusConnection::closed
+ * signal is emitted in the <link
+ * linkend="g-main-context-push-thread-default">thread-default main
+ * loop</link> of the thread that @connection was constructed in.
*
- * If @connection is already closed, this method does nothing.
+ * 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_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));
- CONNECTION_LOCK (connection);
- if (!connection->priv->closed)
- {
- GError *error = NULL;
+ simple = g_simple_async_result_new (G_OBJECT (connection),
+ callback,
+ user_data,
+ g_dbus_connection_close);
+ g_simple_async_result_run_in_thread (simple,
+ close_in_thread_func,
+ G_PRIORITY_DEFAULT,
+ cancellable);
+ g_object_unref (simple);
+}
- /* 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);
- }
+/**
+ * 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;
- set_closed_unlocked (connection, FALSE, NULL);
+ 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;
+}
+
+/**
+ * g_dbus_connection_close_sync:
+ * @connection: A #GDBusConnection.
+ * @cancellable: 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;
+
+ CONNECTION_LOCK (connection);
+ if (!connection->closed)
+ {
+ ret = g_io_stream_close (connection->stream,
+ cancellable,
+ error);
+ if (ret)
+ set_closed_unlocked (connection, FALSE, NULL);
+ }
+ else
+ {
+ g_set_error_literal (error,
+ G_IO_ERROR,
+ G_IO_ERROR_CLOSED,
+ _("The connection is closed"));
}
CONNECTION_UNLOCK (connection);
+
+ return ret;
}
/* ---------------------------------------------------------------------------------------------------- */
static gboolean
g_dbus_connection_send_message_unlocked (GDBusConnection *connection,
GDBusMessage *message,
+ GDBusSendMessageFlags flags,
volatile guint32 *out_serial,
GError **error)
{
if (out_serial != NULL)
*out_serial = 0;
- if (connection->priv->closed)
+ if (connection->closed)
{
g_set_error_literal (error,
G_IO_ERROR,
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);
- _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
+ * @flags: Flags affecting how the message is sent.
* @out_serial: 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.
*
+ * 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.
*
gboolean
g_dbus_connection_send_message (GDBusConnection *connection,
GDBusMessage *message,
+ GDBusSendMessageFlags flags,
volatile guint32 *out_serial,
GError **error)
{
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;
}
data->cancellable_handler_id = 0;
}
- g_warn_if_fail (g_hash_table_remove (data->connection->priv->map_method_serial_to_send_message_data,
+ 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);
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,
goto out;
}
- if (connection->priv->closed)
+ if (connection->closed)
{
g_simple_async_result_set_error (simple,
G_IO_ERROR,
}
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_complete_in_idle (simple);
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.
+ * @flags: Flags affecting how the message is sent.
* @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.
*
* 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_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.
*
+ * Note that @message must be unlocked, unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
+ *
* 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.
void
g_dbus_connection_send_message_with_reply (GDBusConnection *connection,
GDBusMessage *message,
+ GDBusSendMessageFlags flags,
gint timeout_msec,
volatile guint32 *out_serial,
GCancellable *cancellable,
{
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:
+ * @connection: a #GDBusConnection
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply().
* @error: Return location for error or %NULL.
*
* linkend="gdbus-unix-fd-client"/> for an example of how to use this
* low-level API to send and receive UNIX file descriptors.
*
- * Returns: A #GDBusMessage or %NULL if @error is set.
+ * Returns: A locked #GDBusMessage or %NULL if @error is set.
*
* Since: 2.26
*/
* g_dbus_connection_send_message_with_reply_sync:
* @connection: A #GDBusConnection.
* @message: A #GDBusMessage.
+ * @flags: Flags affecting how the message is sent.
* @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.
* 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
* linkend="gdbus-unix-fd-client"/> for an example of how to use this
* low-level API to send and receive UNIX file descriptors.
*
- * Returns: A #GDBusMessage that is the reply to @message or %NULL if @error is set.
+ * Note that @message must be unlocked, unless @flags contain the
+ * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag.
+ *
+ * Returns: 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,
+ GDBusSendMessageFlags flags,
gint timeout_msec,
volatile guint32 *out_serial,
GCancellable *cancellable,
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), FALSE);
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,
GDBusMessage *message,
gpointer user_data)
{
- GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
+ GDBusConnection *connection;
FilterCallback *filters;
gboolean consumed_by_filter;
+ gboolean altered_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) */
+ /* then call the filters in order (without holding the lock) */
consumed_by_filter = FALSE;
+ altered_by_filter = FALSE;
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;
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 */
+static GDBusMessage *
+on_worker_message_about_to_be_sent (GDBusWorker *worker,
+ GDBusMessage *message,
+ gpointer user_data)
+{
+ GDBusConnection *connection;
+ FilterCallback *filters;
+ 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 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);
+ 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);
+
+ /* 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 in worker's thread - we must not block */
GError *error,
gpointer user_data)
{
- GDBusConnection *connection = G_DBUS_CONNECTION (user_data);
+ GDBusConnection *connection;
+ 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_closed: %s", error->message);
CONNECTION_LOCK (connection);
- if (!connection->priv->closed)
+ if (!connection->closed)
set_closed_unlocked (connection, remote_peer_vanished, error);
CONNECTION_UNLOCK (connection);
+
+ g_object_unref (connection);
}
/* ---------------------------------------------------------------------------------------------------- */
GDBusCapabilityFlags ret;
ret = G_DBUS_CAPABILITY_FLAGS_NONE;
#ifdef G_OS_UNIX
- if (G_IS_UNIX_CONNECTION (connection->priv->stream))
+ if (G_IS_UNIX_CONNECTION (connection->stream))
ret |= G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING;
#endif
return 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)
+ if (connection->is_initialized)
{
- if (connection->priv->stream != NULL)
+ if (connection->stream != NULL)
ret = TRUE;
else
- g_assert (connection->priv->initialization_error != NULL);
+ g_assert (connection->initialization_error != NULL);
goto out;
}
- g_assert (connection->priv->initialization_error == NULL);
+ 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_IO_ERROR,
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,
+ 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);
+#ifdef G_OS_UNIX
/* Hack used until
*
* https://bugzilla.gnome.org/show_bug.cgi?id=616458
*
* has been resolved
*/
- 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
- connection->priv->worker = _g_dbus_worker_new (connection->priv->stream,
- connection->priv->capabilities,
- on_worker_message_received,
- on_worker_closed,
- connection);
+ 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);
- /* 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)
+ connection->worker = _g_dbus_worker_new (connection->stream,
+ connection->capabilities,
+ (connection->flags & G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING),
+ on_worker_message_received,
+ on_worker_message_about_to_be_sent,
+ on_worker_closed,
+ 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)"),
+ G_DBUS_CALL_FLAGS_NONE,
+ -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;
+ connection->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_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 */
}
/* ---------------------------------------------------------------------------------------------------- */
* @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.
+ * @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.
* 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 @observer is not %NULL it may be used to control the
* authentication process.
*
* When the operation is finished, @callback will be invoked. You can
g_dbus_connection_new (GIOStream *stream,
const gchar *guid,
GDBusConnectionFlags flags,
- GDBusAuthObserver *authentication_observer,
+ GDBusAuthObserver *observer,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
"stream", stream,
"guid", guid,
"flags", flags,
- "authentication-observer", authentication_observer,
+ "authentication-observer", observer,
NULL);
}
* @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.
+ * @observer: A #GDBusAuthObserver or %NULL.
* @cancellable: 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 @observer is not %NULL it may be used to control the
* authentication process.
*
* This is a synchronous failable constructor. See
g_dbus_connection_new_sync (GIOStream *stream,
const gchar *guid,
GDBusConnectionFlags flags,
- GDBusAuthObserver *authentication_observer,
+ GDBusAuthObserver *observer,
GCancellable *cancellable,
GError **error)
{
"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.
+ * @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.
* 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.
void
g_dbus_connection_new_for_address (const gchar *address,
GDBusConnectionFlags flags,
+ GDBusAuthObserver *observer,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
user_data,
"address", address,
"flags", flags,
+ "authentication-observer", observer,
NULL);
}
* g_dbus_connection_new_for_address_sync:
* @address: A D-Bus address.
* @flags: Flags describing how to make the connection.
+ * @observer: A #GDBusAuthObserver or %NULL.
* @cancellable: A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* This is a synchronous failable constructor. See
* g_dbus_connection_new_for_address() for the asynchronous version.
*
+ * 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,
+ GDBusAuthObserver *observer,
GCancellable *cancellable,
GError **error)
{
error,
"address", address,
"flags", flags,
+ "authentication-observer", observer,
NULL);
}
gboolean exit_on_close)
{
g_return_if_fail (G_IS_DBUS_CONNECTION (connection));
- connection->priv->exit_on_close = exit_on_close;
+ connection->exit_on_close = exit_on_close;
}
/**
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;
+ return connection->exit_on_close;
}
/**
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 (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- return connection->priv->bus_unique_name;
+ return connection->bus_unique_name;
}
/**
g_dbus_connection_get_peer_credentials (GDBusConnection *connection)
{
g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
- return connection->priv->crendentials;
+ return connection->credentials;
}
/* ---------------------------------------------------------------------------------------------------- */
* 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 - see the #GDBusMessageFilterResult
+ * enumeration for details.
*
* 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_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().
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)
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;
} 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 *
"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))
{
error = NULL;
if (!g_dbus_connection_send_message_unlocked (connection,
message,
+ G_DBUS_SEND_MESSAGE_FLAGS_NONE,
NULL,
&error))
{
static gboolean
is_signal_data_for_name_lost_or_acquired (SignalData *signal_data)
{
- return g_strcmp0 (signal_data->sender, "org.freedesktop.DBus") == 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_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.
+ * @sender: Sender name to match on (unique or well-known 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.
+ * @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: Function to free @user_data with when subscription is removed or %NULL.
* 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.
+ * If @connection is not a message bus connection, @sender must be
+ * %NULL.
*
- * 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.
+ * 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.
*
* Returns: A subscription identifier that can be used with g_dbus_connection_signal_unsubscribe().
*
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);
rule = args_to_rule (sender, interface_name, member, object_path, arg0);
- 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;
g_main_context_ref (subscriber.context);
/* 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->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);
* Avoid adding match rules for NameLost and NameAcquired messages - the bus will
* 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);
}
- 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 */
+/* must hold lock when calling this (except if connection->finalizing is TRUE) */
static void
unsubscribe_id_internal (GDBusConnection *connection,
guint subscription_id,
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)
{
if (!is_signal_data_for_name_lost_or_acquired (signal_data))
- remove_match_rule (connection, signal_data->rule);
+ if (!connection->closed && !connection->finalizing)
+ remove_match_rule (connection, signal_data->rule);
}
-
signal_data_free (signal_data);
}
{
SignalSubscriber *subscriber;
subscriber = &(g_array_index (subscribers, SignalSubscriber, n));
- if (subscriber->user_data_free_func != NULL)
- subscriber->user_data_free_func (subscriber->user_data);
+ call_destroy_notify (subscriber->context,
+ subscriber->user_data_free_func,
+ subscriber->user_data);
if (subscriber->context != NULL)
g_main_context_unref (subscriber->context);
}
}
#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);
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
sender = g_dbus_message_get_sender (message);
+ 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);
+ 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 subscribers not matching on sender */
- signal_data_array = g_hash_table_lookup (connection->priv->map_sender_to_signal_data_array, "");
+ 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);
}
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);
+ call_destroy_notify (subscriber->context,
+ subscriber->user_data_free_func,
+ subscriber->user_data);
if (subscriber->context != NULL)
g_main_context_unref (subscriber->context);
}
/* ---------------------------------------------------------------------------------------------------- */
+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)
- /* TODO: push to thread-default mainloop */
- ei->user_data_free_func (ei->user_data);
+ g_dbus_interface_info_unref ((GDBusInterfaceInfo *) ei->interface_info);
+
+ call_destroy_notify (ei->context,
+ ei->user_data_free_func,
+ ei->user_data);
if (ei->context != NULL)
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.
+ *
+ * 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)
+ {
+ ret = TRUE;
+ }
+ else if (subtree_registration_id != 0 && g_hash_table_lookup (connection->map_id_to_es,
+ GUINT_TO_POINTER (subtree_registration_id)) == NULL)
+ {
+ ret = TRUE;
+ }
+ CONNECTION_UNLOCK (connection);
+
+ return ret;
+}
+
+/* ---------------------------------------------------------------------------------------------------- */
+
typedef struct
{
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;
+ 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_assert_no_error (error);
- g_variant_ref_sink (value);
+ if (g_variant_is_floating (value))
+ g_variant_ref_sink (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;
}
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;
}
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);
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'"),
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;
"org.freedesktop.DBus.Error.InvalidArgs",
_("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;
"org.freedesktop.DBus.Error.InvalidArgs",
_("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;
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);
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);
"org.freedesktop.DBus.Error.InvalidArgs",
_("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;
+ GVariantBuilder builder;
GError *error;
GDBusMessage *reply;
guint n;
+ 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;
/* TODO: Right now we never fail this call - we just omit values if
* 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,
+ if (g_variant_is_floating (value))
+ g_variant_ref_sink (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;
}
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)
handled = FALSE;
g_variant_get (g_dbus_message_get_body (message),
- "(s)",
+ "(&s)",
&interface_name);
if (vtable == NULL || vtable->get_property == NULL)
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);
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);
" <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"
" <interface name=\"org.freedesktop.DBus.Introspectable\">\n"
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);
else
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);
/* 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);
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;
vtable = g_object_get_data (G_OBJECT (invocation), "g-dbus-interface-vtable");
g_assert (vtable != NULL && vtable->method_call != NULL);
+ 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->method_call (g_dbus_method_invocation_get_connection (invocation),
g_dbus_method_invocation_get_sender (invocation),
g_dbus_method_invocation_get_object_path (invocation),
g_object_ref (invocation),
g_dbus_method_invocation_get_user_data (invocation));
+ out:
return FALSE;
}
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)
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
"org.freedesktop.DBus.Error.UnknownMethod",
_("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);
}
+ /* 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;
+
+ 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 */
- 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);
+ 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);
+
+ /* 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,
- invoke_method_in_idle_cb,
+ call_in_idle_cb,
invocation,
g_object_unref);
g_source_attach (idle_source, main_context);
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.
+ * @interface_info: 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.
*
* 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.
*
* Note that all #GVariant values passed to functions in @vtable will match
- * the signature given in @introspection_data - if a remote caller passes
+ * the signature given in @interface_info - if a remote caller passes
* incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
* is returned to the remote caller.
*
* Additionally, if the remote caller attempts to invoke methods or
- * access properties not mentioned in @introspection_data the
+ * access properties not mentioned in @interface_info the
* <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
* <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
* are returned to the caller.
* If an existing callback is already registered at @object_path and
* @interface_name, then @error is set to #G_IO_ERROR_EXISTS.
*
+ * 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 <emphasis>can</emphasis> 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 <xref linkend="gdbus-server"/> for an example of how to use this method.
*
* Returns: 0 if @error is set, otherwise a registration id (never 0)
guint
g_dbus_connection_register_object (GDBusConnection *connection,
const gchar *object_path,
- const gchar *interface_name,
- const GDBusInterfaceInfo *introspection_data,
+ GDBusInterfaceInfo *interface_info,
const GDBusInterfaceVTable *vtable,
gpointer user_data,
GDestroyNotify user_data_free_func,
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);
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->vtable = _g_dbus_interface_vtable_copy (vtable);
+ ei->interface_info = g_dbus_interface_info_ref (interface_info);
+ ei->interface_name = g_strdup (interface_info->name);
ei->context = g_main_context_get_thread_default ();
if (ei->context != NULL)
g_main_context_ref (ei->context);
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);
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;
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,
+ g_warn_if_fail (g_hash_table_remove (connection->map_object_path_to_eo,
eo->object_path));
ret = TRUE;
*
* 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.
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);
+ 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 (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);
}
+static GVariant *
+decode_method_reply (GDBusMessage *reply,
+ const gchar *method_name,
+ const GVariantType *reply_type,
+ 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;
+ }
+ 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;
+} CallState;
+
+static void
+g_dbus_connection_call_done (GObject *source,
+ GAsyncResult *result,
+ gpointer user_data)
+{
+ GDBusConnection *connection = G_DBUS_CONNECTION (source);
+ CallState *state = user_data;
+ GError *error;
+ GDBusMessage *reply;
+ GVariant *value;
+
+ 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)
+ {
+ value = decode_method_reply (reply, state->method_name,
+ state->reply_type, &error);
+ g_object_unref (reply);
+ }
+ else
+ value = NULL;
+
+ if (value == NULL)
+ {
+ g_simple_async_result_set_from_error (state->simple, error);
+ g_error_free (error);
+ }
+ else
+ g_simple_async_result_set_op_res_gpointer (state->simple, value,
+ (GDestroyNotify) g_variant_unref);
+
+ g_simple_async_result_complete (state->simple);
+ g_variant_type_free (state->reply_type);
+ g_object_unref (state->simple);
+ g_free (state->method_name);
+
+ g_slice_free (CallState, state);
+}
+
/**
- * g_dbus_connection_invoke_method:
+ * g_dbus_connection_call:
* @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.
+ * @reply_type: The expected type of the reply, or %NULL.
+ * @flags: Flags from the #GDBusCallFlags 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
* 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.:
+ * |[
+ * 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 <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
+ * 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.
*
* Since: 2.26
*/
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)
+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)
{
GDBusMessage *message;
+ CallState *state;
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 (timeout_msec >= 0 || timeout_msec == -1);
g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
+ state = g_slice_new (CallState);
+ state->simple = g_simple_async_result_new (G_OBJECT (connection),
+ callback, user_data,
+ g_dbus_connection_call);
+ 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);
+
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,
+ G_DBUS_SEND_MESSAGE_FLAGS_NONE,
timeout_msec,
- NULL, /* volatile guint32 *out_serial */
+ &state->serial,
cancellable,
- callback,
- user_data);
-
- if (message != NULL)
- g_object_unref (message);
-}
-
-static GVariant *
-decode_method_reply (GDBusMessage *reply,
- GError **error)
-{
- GVariant *result;
+ g_dbus_connection_call_done,
+ state);
- result = NULL;
- switch (g_dbus_message_get_message_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)
- {
- result = g_variant_new ("()");
- g_variant_ref_sink (result);
- }
- else
- {
- g_variant_ref (result);
- }
- break;
-
- case G_DBUS_MESSAGE_TYPE_ERROR:
- g_dbus_message_to_gerror (reply, error);
- break;
-
- default:
- g_assert_not_reached ();
- break;
+ _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)",
+ state->serial);
+ _g_dbus_debug_print_unlock ();
}
- return result;
+ if (message != NULL)
+ g_object_unref (message);
}
/**
- * g_dbus_connection_invoke_method_finish:
+ * g_dbus_connection_call_finish:
* @connection: A #GDBusConnection.
- * @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_invoke_method().
+ * @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().
* 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;
+ GSimpleAsyncResult *simple;
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 (g_simple_async_result_is_valid (res, G_OBJECT (connection),
+ g_dbus_connection_call), 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);
+ simple = G_SIMPLE_ASYNC_RESULT (res);
- g_object_unref (reply);
+ if (g_simple_async_result_propagate_error (simple, error))
+ return NULL;
- out:
- return result;
+ return g_variant_ref (g_simple_async_result_get_op_res_gpointer (simple));
}
/* ---------------------------------------------------------------------------------------------------- */
/**
- * g_dbus_connection_invoke_method_sync:
+ * g_dbus_connection_call_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.
+ * @reply_type: The expected type of the reply, or %NULL.
+ * @flags: Flags from the #GDBusCallFlags 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.
* 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.:
+ * |[
+ * 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
* 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)
+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)
{
GDBusMessage *message;
GDBusMessage *reply;
GVariant *result;
+ GError *local_error;
message = NULL;
reply = 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);
+ 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_invoke_method_flags (message, flags);
+ add_call_flags (message, flags);
if (parameters != NULL)
g_dbus_message_set_body (message, parameters);
+ 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;
reply = g_dbus_connection_send_message_with_reply_sync (connection,
message,
+ G_DBUS_SEND_MESSAGE_FLAGS_NONE,
timeout_msec,
NULL, /* volatile guint32 *out_serial */
cancellable,
- error);
+ &local_error);
+
+ if (G_UNLIKELY (_g_dbus_debug_call ()))
+ {
+ _g_dbus_debug_print_lock ();
+ g_print ("========================================================================\n"
+ "GDBus-debug:Call:\n"
+ " <<<< SYNC COMPLETE %s.%s()\n"
+ " ",
+ interface_name,
+ method_name);
+ if (reply != NULL)
+ {
+ g_print ("SUCCESS\n");
+ }
+ else
+ {
+ g_print ("FAILED: %s\n",
+ local_error->message);
+ }
+ _g_dbus_debug_print_unlock ();
+ }
if (reply == NULL)
- goto out;
+ {
+ if (error != NULL)
+ *error = local_error;
+ else
+ g_error_free (local_error);
+ goto out;
+ }
- result = decode_method_reply (reply, error);
+ result = decode_method_reply (reply, method_name, reply_type, error);
out:
if (message != NULL)
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);
+ call_destroy_notify (es->context,
+ es->user_data_free_func,
+ es->user_data);
if (es->context != NULL)
g_main_context_unref (es->context);
+ _g_dbus_subtree_vtable_free (es->vtable);
g_free (es->object_path);
g_free (es);
}
const gchar *sender;
const gchar *requested_object_path;
const gchar *requested_node;
- GPtrArray *interfaces;
+ GDBusInterfaceInfo **interfaces;
guint n;
gchar **subnode_paths;
}
else
{
- requested_node = "/";
+ requested_node = NULL;
}
interfaces = es->vtable->introspect (es->connection,
es->user_data);
if (interfaces != NULL)
{
- if (interfaces->len > 0)
- {
- /* we're in business */
- introspect_append_standard_interfaces (s);
+ introspect_append_standard_interfaces (s);
- 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 */
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;
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;
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'"),
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;
}
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);
}
* for object paths not registered via g_dbus_connection_register_object()
* or other bindings.
*
+ * Note that @vtable will be copied so you cannot change it after
+ * registration.
+ *
* See <xref linkend="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)
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;
if (es->context != NULL)
g_main_context_ref (es->context);
- 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);
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;
- 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;
{
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);
}
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);
}
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);
}
distribute_method_call (GDBusConnection *connection,
GDBusMessage *message)
{
+ GDBusMessage *reply;
ExportedObject *eo;
ExportedSubtree *es;
const gchar *object_path;
subtree_path = NULL;
}
+
+ 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 ();
+ }
+
#if 0
g_debug ("interface = `%s'", interface_name);
g_debug ("member = `%s'", member);
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);
G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION,
"exit-on-close", TRUE,
NULL);
+ g_free (address);
}
else
{
* 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
}
/* ---------------------------------------------------------------------------------------------------- */
-
-#define __G_DBUS_CONNECTION_C__
-#include "gioaliasdef.c"