/* GDBus - GLib D-Bus Library
*
- * Copyright (C) 2008-2009 Red Hat, Inc.
+ * Copyright (C) 2008-2010 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: David Zeuthen <davidz@redhat.com>
*/
#include "config.h"
#include <stdlib.h>
-
-#include <glib/gi18n.h>
+#include <string.h>
#include "gdbusutils.h"
#include "gdbusnamewatching.h"
#include "gdbusprivate.h"
#include "gdbusconnection.h"
+#include "glibintl.h"
+
/**
* SECTION:gdbusnamewatching
* @title: Watching Bus Names
*
* Convenience API for watching bus names.
*
- * <example id="gdbus-watching-names"><title>Simple application watching a name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-watch-name.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
+ * A simple example for watching a name can be found in
+ * [gdbus-example-watch-name.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-watch-name.c)
*/
G_LOCK_DEFINE_STATIC (lock);
}
g_free (client->name);
g_free (client->name_owner);
- if (client->main_context != NULL)
- g_main_context_unref (client->main_context);
+ g_main_context_unref (client->main_context);
if (client->user_data_free_func != NULL)
client->user_data_free_func (client->user_data);
g_free (client);
call_in_idle_cb,
data,
(GDestroyNotify) call_handler_data_free);
+ g_source_set_name (idle_source, "[gio] call_in_idle_cb");
g_source_attach (idle_source, client->main_context);
g_source_unref (idle_source);
}
static void
do_call (Client *client, CallType call_type)
{
+ GMainContext *current_context;
+
/* only schedule in idle if we're not in the right thread */
- if (g_main_context_get_thread_default () != client->main_context)
+ current_context = g_main_context_ref_thread_default ();
+ if (current_context != client->main_context)
schedule_call_in_idle (client, call_type);
else
actually_do_call (client, client->connection, client->name_owner, call_type);
+ g_main_context_unref (current_context);
}
static void
goto out;
g_variant_get (parameters,
- "(sss)",
+ "(&s&s&s)",
&name,
&old_owner,
&new_owner);
name_owner = NULL;
result = NULL;
- result = g_dbus_connection_invoke_method_finish (client->connection,
- res,
- NULL);
+ result = g_dbus_connection_call_finish (client->connection,
+ res,
+ NULL);
if (result != NULL)
{
- g_variant_get (result, "(s)", &name_owner);
+ g_variant_get (result, "(&s)", &name_owner);
}
if (name_owner != NULL)
static void
invoke_get_name_owner (Client *client)
{
- g_dbus_connection_invoke_method (client->connection,
- "org.freedesktop.DBus", /* bus name */
- "/org/freedesktop/DBus", /* object path */
- "org.freedesktop.DBus", /* interface name */
- "GetNameOwner", /* method name */
- g_variant_new ("(s)", client->name),
- G_DBUS_INVOKE_METHOD_FLAGS_NONE,
- -1,
- NULL,
- (GAsyncReadyCallback) get_name_owner_cb,
- client_ref (client));
+ g_dbus_connection_call (client->connection,
+ "org.freedesktop.DBus", /* bus name */
+ "/org/freedesktop/DBus", /* object path */
+ "org.freedesktop.DBus", /* interface name */
+ "GetNameOwner", /* method name */
+ g_variant_new ("(s)", client->name),
+ G_VARIANT_TYPE ("(s)"),
+ G_DBUS_CALL_FLAGS_NONE,
+ -1,
+ NULL,
+ (GAsyncReadyCallback) get_name_owner_cb,
+ client_ref (client));
}
/* ---------------------------------------------------------------------------------------------------- */
result = NULL;
- result = g_dbus_connection_invoke_method_finish (client->connection,
- res,
- NULL);
+ result = g_dbus_connection_call_finish (client->connection,
+ res,
+ NULL);
if (result != NULL)
{
guint32 start_service_result;
* org.freedesktop.DBus.Error.ServiceUnknown: The name org.gnome.Epiphany2
* was not provided by any .service files
*
- * so just report vanished.
+ * This doesn't mean that the name doesn't have an owner, just
+ * that it's not provided by a .service file. So proceed to
+ * invoke GetNameOwner().
*/
- call_vanished_handler (client, FALSE);
- client->initialized = TRUE;
+ invoke_get_name_owner (client);
}
if (result != NULL)
"NameOwnerChanged", /* signal */
"/org/freedesktop/DBus", /* path */
client->name,
+ G_DBUS_SIGNAL_FLAGS_NONE,
on_name_owner_changed,
client,
NULL);
if (client->flags & G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
{
- g_dbus_connection_invoke_method (client->connection,
- "org.freedesktop.DBus", /* bus name */
- "/org/freedesktop/DBus", /* object path */
- "org.freedesktop.DBus", /* interface name */
- "StartServiceByName", /* method name */
- g_variant_new ("(su)", client->name, 0),
- G_DBUS_INVOKE_METHOD_FLAGS_NONE,
- -1,
- NULL,
- (GAsyncReadyCallback) start_service_by_name_cb,
- client_ref (client));
+ g_dbus_connection_call (client->connection,
+ "org.freedesktop.DBus", /* bus name */
+ "/org/freedesktop/DBus", /* object path */
+ "org.freedesktop.DBus", /* interface name */
+ "StartServiceByName", /* method name */
+ g_variant_new ("(su)", client->name, 0),
+ G_VARIANT_TYPE ("(u)"),
+ G_DBUS_CALL_FLAGS_NONE,
+ -1,
+ NULL,
+ (GAsyncReadyCallback) start_service_by_name_cb,
+ client_ref (client));
}
else
{
* @bus_type: The type of bus to watch a name on.
* @name: The name (well-known or unique) to watch.
* @flags: Flags from the #GBusNameWatcherFlags enumeration.
- * @name_appeared_handler: Handler to invoke when @name is known to exist or %NULL.
- * @name_vanished_handler: Handler to invoke when @name is known to not exist or %NULL.
+ * @name_appeared_handler: (allow-none): Handler to invoke when @name is known to exist or %NULL.
+ * @name_vanished_handler: (allow-none): Handler to invoke when @name is known to not exist or %NULL.
* @user_data: User data to pass to handlers.
- * @user_data_free_func: Function for freeing @user_data or %NULL.
+ * @user_data_free_func: (allow-none): Function for freeing @user_data or %NULL.
*
* Starts watching @name on the bus specified by @bus_type and calls
* @name_appeared_handler and @name_vanished_handler when the name is
* known to have a owner respectively known to lose its
- * owner. Callbacks 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 function from.
+ * owner. Callbacks will be invoked in the
+ * [thread-default main context][g-main-context-push-thread-default]
+ * of the thread you are calling this function from.
*
* You are guaranteed that one of the handlers will be invoked after
* calling this function. When you are done watching the name, just
* guaranteed that the next time one of the handlers is invoked, it
* will be @name_vanished_handler. The reverse is also true.
*
- * This behavior makes it very simple to write applications that wants
- * to take action when a certain name exists, see <xref
- * linkend="gdbus-watching-names"/>. Basically, the application
- * should create object proxies in @name_appeared_handler and destroy
- * them again (if any) in @name_vanished_handler.
+ * This behavior makes it very simple to write applications that want
+ * to take action when a certain [name exists][gdbus-watching-names].
+ * Basically, the application should create object proxies in
+ * @name_appeared_handler and destroy them again (if any) in
+ * @name_vanished_handler.
*
* Returns: An identifier (never 0) that an be used with
* g_bus_unwatch_name() to stop watching the name.
- **/
+ *
+ * Since: 2.26
+ */
guint
g_bus_watch_name (GBusType bus_type,
const gchar *name,
{
Client *client;
- g_return_val_if_fail (bus_type != G_BUS_TYPE_NONE, 0);
g_return_val_if_fail (g_dbus_is_name (name), 0);
G_LOCK (lock);
client->name_vanished_handler = name_vanished_handler;
client->user_data = user_data;
client->user_data_free_func = user_data_free_func;
- client->main_context = g_main_context_get_thread_default ();
- if (client->main_context != NULL)
- g_main_context_ref (client->main_context);
+ client->main_context = g_main_context_ref_thread_default ();
if (map_id_to_client == NULL)
{
}
/**
+ * g_bus_watch_name_on_connection:
+ * @connection: A #GDBusConnection.
+ * @name: The name (well-known or unique) to watch.
+ * @flags: Flags from the #GBusNameWatcherFlags enumeration.
+ * @name_appeared_handler: (allow-none): Handler to invoke when @name is known to exist or %NULL.
+ * @name_vanished_handler: (allow-none): Handler to invoke when @name is known to not exist or %NULL.
+ * @user_data: User data to pass to handlers.
+ * @user_data_free_func: (allow-none): Function for freeing @user_data or %NULL.
+ *
+ * Like g_bus_watch_name() but takes a #GDBusConnection instead of a
+ * #GBusType.
+ *
+ * Returns: An identifier (never 0) that an be used with
+ * g_bus_unwatch_name() to stop watching the name.
+ *
+ * Since: 2.26
+ */
+guint g_bus_watch_name_on_connection (GDBusConnection *connection,
+ const gchar *name,
+ GBusNameWatcherFlags flags,
+ GBusNameAppearedCallback name_appeared_handler,
+ GBusNameVanishedCallback name_vanished_handler,
+ gpointer user_data,
+ GDestroyNotify user_data_free_func)
+{
+ Client *client;
+
+ g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
+ g_return_val_if_fail (g_dbus_is_name (name), 0);
+
+ G_LOCK (lock);
+
+ client = g_new0 (Client, 1);
+ client->ref_count = 1;
+ client->id = next_global_id++; /* TODO: uh oh, handle overflow */
+ client->name = g_strdup (name);
+ client->flags = flags;
+ client->name_appeared_handler = name_appeared_handler;
+ client->name_vanished_handler = name_vanished_handler;
+ client->user_data = user_data;
+ client->user_data_free_func = user_data_free_func;
+ client->main_context = g_main_context_ref_thread_default ();
+
+ if (map_id_to_client == NULL)
+ map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
+
+ g_hash_table_insert (map_id_to_client,
+ GUINT_TO_POINTER (client->id),
+ client);
+
+ client->connection = g_object_ref (connection);
+ G_UNLOCK (lock);
+
+ has_connection (client);
+
+ return client->id;
+}
+
+typedef struct {
+ GClosure *name_appeared_closure;
+ GClosure *name_vanished_closure;
+} WatchNameData;
+
+static WatchNameData *
+watch_name_data_new (GClosure *name_appeared_closure,
+ GClosure *name_vanished_closure)
+{
+ WatchNameData *data;
+
+ data = g_new0 (WatchNameData, 1);
+
+ if (name_appeared_closure != NULL)
+ {
+ data->name_appeared_closure = g_closure_ref (name_appeared_closure);
+ g_closure_sink (name_appeared_closure);
+ if (G_CLOSURE_NEEDS_MARSHAL (name_appeared_closure))
+ g_closure_set_marshal (name_appeared_closure, g_cclosure_marshal_generic);
+ }
+
+ if (name_vanished_closure != NULL)
+ {
+ data->name_vanished_closure = g_closure_ref (name_vanished_closure);
+ g_closure_sink (name_vanished_closure);
+ if (G_CLOSURE_NEEDS_MARSHAL (name_vanished_closure))
+ g_closure_set_marshal (name_vanished_closure, g_cclosure_marshal_generic);
+ }
+
+ return data;
+}
+
+static void
+watch_with_closures_on_name_appeared (GDBusConnection *connection,
+ const gchar *name,
+ const gchar *name_owner,
+ gpointer user_data)
+{
+ WatchNameData *data = user_data;
+ GValue params[3] = { G_VALUE_INIT, G_VALUE_INIT, G_VALUE_INIT };
+
+ g_value_init (¶ms[0], G_TYPE_DBUS_CONNECTION);
+ g_value_set_object (¶ms[0], connection);
+
+ g_value_init (¶ms[1], G_TYPE_STRING);
+ g_value_set_string (¶ms[1], name);
+
+ g_value_init (¶ms[2], G_TYPE_STRING);
+ g_value_set_string (¶ms[2], name_owner);
+
+ g_closure_invoke (data->name_appeared_closure, NULL, 3, params, NULL);
+
+ g_value_unset (params + 0);
+ g_value_unset (params + 1);
+ g_value_unset (params + 2);
+}
+
+static void
+watch_with_closures_on_name_vanished (GDBusConnection *connection,
+ const gchar *name,
+ gpointer user_data)
+{
+ WatchNameData *data = user_data;
+ GValue params[2] = { G_VALUE_INIT, G_VALUE_INIT };
+
+ g_value_init (¶ms[0], G_TYPE_DBUS_CONNECTION);
+ g_value_set_object (¶ms[0], connection);
+
+ g_value_init (¶ms[1], G_TYPE_STRING);
+ g_value_set_string (¶ms[1], name);
+
+ g_closure_invoke (data->name_vanished_closure, NULL, 2, params, NULL);
+
+ g_value_unset (params + 0);
+ g_value_unset (params + 1);
+}
+
+static void
+bus_watch_name_free_func (gpointer user_data)
+{
+ WatchNameData *data = user_data;
+
+ if (data->name_appeared_closure != NULL)
+ g_closure_unref (data->name_appeared_closure);
+
+ if (data->name_vanished_closure != NULL)
+ g_closure_unref (data->name_vanished_closure);
+
+ g_free (data);
+}
+
+/**
+ * g_bus_watch_name_with_closures:
+ * @bus_type: The type of bus to watch a name on.
+ * @name: The name (well-known or unique) to watch.
+ * @flags: Flags from the #GBusNameWatcherFlags enumeration.
+ * @name_appeared_closure: (allow-none): #GClosure to invoke when @name is known
+ * to exist or %NULL.
+ * @name_vanished_closure: (allow-none): #GClosure to invoke when @name is known
+ * to not exist or %NULL.
+ *
+ * Version of g_bus_watch_name() using closures instead of callbacks for
+ * easier binding in other languages.
+ *
+ * Returns: An identifier (never 0) that an be used with
+ * g_bus_unwatch_name() to stop watching the name.
+ *
+ * Rename to: g_bus_watch_name
+ *
+ * Since: 2.26
+ */
+guint
+g_bus_watch_name_with_closures (GBusType bus_type,
+ const gchar *name,
+ GBusNameWatcherFlags flags,
+ GClosure *name_appeared_closure,
+ GClosure *name_vanished_closure)
+{
+ return g_bus_watch_name (bus_type,
+ name,
+ flags,
+ name_appeared_closure != NULL ? watch_with_closures_on_name_appeared : NULL,
+ name_vanished_closure != NULL ? watch_with_closures_on_name_vanished : NULL,
+ watch_name_data_new (name_appeared_closure, name_vanished_closure),
+ bus_watch_name_free_func);
+}
+
+/**
+ * g_bus_watch_name_on_connection_with_closures:
+ * @connection: A #GDBusConnection.
+ * @name: The name (well-known or unique) to watch.
+ * @flags: Flags from the #GBusNameWatcherFlags enumeration.
+ * @name_appeared_closure: (allow-none): #GClosure to invoke when @name is known
+ * to exist or %NULL.
+ * @name_vanished_closure: (allow-none): #GClosure to invoke when @name is known
+ * to not exist or %NULL.
+ *
+ * Version of g_bus_watch_name_on_connection() using closures instead of callbacks for
+ * easier binding in other languages.
+ *
+ * Returns: An identifier (never 0) that an be used with
+ * g_bus_unwatch_name() to stop watching the name.
+ *
+ * Rename to: g_bus_watch_name_on_connection
+ *
+ * Since: 2.26
+ */
+guint g_bus_watch_name_on_connection_with_closures (
+ GDBusConnection *connection,
+ const gchar *name,
+ GBusNameWatcherFlags flags,
+ GClosure *name_appeared_closure,
+ GClosure *name_vanished_closure)
+{
+ return g_bus_watch_name_on_connection (connection,
+ name,
+ flags,
+ name_appeared_closure != NULL ? watch_with_closures_on_name_appeared : NULL,
+ name_vanished_closure != NULL ? watch_with_closures_on_name_vanished : NULL,
+ watch_name_data_new (name_appeared_closure, name_vanished_closure),
+ bus_watch_name_free_func);
+}
+
+/**
* g_bus_unwatch_name:
* @watcher_id: An identifier obtained from g_bus_watch_name()
*
* Stops watching a name.
- **/
+ *
+ * Since: 2.26
+ */
void
g_bus_unwatch_name (guint watcher_id)
{