Blame gio/gdbusnamewatching.c

Packit ae235b
/* GDBus - GLib D-Bus Library
Packit ae235b
 *
Packit ae235b
 * Copyright (C) 2008-2010 Red Hat, Inc.
Packit ae235b
 *
Packit ae235b
 * This library is free software; you can redistribute it and/or
Packit ae235b
 * modify it under the terms of the GNU Lesser General Public
Packit ae235b
 * License as published by the Free Software Foundation; either
Packit ae235b
 * version 2.1 of the License, or (at your option) any later version.
Packit ae235b
 *
Packit ae235b
 * This library is distributed in the hope that it will be useful,
Packit ae235b
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 * Lesser General Public License for more details.
Packit ae235b
 *
Packit ae235b
 * You should have received a copy of the GNU Lesser General
Packit ae235b
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit ae235b
 *
Packit ae235b
 * Author: David Zeuthen <davidz@redhat.com>
Packit ae235b
 */
Packit ae235b
Packit ae235b
#include "config.h"
Packit ae235b
Packit ae235b
#include <stdlib.h>
Packit ae235b
#include <string.h>
Packit ae235b
Packit ae235b
#include "gdbusutils.h"
Packit ae235b
#include "gdbusnamewatching.h"
Packit ae235b
#include "gdbuserror.h"
Packit ae235b
#include "gdbusprivate.h"
Packit ae235b
#include "gdbusconnection.h"
Packit ae235b
Packit ae235b
#include "glibintl.h"
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * SECTION:gdbusnamewatching
Packit ae235b
 * @title: Watching Bus Names
Packit ae235b
 * @short_description: Simple API for watching bus names
Packit ae235b
 * @include: gio/gio.h
Packit ae235b
 *
Packit ae235b
 * Convenience API for watching bus names.
Packit ae235b
 *
Packit ae235b
 * A simple example for watching a name can be found in
