1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Author: David Zeuthen <davidz@redhat.com>
26 #include "gdbusutils.h"
27 #include "gdbusnamewatching.h"
28 #include "gdbuserror.h"
29 #include "gdbusprivate.h"
30 #include "gdbusconnection.h"
35 * SECTION:gdbusnamewatching
36 * @title: Watching Bus Names
37 * @short_description: Simple API for watching bus names
40 * Convenience API for watching bus names.
42 * <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>
45 G_LOCK_DEFINE_STATIC (lock);
47 /* ---------------------------------------------------------------------------------------------------- */
51 PREVIOUS_CALL_NONE = 0,
52 PREVIOUS_CALL_APPEARED,
53 PREVIOUS_CALL_VANISHED,
58 volatile gint ref_count;
61 GBusNameWatcherFlags flags;
63 GBusNameAppearedCallback name_appeared_handler;
64 GBusNameVanishedCallback name_vanished_handler;
66 GDestroyNotify user_data_free_func;
67 GMainContext *main_context;
69 GDBusConnection *connection;
70 gulong disconnected_signal_handler_id;
71 guint name_owner_changed_subscription_id;
73 PreviousCall previous_call;
79 static guint next_global_id = 1;
80 static GHashTable *map_id_to_client = NULL;
83 client_ref (Client *client)
85 g_atomic_int_inc (&client->ref_count);
90 client_unref (Client *client)
92 if (g_atomic_int_dec_and_test (&client->ref_count))
94 if (client->connection != NULL)
96 if (client->name_owner_changed_subscription_id > 0)
97 g_dbus_connection_signal_unsubscribe (client->connection, client->name_owner_changed_subscription_id);
98 if (client->disconnected_signal_handler_id > 0)
99 g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
100 g_object_unref (client->connection);
102 g_free (client->name);
103 g_free (client->name_owner);
104 g_main_context_unref (client->main_context);
105 if (client->user_data_free_func != NULL)
106 client->user_data_free_func (client->user_data);
111 /* ---------------------------------------------------------------------------------------------------- */
115 CALL_TYPE_NAME_APPEARED,
116 CALL_TYPE_NAME_VANISHED
123 /* keep this separate because client->connection may
124 * be set to NULL after scheduling the call
126 GDBusConnection *connection;
135 call_handler_data_free (CallHandlerData *data)
137 if (data->connection != NULL)
138 g_object_unref (data->connection);
139 g_free (data->name_owner);
140 client_unref (data->client);
145 actually_do_call (Client *client, GDBusConnection *connection, const gchar *name_owner, CallType call_type)
149 case CALL_TYPE_NAME_APPEARED:
150 if (client->name_appeared_handler != NULL)
152 client->name_appeared_handler (connection,
159 case CALL_TYPE_NAME_VANISHED:
160 if (client->name_vanished_handler != NULL)
162 client->name_vanished_handler (connection,
169 g_assert_not_reached ();
175 call_in_idle_cb (gpointer _data)
177 CallHandlerData *data = _data;
178 actually_do_call (data->client, data->connection, data->name_owner, data->call_type);
183 schedule_call_in_idle (Client *client, CallType call_type)
185 CallHandlerData *data;
186 GSource *idle_source;
188 data = g_new0 (CallHandlerData, 1);
189 data->client = client_ref (client);
190 data->connection = client->connection != NULL ? g_object_ref (client->connection) : NULL;
191 data->name_owner = g_strdup (client->name_owner);
192 data->call_type = call_type;
194 idle_source = g_idle_source_new ();
195 g_source_set_priority (idle_source, G_PRIORITY_HIGH);
196 g_source_set_callback (idle_source,
199 (GDestroyNotify) call_handler_data_free);
200 g_source_attach (idle_source, client->main_context);
201 g_source_unref (idle_source);
205 do_call (Client *client, CallType call_type)
207 GMainContext *current_context;
209 /* only schedule in idle if we're not in the right thread */
210 current_context = g_main_context_ref_thread_default ();
211 if (current_context != client->main_context)
212 schedule_call_in_idle (client, call_type);
214 actually_do_call (client, client->connection, client->name_owner, call_type);
215 g_main_context_unref (current_context);
219 call_appeared_handler (Client *client)
221 if (client->previous_call != PREVIOUS_CALL_APPEARED)
223 client->previous_call = PREVIOUS_CALL_APPEARED;
224 if (!client->cancelled && client->name_appeared_handler != NULL)
226 do_call (client, CALL_TYPE_NAME_APPEARED);
232 call_vanished_handler (Client *client,
233 gboolean ignore_cancelled)
235 if (client->previous_call != PREVIOUS_CALL_VANISHED)
237 client->previous_call = PREVIOUS_CALL_VANISHED;
238 if (((!client->cancelled) || ignore_cancelled) && client->name_vanished_handler != NULL)
240 do_call (client, CALL_TYPE_NAME_VANISHED);
245 /* ---------------------------------------------------------------------------------------------------- */
248 on_connection_disconnected (GDBusConnection *connection,
249 gboolean remote_peer_vanished,
253 Client *client = user_data;
255 if (client->name_owner_changed_subscription_id > 0)
256 g_dbus_connection_signal_unsubscribe (client->connection, client->name_owner_changed_subscription_id);
257 if (client->disconnected_signal_handler_id > 0)
258 g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
259 g_object_unref (client->connection);
260 client->disconnected_signal_handler_id = 0;
261 client->name_owner_changed_subscription_id = 0;
262 client->connection = NULL;
264 call_vanished_handler (client, FALSE);
267 /* ---------------------------------------------------------------------------------------------------- */
270 on_name_owner_changed (GDBusConnection *connection,
271 const gchar *sender_name,
272 const gchar *object_path,
273 const gchar *interface_name,
274 const gchar *signal_name,
275 GVariant *parameters,
278 Client *client = user_data;
280 const gchar *old_owner;
281 const gchar *new_owner;
283 if (!client->initialized)
286 if (g_strcmp0 (object_path, "/org/freedesktop/DBus") != 0 ||
287 g_strcmp0 (interface_name, "org.freedesktop.DBus") != 0 ||
288 g_strcmp0 (sender_name, "org.freedesktop.DBus") != 0)
291 g_variant_get (parameters,
297 /* we only care about a specific name */
298 if (g_strcmp0 (name, client->name) != 0)
301 if ((old_owner != NULL && strlen (old_owner) > 0) && client->name_owner != NULL)
303 g_free (client->name_owner);
304 client->name_owner = NULL;
305 call_vanished_handler (client, FALSE);
308 if (new_owner != NULL && strlen (new_owner) > 0)
310 g_warn_if_fail (client->name_owner == NULL);
311 g_free (client->name_owner);
312 client->name_owner = g_strdup (new_owner);
313 call_appeared_handler (client);
320 /* ---------------------------------------------------------------------------------------------------- */
323 get_name_owner_cb (GObject *source_object,
327 Client *client = user_data;
329 const char *name_owner;
334 result = g_dbus_connection_call_finish (client->connection,
339 g_variant_get (result, "(&s)", &name_owner);
342 if (name_owner != NULL)
344 g_warn_if_fail (client->name_owner == NULL);
345 client->name_owner = g_strdup (name_owner);
346 call_appeared_handler (client);
350 call_vanished_handler (client, FALSE);
353 client->initialized = TRUE;
356 g_variant_unref (result);
357 client_unref (client);
360 /* ---------------------------------------------------------------------------------------------------- */
363 invoke_get_name_owner (Client *client)
365 g_dbus_connection_call (client->connection,
366 "org.freedesktop.DBus", /* bus name */
367 "/org/freedesktop/DBus", /* object path */
368 "org.freedesktop.DBus", /* interface name */
369 "GetNameOwner", /* method name */
370 g_variant_new ("(s)", client->name),
371 G_VARIANT_TYPE ("(s)"),
372 G_DBUS_CALL_FLAGS_NONE,
375 (GAsyncReadyCallback) get_name_owner_cb,
376 client_ref (client));
379 /* ---------------------------------------------------------------------------------------------------- */
382 start_service_by_name_cb (GObject *source_object,
386 Client *client = user_data;
391 result = g_dbus_connection_call_finish (client->connection,
396 guint32 start_service_result;
397 g_variant_get (result, "(u)", &start_service_result);
399 if (start_service_result == 1) /* DBUS_START_REPLY_SUCCESS */
401 invoke_get_name_owner (client);
403 else if (start_service_result == 2) /* DBUS_START_REPLY_ALREADY_RUNNING */
405 invoke_get_name_owner (client);
409 g_warning ("Unexpected reply %d from StartServiceByName() method", start_service_result);
410 call_vanished_handler (client, FALSE);
411 client->initialized = TRUE;
416 /* Errors are not unexpected; the bus will reply e.g.
418 * org.freedesktop.DBus.Error.ServiceUnknown: The name org.gnome.Epiphany2
419 * was not provided by any .service files
421 * This doesn't mean that the name doesn't have an owner, just
422 * that it's not provided by a .service file. So proceed to
423 * invoke GetNameOwner().
425 invoke_get_name_owner (client);
429 g_variant_unref (result);
430 client_unref (client);
433 /* ---------------------------------------------------------------------------------------------------- */
436 has_connection (Client *client)
438 /* listen for disconnection */
439 client->disconnected_signal_handler_id = g_signal_connect (client->connection,
441 G_CALLBACK (on_connection_disconnected),
444 /* start listening to NameOwnerChanged messages immediately */
445 client->name_owner_changed_subscription_id = g_dbus_connection_signal_subscribe (client->connection,
446 "org.freedesktop.DBus", /* name */
447 "org.freedesktop.DBus", /* if */
448 "NameOwnerChanged", /* signal */
449 "/org/freedesktop/DBus", /* path */
451 G_DBUS_SIGNAL_FLAGS_NONE,
452 on_name_owner_changed,
456 if (client->flags & G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
458 g_dbus_connection_call (client->connection,
459 "org.freedesktop.DBus", /* bus name */
460 "/org/freedesktop/DBus", /* object path */
461 "org.freedesktop.DBus", /* interface name */
462 "StartServiceByName", /* method name */
463 g_variant_new ("(su)", client->name, 0),
464 G_VARIANT_TYPE ("(u)"),
465 G_DBUS_CALL_FLAGS_NONE,
468 (GAsyncReadyCallback) start_service_by_name_cb,
469 client_ref (client));
474 invoke_get_name_owner (client);
480 connection_get_cb (GObject *source_object,
484 Client *client = user_data;
486 client->connection = g_bus_get_finish (res, NULL);
487 if (client->connection == NULL)
489 call_vanished_handler (client, FALSE);
493 has_connection (client);
496 client_unref (client);
499 /* ---------------------------------------------------------------------------------------------------- */
503 * @bus_type: The type of bus to watch a name on.
504 * @name: The name (well-known or unique) to watch.
505 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
506 * @name_appeared_handler: (allow-none): Handler to invoke when @name is known to exist or %NULL.
507 * @name_vanished_handler: (allow-none): Handler to invoke when @name is known to not exist or %NULL.
508 * @user_data: User data to pass to handlers.
509 * @user_data_free_func: (allow-none): Function for freeing @user_data or %NULL.
511 * Starts watching @name on the bus specified by @bus_type and calls
512 * @name_appeared_handler and @name_vanished_handler when the name is
513 * known to have a owner respectively known to lose its
514 * owner. Callbacks will be invoked in the <link
515 * linkend="g-main-context-push-thread-default">thread-default main
516 * loop</link> of the thread you are calling this function from.
518 * You are guaranteed that one of the handlers will be invoked after
519 * calling this function. When you are done watching the name, just
520 * call g_bus_unwatch_name() with the watcher id this function
523 * If the name vanishes or appears (for example the application owning
524 * the name could restart), the handlers are also invoked. If the
525 * #GDBusConnection that is used for watching the name disconnects, then
526 * @name_vanished_handler is invoked since it is no longer
527 * possible to access the name.
529 * Another guarantee is that invocations of @name_appeared_handler
530 * and @name_vanished_handler are guaranteed to alternate; that
531 * is, if @name_appeared_handler is invoked then you are
532 * guaranteed that the next time one of the handlers is invoked, it
533 * will be @name_vanished_handler. The reverse is also true.
535 * This behavior makes it very simple to write applications that wants
536 * to take action when a certain name exists, see <xref
537 * linkend="gdbus-watching-names"/>. Basically, the application
538 * should create object proxies in @name_appeared_handler and destroy
539 * them again (if any) in @name_vanished_handler.
541 * Returns: An identifier (never 0) that an be used with
542 * g_bus_unwatch_name() to stop watching the name.
547 g_bus_watch_name (GBusType bus_type,
549 GBusNameWatcherFlags flags,
550 GBusNameAppearedCallback name_appeared_handler,
551 GBusNameVanishedCallback name_vanished_handler,
553 GDestroyNotify user_data_free_func)
557 g_return_val_if_fail (g_dbus_is_name (name), 0);
561 client = g_new0 (Client, 1);
562 client->ref_count = 1;
563 client->id = next_global_id++; /* TODO: uh oh, handle overflow */
564 client->name = g_strdup (name);
565 client->flags = flags;
566 client->name_appeared_handler = name_appeared_handler;
567 client->name_vanished_handler = name_vanished_handler;
568 client->user_data = user_data;
569 client->user_data_free_func = user_data_free_func;
570 client->main_context = g_main_context_ref_thread_default ();
572 if (map_id_to_client == NULL)
574 map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
576 g_hash_table_insert (map_id_to_client,
577 GUINT_TO_POINTER (client->id),
583 client_ref (client));
591 * g_bus_watch_name_on_connection:
592 * @connection: A #GDBusConnection.
593 * @name: The name (well-known or unique) to watch.
594 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
595 * @name_appeared_handler: (allow-none): Handler to invoke when @name is known to exist or %NULL.
596 * @name_vanished_handler: (allow-none): Handler to invoke when @name is known to not exist or %NULL.
597 * @user_data: User data to pass to handlers.
598 * @user_data_free_func: (allow-none): Function for freeing @user_data or %NULL.
600 * Like g_bus_watch_name() but takes a #GDBusConnection instead of a
603 * Returns: An identifier (never 0) that an be used with
604 * g_bus_unwatch_name() to stop watching the name.
608 guint g_bus_watch_name_on_connection (GDBusConnection *connection,
610 GBusNameWatcherFlags flags,
611 GBusNameAppearedCallback name_appeared_handler,
612 GBusNameVanishedCallback name_vanished_handler,
614 GDestroyNotify user_data_free_func)
618 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
619 g_return_val_if_fail (g_dbus_is_name (name), 0);
623 client = g_new0 (Client, 1);
624 client->ref_count = 1;
625 client->id = next_global_id++; /* TODO: uh oh, handle overflow */
626 client->name = g_strdup (name);
627 client->flags = flags;
628 client->name_appeared_handler = name_appeared_handler;
629 client->name_vanished_handler = name_vanished_handler;
630 client->user_data = user_data;
631 client->user_data_free_func = user_data_free_func;
632 client->main_context = g_main_context_ref_thread_default ();
634 if (map_id_to_client == NULL)
635 map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
637 g_hash_table_insert (map_id_to_client,
638 GUINT_TO_POINTER (client->id),
641 client->connection = g_object_ref (connection);
644 has_connection (client);
650 GClosure *name_appeared_closure;
651 GClosure *name_vanished_closure;
654 static WatchNameData *
655 watch_name_data_new (GClosure *name_appeared_closure,
656 GClosure *name_vanished_closure)
660 data = g_new0 (WatchNameData, 1);
662 if (name_appeared_closure != NULL)
664 data->name_appeared_closure = g_closure_ref (name_appeared_closure);
665 g_closure_sink (name_appeared_closure);
666 if (G_CLOSURE_NEEDS_MARSHAL (name_appeared_closure))
667 g_closure_set_marshal (name_appeared_closure, g_cclosure_marshal_generic);
670 if (name_vanished_closure != NULL)
672 data->name_vanished_closure = g_closure_ref (name_vanished_closure);
673 g_closure_sink (name_vanished_closure);
674 if (G_CLOSURE_NEEDS_MARSHAL (name_vanished_closure))
675 g_closure_set_marshal (name_vanished_closure, g_cclosure_marshal_generic);
682 watch_with_closures_on_name_appeared (GDBusConnection *connection,
684 const gchar *name_owner,
687 WatchNameData *data = user_data;
688 GValue params[3] = { G_VALUE_INIT, G_VALUE_INIT, G_VALUE_INIT };
690 g_value_init (¶ms[0], G_TYPE_DBUS_CONNECTION);
691 g_value_set_object (¶ms[0], connection);
693 g_value_init (¶ms[1], G_TYPE_STRING);
694 g_value_set_string (¶ms[1], name);
696 g_value_init (¶ms[2], G_TYPE_STRING);
697 g_value_set_string (¶ms[2], name_owner);
699 g_closure_invoke (data->name_appeared_closure, NULL, 3, params, NULL);
701 g_value_unset (params + 0);
702 g_value_unset (params + 1);
703 g_value_unset (params + 2);
707 watch_with_closures_on_name_vanished (GDBusConnection *connection,
711 WatchNameData *data = user_data;
712 GValue params[2] = { G_VALUE_INIT, G_VALUE_INIT };
714 g_value_init (¶ms[0], G_TYPE_DBUS_CONNECTION);
715 g_value_set_object (¶ms[0], connection);
717 g_value_init (¶ms[1], G_TYPE_STRING);
718 g_value_set_string (¶ms[1], name);
720 g_closure_invoke (data->name_vanished_closure, NULL, 2, params, NULL);
722 g_value_unset (params + 0);
723 g_value_unset (params + 1);
727 bus_watch_name_free_func (gpointer user_data)
729 WatchNameData *data = user_data;
731 if (data->name_appeared_closure != NULL)
732 g_closure_unref (data->name_appeared_closure);
734 if (data->name_vanished_closure != NULL)
735 g_closure_unref (data->name_vanished_closure);
741 * g_bus_watch_name_with_closures:
742 * @bus_type: The type of bus to watch a name on.
743 * @name: The name (well-known or unique) to watch.
744 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
745 * @name_appeared_closure: (allow-none): #GClosure to invoke when @name is known
747 * @name_vanished_closure: (allow-none): #GClosure to invoke when @name is known
748 * to not exist or %NULL.
750 * Version of g_bus_watch_name() using closures instead of callbacks for
751 * easier binding in other languages.
753 * Returns: An identifier (never 0) that an be used with
754 * g_bus_unwatch_name() to stop watching the name.
756 * Rename to: g_bus_watch_name
761 g_bus_watch_name_with_closures (GBusType bus_type,
763 GBusNameWatcherFlags flags,
764 GClosure *name_appeared_closure,
765 GClosure *name_vanished_closure)
767 return g_bus_watch_name (bus_type,
770 name_appeared_closure != NULL ? watch_with_closures_on_name_appeared : NULL,
771 name_vanished_closure != NULL ? watch_with_closures_on_name_vanished : NULL,
772 watch_name_data_new (name_appeared_closure, name_vanished_closure),
773 bus_watch_name_free_func);
777 * g_bus_watch_name_on_connection_with_closures:
778 * @connection: A #GDBusConnection.
779 * @name: The name (well-known or unique) to watch.
780 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
781 * @name_appeared_closure: (allow-none): #GClosure to invoke when @name is known
783 * @name_vanished_closure: (allow-none): #GClosure to invoke when @name is known
784 * to not exist or %NULL.
786 * Version of g_bus_watch_name_on_connection() using closures instead of callbacks for
787 * easier binding in other languages.
789 * Returns: An identifier (never 0) that an be used with
790 * g_bus_unwatch_name() to stop watching the name.
792 * Rename to: g_bus_watch_name_on_connection
796 guint g_bus_watch_name_on_connection_with_closures (
797 GDBusConnection *connection,
799 GBusNameWatcherFlags flags,
800 GClosure *name_appeared_closure,
801 GClosure *name_vanished_closure)
803 return g_bus_watch_name_on_connection (connection,
806 name_appeared_closure != NULL ? watch_with_closures_on_name_appeared : NULL,
807 name_vanished_closure != NULL ? watch_with_closures_on_name_vanished : NULL,
808 watch_name_data_new (name_appeared_closure, name_vanished_closure),
809 bus_watch_name_free_func);
813 * g_bus_unwatch_name:
814 * @watcher_id: An identifier obtained from g_bus_watch_name()
816 * Stops watching a name.
821 g_bus_unwatch_name (guint watcher_id)
825 g_return_if_fail (watcher_id > 0);
830 if (watcher_id == 0 ||
831 map_id_to_client == NULL ||
832 (client = g_hash_table_lookup (map_id_to_client, GUINT_TO_POINTER (watcher_id))) == NULL)
834 g_warning ("Invalid id %d passed to g_bus_unwatch_name()", watcher_id);
838 client->cancelled = TRUE;
839 g_warn_if_fail (g_hash_table_remove (map_id_to_client, GUINT_TO_POINTER (watcher_id)));
844 /* do callback without holding lock */
847 client_unref (client);