Packit ae235b
 * [gdbus-example-watch-name.c](https://git.gnome.org/browse/glib/tree/gio/tests/gdbus-example-watch-name.c)
Packit ae235b
 */
Packit ae235b
Packit ae235b
G_LOCK_DEFINE_STATIC (lock);
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
typedef enum
Packit ae235b
{
Packit ae235b
  PREVIOUS_CALL_NONE = 0,
Packit ae235b
  PREVIOUS_CALL_APPEARED,
Packit ae235b
  PREVIOUS_CALL_VANISHED,
Packit ae235b
} PreviousCall;
Packit ae235b
Packit ae235b
typedef struct
Packit ae235b
{
Packit ae235b
  volatile gint             ref_count;
Packit ae235b
  guint                     id;
Packit ae235b
  gchar                    *name;
Packit ae235b
  GBusNameWatcherFlags      flags;
Packit ae235b
  gchar                    *name_owner;
Packit ae235b
  GBusNameAppearedCallback  name_appeared_handler;
Packit ae235b
  GBusNameVanishedCallback  name_vanished_handler;
Packit ae235b
  gpointer                  user_data;
Packit ae235b
  GDestroyNotify            user_data_free_func;
Packit ae235b
  GMainContext             *main_context;
Packit ae235b
Packit ae235b
  GDBusConnection          *connection;
Packit ae235b
  gulong                    disconnected_signal_handler_id;
Packit ae235b
  guint                     name_owner_changed_subscription_id;
Packit ae235b
Packit ae235b
  PreviousCall              previous_call;
Packit ae235b
Packit ae235b
  gboolean                  cancelled;
Packit ae235b
  gboolean                  initialized;
Packit ae235b
} Client;
Packit ae235b
Packit ae235b
/* Must be accessed atomically. */
Packit ae235b
static volatile guint next_global_id = 1;
Packit ae235b
Packit ae235b
/* Must be accessed with @lock held. */
Packit ae235b
static GHashTable *map_id_to_client = NULL;
Packit ae235b
Packit ae235b
static Client *
Packit ae235b
client_ref (Client *client)
Packit ae235b
{
Packit ae235b
  g_atomic_int_inc (&client->ref_count);
Packit ae235b
  return client;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
client_unref (Client *client)
Packit ae235b
{
Packit ae235b
  if (g_atomic_int_dec_and_test (&client->ref_count))
Packit ae235b
    {
Packit ae235b
      if (client->connection != NULL)
Packit ae235b
        {
Packit ae235b
          if (client->name_owner_changed_subscription_id > 0)
Packit ae235b
            g_dbus_connection_signal_unsubscribe (client->connection, client->name_owner_changed_subscription_id);
Packit ae235b
          if (client->disconnected_signal_handler_id > 0)
Packit ae235b
            g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
Packit ae235b
          g_object_unref (client->connection);
Packit ae235b
        }
Packit ae235b
      g_free (client->name);
Packit ae235b
      g_free (client->name_owner);
Packit ae235b
      g_main_context_unref (client->main_context);
Packit ae235b
      if (client->user_data_free_func != NULL)
Packit ae235b
        client->user_data_free_func (client->user_data);
Packit ae235b
      g_free (client);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
typedef enum
Packit ae235b
{
Packit ae235b
  CALL_TYPE_NAME_APPEARED,
Packit ae235b
  CALL_TYPE_NAME_VANISHED
Packit ae235b
} CallType;
Packit ae235b
Packit ae235b
typedef struct
Packit ae235b
{
Packit ae235b
  Client *client;
Packit ae235b
Packit ae235b
  /* keep this separate because client->connection may
Packit ae235b
   * be set to NULL after scheduling the call
Packit ae235b
   */
Packit ae235b
  GDBusConnection *connection;
Packit ae235b
Packit ae235b
  /* ditto */
Packit ae235b
  gchar *name_owner;
Packit ae235b
Packit ae235b
  CallType call_type;
Packit ae235b
} CallHandlerData;
Packit ae235b
Packit ae235b
static void
Packit ae235b
call_handler_data_free (CallHandlerData *data)
Packit ae235b
{
Packit ae235b
  if (data->connection != NULL)
Packit ae235b
    g_object_unref (data->connection);
Packit ae235b
  g_free (data->name_owner);
Packit ae235b
  client_unref (data->client);
Packit ae235b
  g_free (data);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
actually_do_call (Client *client, GDBusConnection *connection, const gchar *name_owner, CallType call_type)
Packit ae235b
{
Packit ae235b
  switch (call_type)
Packit ae235b
    {
Packit ae235b
    case CALL_TYPE_NAME_APPEARED:
Packit ae235b
      if (client->name_appeared_handler != NULL)
Packit ae235b
        {
Packit ae235b
          client->name_appeared_handler (connection,
Packit ae235b
                                         client->name,
Packit ae235b
                                         name_owner,
Packit ae235b
                                         client->user_data);
Packit ae235b
        }
Packit ae235b
      break;
Packit ae235b
Packit ae235b
    case CALL_TYPE_NAME_VANISHED:
Packit ae235b
      if (client->name_vanished_handler != NULL)
Packit ae235b
        {
Packit ae235b
          client->name_vanished_handler (connection,
Packit ae235b
                                         client->name,
Packit ae235b
                                         client->user_data);
Packit ae235b
        }
Packit ae235b
      break;
Packit ae235b
Packit ae235b
    default:
Packit ae235b
      g_assert_not_reached ();
Packit ae235b
      break;
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
call_in_idle_cb (gpointer _data)
Packit ae235b
{
Packit ae235b
  CallHandlerData *data = _data;
Packit ae235b
  actually_do_call (data->client, data->connection, data->name_owner, data->call_type);
Packit ae235b
  return FALSE;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
schedule_call_in_idle (Client *client, CallType call_type)
Packit ae235b
{
Packit ae235b
  CallHandlerData *data;
Packit ae235b
  GSource *idle_source;
Packit ae235b
Packit ae235b
  data = g_new0 (CallHandlerData, 1);
Packit ae235b
  data->client = client_ref (client);
Packit ae235b
  data->connection = client->connection != NULL ? g_object_ref (client->connection) : NULL;
Packit ae235b
  data->name_owner = g_strdup (client->name_owner);
Packit ae235b
  data->call_type = call_type;
Packit ae235b
Packit ae235b
  idle_source = g_idle_source_new ();
Packit ae235b
  g_source_set_priority (idle_source, G_PRIORITY_HIGH);
Packit ae235b
  g_source_set_callback (idle_source,
Packit ae235b
                         call_in_idle_cb,
Packit ae235b
                         data,
Packit ae235b
                         (GDestroyNotify) call_handler_data_free);
Packit ae235b
  g_source_set_name (idle_source, "[gio, gdbusnamewatching.c] call_in_idle_cb");
Packit ae235b
  g_source_attach (idle_source, client->main_context);
Packit ae235b
  g_source_unref (idle_source);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
do_call (Client *client, CallType call_type)
Packit ae235b
{
Packit ae235b
  GMainContext *current_context;
Packit ae235b
Packit ae235b
  /* only schedule in idle if we're not in the right thread */
Packit ae235b
  current_context = g_main_context_ref_thread_default ();
Packit ae235b
  if (current_context != client->main_context)
Packit ae235b
    schedule_call_in_idle (client, call_type);
Packit ae235b
  else
Packit ae235b
    actually_do_call (client, client->connection, client->name_owner, call_type);
Packit ae235b
  g_main_context_unref (current_context);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
call_appeared_handler (Client *client)
Packit ae235b
{
Packit ae235b
  if (client->previous_call != PREVIOUS_CALL_APPEARED)
Packit ae235b
    {
Packit ae235b
      client->previous_call = PREVIOUS_CALL_APPEARED;
Packit ae235b
      if (!client->cancelled && client->name_appeared_handler != NULL)
Packit ae235b
        {
Packit ae235b
          do_call (client, CALL_TYPE_NAME_APPEARED);
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
call_vanished_handler (Client  *client,
Packit ae235b
                       gboolean ignore_cancelled)
Packit ae235b
{
Packit ae235b
  if (client->previous_call != PREVIOUS_CALL_VANISHED)
Packit ae235b
    {
Packit ae235b
      client->previous_call = PREVIOUS_CALL_VANISHED;
Packit ae235b
      if (((!client->cancelled) || ignore_cancelled) && client->name_vanished_handler != NULL)
Packit ae235b
        {
Packit ae235b
          do_call (client, CALL_TYPE_NAME_VANISHED);
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
/* Return a reference to the #Client for @watcher_id, or %NULL if it’s been
Packit ae235b
 * unwatched. This is safe to call from any thread. */
Packit ae235b
static Client *
Packit ae235b
dup_client (guint watcher_id)
Packit ae235b
{
Packit ae235b
  Client *client;
Packit ae235b
Packit ae235b
  G_LOCK (lock);
Packit ae235b
Packit ae235b
  g_assert (watcher_id != 0);
Packit ae235b
  g_assert (map_id_to_client != NULL);
Packit ae235b
Packit ae235b
  client = g_hash_table_lookup (map_id_to_client, GUINT_TO_POINTER (watcher_id));
Packit ae235b
Packit ae235b
  if (client != NULL)
Packit ae235b
    client_ref (client);
Packit ae235b
Packit ae235b
  G_UNLOCK (lock);
Packit ae235b
Packit ae235b
  return client;
Packit ae235b
}
Packit ae235b
Packit ae235b
/* Could be called from any thread, so it could be called after client_unref()
Packit ae235b
 * has started finalising the #Client. Avoid that by looking up the #Client
Packit ae235b
 * atomically. */
Packit ae235b
static void
Packit ae235b
on_connection_disconnected (GDBusConnection *connection,
Packit ae235b
                            gboolean         remote_peer_vanished,
Packit ae235b
                            GError          *error,
Packit ae235b
                            gpointer         user_data)
Packit ae235b
{
Packit ae235b
  guint watcher_id = GPOINTER_TO_UINT (user_data);
Packit ae235b
  Client *client = NULL;
Packit ae235b
Packit ae235b
  client = dup_client (watcher_id);
Packit ae235b
  if (client == NULL)
Packit ae235b
    return;
Packit ae235b
Packit ae235b
  if (client->name_owner_changed_subscription_id > 0)
Packit ae235b
    g_dbus_connection_signal_unsubscribe (client->connection, client->name_owner_changed_subscription_id);
Packit ae235b
  if (client->disconnected_signal_handler_id > 0)
Packit ae235b
    g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
Packit ae235b
  g_object_unref (client->connection);
Packit ae235b
  client->disconnected_signal_handler_id = 0;
Packit ae235b
  client->name_owner_changed_subscription_id = 0;
Packit ae235b
  client->connection = NULL;
Packit ae235b
Packit ae235b
  call_vanished_handler (client, FALSE);
Packit ae235b
Packit ae235b
  client_unref (client);
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
/* Will always be called from the thread which acquired client->main_context. */
Packit ae235b
static void
Packit ae235b
on_name_owner_changed (GDBusConnection *connection,
Packit ae235b
                       const gchar      *sender_name,
Packit ae235b
                       const gchar      *object_path,
Packit ae235b
                       const gchar      *interface_name,
Packit ae235b
                       const gchar      *signal_name,
Packit ae235b
                       GVariant         *parameters,
Packit ae235b
                       gpointer          user_data)
Packit ae235b
{
Packit ae235b
  guint watcher_id = GPOINTER_TO_UINT (user_data);
Packit ae235b
  Client *client = NULL;
Packit ae235b
  const gchar *name;
Packit ae235b
  const gchar *old_owner;
Packit ae235b
  const gchar *new_owner;
Packit ae235b
Packit ae235b
  client = dup_client (watcher_id);
Packit ae235b
  if (client == NULL)
Packit ae235b
    return;
Packit ae235b
Packit ae235b
  if (!client->initialized)
Packit ae235b
    goto out;
Packit ae235b
Packit ae235b
  if (g_strcmp0 (object_path, "/org/freedesktop/DBus") != 0 ||
Packit ae235b
      g_strcmp0 (interface_name, "org.freedesktop.DBus") != 0 ||
Packit ae235b
      g_strcmp0 (sender_name, "org.freedesktop.DBus") != 0)
Packit ae235b
    goto out;
Packit ae235b
Packit ae235b
  g_variant_get (parameters,
Packit ae235b
                 "(&s&s&s)",
Packit ae235b
                 &name,
Packit ae235b
                 &old_owner,
Packit ae235b
                 &new_owner);
Packit ae235b
Packit ae235b
  /* we only care about a specific name */
Packit ae235b
  if (g_strcmp0 (name, client->name) != 0)
Packit ae235b
    goto out;
Packit ae235b
Packit ae235b
  if ((old_owner != NULL && strlen (old_owner) > 0) && client->name_owner != NULL)
Packit ae235b
    {
Packit ae235b
      g_free (client->name_owner);
Packit ae235b
      client->name_owner = NULL;
Packit ae235b
      call_vanished_handler (client, FALSE);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (new_owner != NULL && strlen (new_owner) > 0)
Packit ae235b
    {
Packit ae235b
      g_warn_if_fail (client->name_owner == NULL);
Packit ae235b
      g_free (client->name_owner);
Packit ae235b
      client->name_owner = g_strdup (new_owner);
Packit ae235b
      call_appeared_handler (client);
Packit ae235b
    }
Packit ae235b
Packit ae235b
 out:
Packit ae235b
  client_unref (client);
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
static void
Packit ae235b
get_name_owner_cb (GObject      *source_object,
Packit ae235b
                   GAsyncResult *res,
Packit ae235b
                   gpointer      user_data)
Packit ae235b
{
Packit ae235b
  Client *client = user_data;
Packit ae235b
  GVariant *result;
Packit ae235b
  const char *name_owner;
Packit ae235b
Packit ae235b
  name_owner = NULL;
Packit ae235b
  result = NULL;
Packit ae235b
Packit ae235b
  result = g_dbus_connection_call_finish (client->connection,
Packit ae235b
                                          res,
Packit ae235b
                                          NULL);
Packit ae235b
  if (result != NULL)
Packit ae235b
    {
Packit ae235b
      g_variant_get (result, "(&s)", &name_owner);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (name_owner != NULL)
Packit ae235b
    {
Packit ae235b
      g_warn_if_fail (client->name_owner == NULL);
Packit ae235b
      client->name_owner = g_strdup (name_owner);
Packit ae235b
      call_appeared_handler (client);
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      call_vanished_handler (client, FALSE);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  client->initialized = TRUE;
Packit ae235b
Packit ae235b
  if (result != NULL)
Packit ae235b
    g_variant_unref (result);
Packit ae235b
  client_unref (client);
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
static void
Packit ae235b
invoke_get_name_owner (Client *client)
Packit ae235b
{
Packit ae235b
  g_dbus_connection_call (client->connection,
Packit ae235b
                          "org.freedesktop.DBus",  /* bus name */
Packit ae235b
                          "/org/freedesktop/DBus", /* object path */
Packit ae235b
                          "org.freedesktop.DBus",  /* interface name */
Packit ae235b
                          "GetNameOwner",          /* method name */
Packit ae235b
                          g_variant_new ("(s)", client->name),
Packit ae235b
                          G_VARIANT_TYPE ("(s)"),
Packit ae235b
                          G_DBUS_CALL_FLAGS_NONE,
Packit ae235b
                          -1,
Packit ae235b
                          NULL,
Packit ae235b
                          (GAsyncReadyCallback) get_name_owner_cb,
Packit ae235b
                          client_ref (client));
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
static void
Packit ae235b
start_service_by_name_cb (GObject      *source_object,
Packit ae235b
                          GAsyncResult *res,
Packit ae235b
                          gpointer      user_data)
Packit ae235b
{
Packit ae235b
  Client *client = user_data;
Packit ae235b
  GVariant *result;
Packit ae235b
Packit ae235b
  result = NULL;
Packit ae235b
Packit ae235b
  result = g_dbus_connection_call_finish (client->connection,
Packit ae235b
                                          res,
Packit ae235b
                                          NULL);
Packit ae235b
  if (result != NULL)
Packit ae235b
    {
Packit ae235b
      guint32 start_service_result;
Packit ae235b
      g_variant_get (result, "(u)", &start_service_result);
Packit ae235b
Packit ae235b
      if (start_service_result == 1) /* DBUS_START_REPLY_SUCCESS */
Packit ae235b
        {
Packit ae235b
          invoke_get_name_owner (client);
Packit ae235b
        }
Packit ae235b
      else if (start_service_result == 2) /* DBUS_START_REPLY_ALREADY_RUNNING */
Packit ae235b
        {
Packit ae235b
          invoke_get_name_owner (client);
Packit ae235b
        }
Packit ae235b
      else
Packit ae235b
        {
Packit ae235b
          g_warning ("Unexpected reply %d from StartServiceByName() method", start_service_result);
Packit ae235b
          call_vanished_handler (client, FALSE);
Packit ae235b
          client->initialized = TRUE;
Packit ae235b
        }
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      /* Errors are not unexpected; the bus will reply e.g.
Packit ae235b
       *
Packit ae235b
       *   org.freedesktop.DBus.Error.ServiceUnknown: The name org.gnome.Epiphany2
Packit ae235b
       *   was not provided by any .service files
Packit ae235b
       *
Packit ae235b
       * This doesn't mean that the name doesn't have an owner, just
Packit ae235b
       * that it's not provided by a .service file. So proceed to
Packit ae235b
       * invoke GetNameOwner().
Packit ae235b
       */
Packit ae235b
      invoke_get_name_owner (client);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (result != NULL)
Packit ae235b
    g_variant_unref (result);
Packit ae235b
  client_unref (client);
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
static void
Packit ae235b
has_connection (Client *client)
Packit ae235b
{
Packit ae235b
  /* listen for disconnection */
Packit ae235b
  client->disconnected_signal_handler_id = g_signal_connect (client->connection,
Packit ae235b
                                                             "closed",
Packit ae235b
                                                             G_CALLBACK (on_connection_disconnected),
Packit ae235b
                                                             GUINT_TO_POINTER (client->id));
Packit ae235b
Packit ae235b
  /* start listening to NameOwnerChanged messages immediately */
Packit ae235b
  client->name_owner_changed_subscription_id = g_dbus_connection_signal_subscribe (client->connection,
Packit ae235b
                                                                                   "org.freedesktop.DBus",  /* name */
Packit ae235b
                                                                                   "org.freedesktop.DBus",  /* if */
Packit ae235b
                                                                                   "NameOwnerChanged",      /* signal */
Packit ae235b
                                                                                   "/org/freedesktop/DBus", /* path */
Packit ae235b
                                                                                   client->name,
Packit ae235b
                                                                                   G_DBUS_SIGNAL_FLAGS_NONE,
Packit ae235b
                                                                                   on_name_owner_changed,
Packit ae235b
                                                                                   GUINT_TO_POINTER (client->id),
Packit ae235b
                                                                                   NULL);
Packit ae235b
Packit ae235b
  if (client->flags & G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
Packit ae235b
    {
Packit ae235b
      g_dbus_connection_call (client->connection,
Packit ae235b
                              "org.freedesktop.DBus",  /* bus name */
Packit ae235b
                              "/org/freedesktop/DBus", /* object path */
Packit ae235b
                              "org.freedesktop.DBus",  /* interface name */
Packit ae235b
                              "StartServiceByName",    /* method name */
Packit ae235b
                              g_variant_new ("(su)", client->name, 0),
Packit ae235b
                              G_VARIANT_TYPE ("(u)"),
Packit ae235b
                              G_DBUS_CALL_FLAGS_NONE,
Packit ae235b
                              -1,
Packit ae235b
                              NULL,
Packit ae235b
                              (GAsyncReadyCallback) start_service_by_name_cb,
Packit ae235b
                              client_ref (client));
Packit ae235b
    }
Packit ae235b
  else
Packit ae235b
    {
Packit ae235b
      /* check owner */
Packit ae235b
      invoke_get_name_owner (client);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
Packit ae235b
static void
Packit ae235b
connection_get_cb (GObject      *source_object,
Packit ae235b
                   GAsyncResult *res,
Packit ae235b
                   gpointer      user_data)
Packit ae235b
{
Packit ae235b
  Client *client = user_data;
Packit ae235b
Packit ae235b
  client->connection = g_bus_get_finish (res, NULL);
Packit ae235b
  if (client->connection == NULL)
Packit ae235b
    {
Packit ae235b
      call_vanished_handler (client, FALSE);
Packit ae235b
      goto out;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  has_connection (client);
Packit ae235b
Packit ae235b
 out:
Packit ae235b
  client_unref (client);
Packit ae235b
}
Packit ae235b
Packit ae235b
/* ---------------------------------------------------------------------------------------------------- */
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_bus_watch_name:
Packit ae235b
 * @bus_type: The type of bus to watch a name on.
Packit ae235b
 * @name: The name (well-known or unique) to watch.
Packit ae235b
 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
Packit ae235b
 * @name_appeared_handler: (nullable): Handler to invoke when @name is known to exist or %NULL.
Packit ae235b
 * @name_vanished_handler: (nullable): Handler to invoke when @name is known to not exist or %NULL.
Packit ae235b
 * @user_data: User data to pass to handlers.
Packit ae235b
 * @user_data_free_func: (nullable): Function for freeing @user_data or %NULL.
Packit ae235b
 *
Packit ae235b
 * Starts watching @name on the bus specified by @bus_type and calls
Packit ae235b
 * @name_appeared_handler and @name_vanished_handler when the name is
Packit ae235b
 * known to have a owner respectively known to lose its
Packit ae235b
 * owner. Callbacks will be invoked in the
Packit ae235b
 * [thread-default main context][g-main-context-push-thread-default]
Packit ae235b
 * of the thread you are calling this function from.
Packit ae235b
 *
Packit ae235b
 * You are guaranteed that one of the handlers will be invoked after
Packit ae235b
 * calling this function. When you are done watching the name, just
Packit ae235b
 * call g_bus_unwatch_name() with the watcher id this function
Packit ae235b
 * returns.
Packit ae235b
 *
Packit ae235b
 * If the name vanishes or appears (for example the application owning
Packit ae235b
 * the name could restart), the handlers are also invoked. If the
Packit ae235b
 * #GDBusConnection that is used for watching the name disconnects, then
Packit ae235b
 * @name_vanished_handler is invoked since it is no longer
Packit ae235b
 * possible to access the name.
Packit ae235b
 *
Packit ae235b
 * Another guarantee is that invocations of @name_appeared_handler
Packit ae235b
 * and @name_vanished_handler are guaranteed to alternate; that
Packit ae235b
 * is, if @name_appeared_handler is invoked then you are
Packit ae235b
 * guaranteed that the next time one of the handlers is invoked, it
Packit ae235b
 * will be @name_vanished_handler. The reverse is also true.
Packit ae235b
 *
Packit ae235b
 * This behavior makes it very simple to write applications that want
Packit ae235b
 * to take action when a certain [name exists][gdbus-watching-names].
Packit ae235b
 * Basically, the application should create object proxies in
Packit ae235b
 * @name_appeared_handler and destroy them again (if any) in
Packit ae235b
 * @name_vanished_handler.
Packit ae235b
 *
Packit ae235b
 * Returns: An identifier (never 0) that an be used with
Packit ae235b
 * g_bus_unwatch_name() to stop watching the name.
Packit ae235b
 *
Packit ae235b
 * Since: 2.26
Packit ae235b
 */
Packit ae235b
guint
Packit ae235b
g_bus_watch_name (GBusType                  bus_type,
Packit ae235b
                  const gchar              *name,
Packit ae235b
                  GBusNameWatcherFlags      flags,
Packit ae235b
                  GBusNameAppearedCallback  name_appeared_handler,
Packit ae235b
                  GBusNameVanishedCallback  name_vanished_handler,
Packit ae235b
                  gpointer                  user_data,
Packit ae235b
                  GDestroyNotify            user_data_free_func)
Packit ae235b
{
Packit ae235b
  Client *client;
Packit ae235b
Packit ae235b
  g_return_val_if_fail (g_dbus_is_name (name), 0);
Packit ae235b
Packit ae235b
  G_LOCK (lock);
Packit ae235b
Packit ae235b
  client = g_new0 (Client, 1);
Packit ae235b
  client->ref_count = 1;
Packit ae235b
  client->id = g_atomic_int_add (&next_global_id, 1); /* TODO: uh oh, handle overflow */
Packit ae235b
  client->name = g_strdup (name);
Packit ae235b
  client->flags = flags;
Packit ae235b
  client->name_appeared_handler = name_appeared_handler;
Packit ae235b
  client->name_vanished_handler = name_vanished_handler;
Packit ae235b
  client->user_data = user_data;
Packit ae235b
  client->user_data_free_func = user_data_free_func;
Packit ae235b
  client->main_context = g_main_context_ref_thread_default ();
Packit ae235b
Packit ae235b
  if (map_id_to_client == NULL)
Packit ae235b
    {
Packit ae235b
      map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
Packit ae235b
    }
Packit ae235b
  g_hash_table_insert (map_id_to_client,
Packit ae235b
                       GUINT_TO_POINTER (client->id),
Packit ae235b
                       client);
Packit ae235b
Packit ae235b
  g_bus_get (bus_type,
Packit ae235b
             NULL,
Packit ae235b
             connection_get_cb,
Packit ae235b
             client_ref (client));
Packit ae235b
Packit ae235b
  G_UNLOCK (lock);
Packit ae235b
Packit ae235b
  return client->id;
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_bus_watch_name_on_connection:
Packit ae235b
 * @connection: A #GDBusConnection.
Packit ae235b
 * @name: The name (well-known or unique) to watch.
Packit ae235b
 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
Packit ae235b
 * @name_appeared_handler: (nullable): Handler to invoke when @name is known to exist or %NULL.
Packit ae235b
 * @name_vanished_handler: (nullable): Handler to invoke when @name is known to not exist or %NULL.
Packit ae235b
 * @user_data: User data to pass to handlers.
Packit ae235b
 * @user_data_free_func: (nullable): Function for freeing @user_data or %NULL.
Packit ae235b
 *
Packit ae235b
 * Like g_bus_watch_name() but takes a #GDBusConnection instead of a
Packit ae235b
 * #GBusType.
Packit ae235b
 *
Packit ae235b
 * Returns: An identifier (never 0) that an be used with
Packit ae235b
 * g_bus_unwatch_name() to stop watching the name.
Packit ae235b
 *
Packit ae235b
 * Since: 2.26
Packit ae235b
 */
Packit ae235b
guint g_bus_watch_name_on_connection (GDBusConnection          *connection,
Packit ae235b
                                      const gchar              *name,
Packit ae235b
                                      GBusNameWatcherFlags      flags,
Packit ae235b
                                      GBusNameAppearedCallback  name_appeared_handler,
Packit ae235b
                                      GBusNameVanishedCallback  name_vanished_handler,
Packit ae235b
                                      gpointer                  user_data,
Packit ae235b
                                      GDestroyNotify            user_data_free_func)
Packit ae235b
{
Packit ae235b
  Client *client;
Packit ae235b
Packit ae235b
  g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
Packit ae235b
  g_return_val_if_fail (g_dbus_is_name (name), 0);
Packit ae235b
Packit ae235b
  G_LOCK (lock);
Packit ae235b
Packit ae235b
  client = g_new0 (Client, 1);
Packit ae235b
  client->ref_count = 1;
Packit ae235b
  client->id = g_atomic_int_add (&next_global_id, 1); /* TODO: uh oh, handle overflow */
Packit ae235b
  client->name = g_strdup (name);
Packit ae235b
  client->flags = flags;
Packit ae235b
  client->name_appeared_handler = name_appeared_handler;
Packit ae235b
  client->name_vanished_handler = name_vanished_handler;
Packit ae235b
  client->user_data = user_data;
Packit ae235b
  client->user_data_free_func = user_data_free_func;
Packit ae235b
  client->main_context = g_main_context_ref_thread_default ();
Packit ae235b
Packit ae235b
  if (map_id_to_client == NULL)
Packit ae235b
    map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
Packit ae235b
Packit ae235b
  g_hash_table_insert (map_id_to_client,
Packit ae235b
                       GUINT_TO_POINTER (client->id),
Packit ae235b
                       client);
Packit ae235b
Packit ae235b
  client->connection = g_object_ref (connection);
Packit ae235b
  G_UNLOCK (lock);
Packit ae235b
Packit ae235b
  has_connection (client);
Packit ae235b
Packit ae235b
  return client->id;
Packit ae235b
}
Packit ae235b
Packit ae235b
typedef struct {
Packit ae235b
  GClosure *name_appeared_closure;
Packit ae235b
  GClosure *name_vanished_closure;
Packit ae235b
} WatchNameData;
Packit ae235b
Packit ae235b
static WatchNameData *
Packit ae235b
watch_name_data_new (GClosure *name_appeared_closure,
Packit ae235b
                     GClosure *name_vanished_closure)
Packit ae235b
{
Packit ae235b
  WatchNameData *data;
Packit ae235b
Packit ae235b
  data = g_new0 (WatchNameData, 1);
Packit ae235b
Packit ae235b
  if (name_appeared_closure != NULL)
Packit ae235b
    {
Packit ae235b
      data->name_appeared_closure = g_closure_ref (name_appeared_closure);
Packit ae235b
      g_closure_sink (name_appeared_closure);
Packit ae235b
      if (G_CLOSURE_NEEDS_MARSHAL (name_appeared_closure))
Packit ae235b
        g_closure_set_marshal (name_appeared_closure, g_cclosure_marshal_generic);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (name_vanished_closure != NULL)
Packit ae235b
    {
Packit ae235b
      data->name_vanished_closure = g_closure_ref (name_vanished_closure);
Packit ae235b
      g_closure_sink (name_vanished_closure);
Packit ae235b
      if (G_CLOSURE_NEEDS_MARSHAL (name_vanished_closure))
Packit ae235b
        g_closure_set_marshal (name_vanished_closure, g_cclosure_marshal_generic);
Packit ae235b
    }
Packit ae235b
Packit ae235b
  return data;
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
watch_with_closures_on_name_appeared (GDBusConnection *connection,
Packit ae235b
                                      const gchar     *name,
Packit ae235b
                                      const gchar     *name_owner,
Packit ae235b
                                      gpointer         user_data)
Packit ae235b
{
Packit ae235b
  WatchNameData *data = user_data;
Packit ae235b
  GValue params[3] = { G_VALUE_INIT, G_VALUE_INIT, G_VALUE_INIT };
Packit ae235b
Packit ae235b
  g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
Packit ae235b
  g_value_set_object (&params[0], connection);
Packit ae235b
Packit ae235b
  g_value_init (&params[1], G_TYPE_STRING);
Packit ae235b
  g_value_set_string (&params[1], name);
Packit ae235b
Packit ae235b
  g_value_init (&params[2], G_TYPE_STRING);
Packit ae235b
  g_value_set_string (&params[2], name_owner);
Packit ae235b
Packit ae235b
  g_closure_invoke (data->name_appeared_closure, NULL, 3, params, NULL);
Packit ae235b
Packit ae235b
  g_value_unset (params + 0);
Packit ae235b
  g_value_unset (params + 1);
Packit ae235b
  g_value_unset (params + 2);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
watch_with_closures_on_name_vanished (GDBusConnection *connection,
Packit ae235b
                                      const gchar     *name,
Packit ae235b
                                      gpointer         user_data)
Packit ae235b
{
Packit ae235b
  WatchNameData *data = user_data;
Packit ae235b
  GValue params[2] = { G_VALUE_INIT, G_VALUE_INIT };
Packit ae235b
Packit ae235b
  g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
Packit ae235b
  g_value_set_object (&params[0], connection);
Packit ae235b
Packit ae235b
  g_value_init (&params[1], G_TYPE_STRING);
Packit ae235b
  g_value_set_string (&params[1], name);
Packit ae235b
Packit ae235b
  g_closure_invoke (data->name_vanished_closure, NULL, 2, params, NULL);
Packit ae235b
Packit ae235b
  g_value_unset (params + 0);
Packit ae235b
  g_value_unset (params + 1);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
bus_watch_name_free_func (gpointer user_data)
Packit ae235b
{
Packit ae235b
  WatchNameData *data = user_data;
Packit ae235b
Packit ae235b
  if (data->name_appeared_closure != NULL)
Packit ae235b
    g_closure_unref (data->name_appeared_closure);
Packit ae235b
Packit ae235b
  if (data->name_vanished_closure != NULL)
Packit ae235b
    g_closure_unref (data->name_vanished_closure);
Packit ae235b
Packit ae235b
  g_free (data);
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_bus_watch_name_with_closures: (rename-to g_bus_watch_name)
Packit ae235b
 * @bus_type: The type of bus to watch a name on.
Packit ae235b
 * @name: The name (well-known or unique) to watch.
Packit ae235b
 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
Packit ae235b
 * @name_appeared_closure: (nullable): #GClosure to invoke when @name is known
Packit ae235b
 * to exist or %NULL.
Packit ae235b
 * @name_vanished_closure: (nullable): #GClosure to invoke when @name is known
Packit ae235b
 * to not exist or %NULL.
Packit ae235b
 *
Packit ae235b
 * Version of g_bus_watch_name() using closures instead of callbacks for
Packit ae235b
 * easier binding in other languages.
Packit ae235b
 *
Packit ae235b
 * Returns: An identifier (never 0) that an be used with
Packit ae235b
 * g_bus_unwatch_name() to stop watching the name.
Packit ae235b
 *
Packit ae235b
 * Since: 2.26
Packit ae235b
 */
Packit ae235b
guint
Packit ae235b
g_bus_watch_name_with_closures (GBusType                 bus_type,
Packit ae235b
                                const gchar             *name,
Packit ae235b
                                GBusNameWatcherFlags     flags,
Packit ae235b
                                GClosure                *name_appeared_closure,
Packit ae235b
                                GClosure                *name_vanished_closure)
Packit ae235b
{
Packit ae235b
  return g_bus_watch_name (bus_type,
Packit ae235b
          name,
Packit ae235b
          flags,
Packit ae235b
          name_appeared_closure != NULL ? watch_with_closures_on_name_appeared : NULL,
Packit ae235b
          name_vanished_closure != NULL ? watch_with_closures_on_name_vanished : NULL,
Packit ae235b
          watch_name_data_new (name_appeared_closure, name_vanished_closure),
Packit ae235b
          bus_watch_name_free_func);
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_bus_watch_name_on_connection_with_closures: (rename-to g_bus_watch_name_on_connection)
Packit ae235b
 * @connection: A #GDBusConnection.
Packit ae235b
 * @name: The name (well-known or unique) to watch.
Packit ae235b
 * @flags: Flags from the #GBusNameWatcherFlags enumeration.
Packit ae235b
 * @name_appeared_closure: (nullable): #GClosure to invoke when @name is known
Packit ae235b
 * to exist or %NULL.
Packit ae235b
 * @name_vanished_closure: (nullable): #GClosure to invoke when @name is known
Packit ae235b
 * to not exist or %NULL.
Packit ae235b
 *
Packit ae235b
 * Version of g_bus_watch_name_on_connection() using closures instead of callbacks for
Packit ae235b
 * easier binding in other languages.
Packit ae235b
 *
Packit ae235b
 * Returns: An identifier (never 0) that an be used with
Packit ae235b
 * g_bus_unwatch_name() to stop watching the name.
Packit ae235b
 *
Packit ae235b
 * Since: 2.26
Packit ae235b
 */
Packit ae235b
guint g_bus_watch_name_on_connection_with_closures (
Packit ae235b
                                      GDBusConnection          *connection,
Packit ae235b
                                      const gchar              *name,
Packit ae235b
                                      GBusNameWatcherFlags      flags,
Packit ae235b
                                      GClosure                 *name_appeared_closure,
Packit ae235b
                                      GClosure                 *name_vanished_closure)
Packit ae235b
{
Packit ae235b
  return g_bus_watch_name_on_connection (connection,
Packit ae235b
          name,
Packit ae235b
          flags,
Packit ae235b
          name_appeared_closure != NULL ? watch_with_closures_on_name_appeared : NULL,
Packit ae235b
          name_vanished_closure != NULL ? watch_with_closures_on_name_vanished : NULL,
Packit ae235b
          watch_name_data_new (name_appeared_closure, name_vanished_closure),
Packit ae235b
          bus_watch_name_free_func);
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_bus_unwatch_name:
Packit ae235b
 * @watcher_id: An identifier obtained from g_bus_watch_name()
Packit ae235b
 *
Packit ae235b
 * Stops watching a name.
Packit ae235b
 *
Packit ae235b
 * Since: 2.26
Packit ae235b
 */
Packit ae235b
void
Packit ae235b
g_bus_unwatch_name (guint watcher_id)
Packit ae235b
{
Packit ae235b
  Client *client;
Packit ae235b
Packit ae235b
  g_return_if_fail (watcher_id > 0);
Packit ae235b
Packit ae235b
  client = NULL;
Packit ae235b
Packit ae235b
  G_LOCK (lock);
Packit ae235b
  if (watcher_id == 0 ||
Packit ae235b
      map_id_to_client == NULL ||
Packit ae235b
      (client = g_hash_table_lookup (map_id_to_client, GUINT_TO_POINTER (watcher_id))) == NULL)
Packit ae235b
    {
Packit ae235b
      g_warning ("Invalid id %d passed to g_bus_unwatch_name()", watcher_id);
Packit ae235b
      goto out;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  client->cancelled = TRUE;
Packit ae235b
  g_warn_if_fail (g_hash_table_remove (map_id_to_client, GUINT_TO_POINTER (watcher_id)));
Packit ae235b
Packit ae235b
 out:
Packit ae235b
  G_UNLOCK (lock);
Packit ae235b
Packit ae235b
  /* do callback without holding lock */
Packit ae235b
  if (client != NULL)
Packit ae235b
    {
Packit ae235b
      client_unref (client);
Packit ae235b
    }
Packit ae235b
}