Merge remote branch 'gvdb/master'
[platform/upstream/glib.git] / gio / gdbusnameowning.c
1 /* GDBus - GLib D-Bus Library
2  *
3  * Copyright (C) 2008-2010 Red Hat, Inc.
4  *
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.
9  *
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.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: David Zeuthen <davidz@redhat.com>
21  */
22
23 #include "config.h"
24
25 #include <stdlib.h>
26
27 #include "gdbusutils.h"
28 #include "gdbusnameowning.h"
29 #include "gdbuserror.h"
30 #include "gdbusprivate.h"
31 #include "gdbusconnection.h"
32
33 #include "glibintl.h"
34 #include "gioalias.h"
35
36 /**
37  * SECTION:gdbusnameowning
38  * @title: Owning Bus Names
39  * @short_description: Simple API for owning bus names
40  * @include: gio/gio.h
41  *
42  * Convenience API for owning bus names.
43  *
44  * <example id="gdbus-owning-names"><title>Simple application owning a name</title><programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gdbus-example-own-name.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting></example>
45  */
46
47 G_LOCK_DEFINE_STATIC (lock);
48
49 /* ---------------------------------------------------------------------------------------------------- */
50
51 typedef enum
52 {
53   PREVIOUS_CALL_NONE = 0,
54   PREVIOUS_CALL_ACQUIRED,
55   PREVIOUS_CALL_LOST,
56 } PreviousCall;
57
58 typedef struct
59 {
60   volatile gint             ref_count;
61   guint                     id;
62   GBusNameOwnerFlags        flags;
63   gchar                    *name;
64   GBusAcquiredCallback      bus_acquired_handler;
65   GBusNameAcquiredCallback  name_acquired_handler;
66   GBusNameLostCallback      name_lost_handler;
67   gpointer                  user_data;
68   GDestroyNotify            user_data_free_func;
69   GMainContext             *main_context;
70
71   PreviousCall              previous_call;
72
73   GDBusConnection          *connection;
74   gulong                    disconnected_signal_handler_id;
75   guint                     name_acquired_subscription_id;
76   guint                     name_lost_subscription_id;
77
78   gboolean                  cancelled;
79
80   gboolean                  needs_release;
81 } Client;
82
83 static guint next_global_id = 1;
84 static GHashTable *map_id_to_client = NULL;
85
86
87 static Client *
88 client_ref (Client *client)
89 {
90   g_atomic_int_inc (&client->ref_count);
91   return client;
92 }
93
94 static void
95 client_unref (Client *client)
96 {
97   if (g_atomic_int_dec_and_test (&client->ref_count))
98     {
99       if (client->connection != NULL)
100         {
101           if (client->disconnected_signal_handler_id > 0)
102             g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
103           if (client->name_acquired_subscription_id > 0)
104             g_dbus_connection_signal_unsubscribe (client->connection, client->name_acquired_subscription_id);
105           if (client->name_lost_subscription_id > 0)
106             g_dbus_connection_signal_unsubscribe (client->connection, client->name_lost_subscription_id);
107           g_object_unref (client->connection);
108         }
109       if (client->main_context != NULL)
110         g_main_context_unref (client->main_context);
111       g_free (client->name);
112       if (client->user_data_free_func != NULL)
113         client->user_data_free_func (client->user_data);
114       g_free (client);
115     }
116 }
117
118 /* ---------------------------------------------------------------------------------------------------- */
119
120
121 typedef enum
122 {
123   CALL_TYPE_NAME_ACQUIRED,
124   CALL_TYPE_NAME_LOST
125 } CallType;
126
127 typedef struct
128 {
129   Client *client;
130
131   /* keep this separate because client->connection may
132    * be set to NULL after scheduling the call
133    */
134   GDBusConnection *connection;
135
136   /* set to TRUE to call acquired */
137   CallType call_type;
138 } CallHandlerData;
139
140 static void
141 call_handler_data_free (CallHandlerData *data)
142 {
143   if (data->connection != NULL)
144     g_object_unref (data->connection);
145   client_unref (data->client);
146   g_free (data);
147 }
148
149 static void
150 actually_do_call (Client *client, GDBusConnection *connection, CallType call_type)
151 {
152   switch (call_type)
153     {
154     case CALL_TYPE_NAME_ACQUIRED:
155       if (client->name_acquired_handler != NULL)
156         {
157           client->name_acquired_handler (connection,
158                                          client->name,
159                                          client->user_data);
160         }
161       break;
162
163     case CALL_TYPE_NAME_LOST:
164       if (client->name_lost_handler != NULL)
165         {
166           client->name_lost_handler (connection,
167                                      client->name,
168                                      client->user_data);
169         }
170       break;
171
172     default:
173       g_assert_not_reached ();
174       break;
175     }
176 }
177
178 static gboolean
179 call_in_idle_cb (gpointer _data)
180 {
181   CallHandlerData *data = _data;
182   actually_do_call (data->client, data->connection, data->call_type);
183   return FALSE;
184 }
185
186 static void
187 schedule_call_in_idle (Client *client, CallType  call_type)
188 {
189   CallHandlerData *data;
190   GSource *idle_source;
191
192   data = g_new0 (CallHandlerData, 1);
193   data->client = client_ref (client);
194   data->connection = client->connection != NULL ? g_object_ref (client->connection) : NULL;
195   data->call_type = call_type;
196
197   idle_source = g_idle_source_new ();
198   g_source_set_priority (idle_source, G_PRIORITY_HIGH);
199   g_source_set_callback (idle_source,
200                          call_in_idle_cb,
201                          data,
202                          (GDestroyNotify) call_handler_data_free);
203   g_source_attach (idle_source, client->main_context);
204   g_source_unref (idle_source);
205 }
206
207 static void
208 do_call (Client *client, CallType call_type)
209 {
210   /* only schedule in idle if we're not in the right thread */
211   if (g_main_context_get_thread_default () != client->main_context)
212     schedule_call_in_idle (client, call_type);
213   else
214     actually_do_call (client, client->connection, call_type);
215 }
216
217 static void
218 call_acquired_handler (Client *client)
219 {
220   if (client->previous_call != PREVIOUS_CALL_ACQUIRED)
221     {
222       client->previous_call = PREVIOUS_CALL_ACQUIRED;
223       if (!client->cancelled)
224         {
225           do_call (client, CALL_TYPE_NAME_ACQUIRED);
226         }
227     }
228 }
229
230 static void
231 call_lost_handler (Client  *client)
232 {
233   if (client->previous_call != PREVIOUS_CALL_LOST)
234     {
235       client->previous_call = PREVIOUS_CALL_LOST;
236       if (!client->cancelled)
237         {
238           do_call (client, CALL_TYPE_NAME_LOST);
239         }
240     }
241 }
242
243 /* ---------------------------------------------------------------------------------------------------- */
244
245 static void
246 on_name_lost_or_acquired (GDBusConnection  *connection,
247                           const gchar      *sender_name,
248                           const gchar      *object_path,
249                           const gchar      *interface_name,
250                           const gchar      *signal_name,
251                           GVariant         *parameters,
252                           gpointer          user_data)
253 {
254   Client *client = user_data;
255   const gchar *name;
256
257   if (g_strcmp0 (object_path, "/org/freedesktop/DBus") != 0 ||
258       g_strcmp0 (interface_name, "org.freedesktop.DBus") != 0 ||
259       g_strcmp0 (sender_name, "org.freedesktop.DBus") != 0)
260     goto out;
261
262   if (g_strcmp0 (signal_name, "NameLost") == 0)
263     {
264       g_variant_get (parameters, "(&s)", &name);
265       if (g_strcmp0 (name, client->name) == 0)
266         {
267           call_lost_handler (client);
268         }
269     }
270   else if (g_strcmp0 (signal_name, "NameAcquired") == 0)
271     {
272       g_variant_get (parameters, "(&s)", &name);
273       if (g_strcmp0 (name, client->name) == 0)
274         {
275           call_acquired_handler (client);
276         }
277     }
278  out:
279   ;
280 }
281
282 /* ---------------------------------------------------------------------------------------------------- */
283
284 static void
285 request_name_cb (GObject      *source_object,
286                  GAsyncResult *res,
287                  gpointer      user_data)
288 {
289   Client *client = user_data;
290   GVariant *result;
291   guint32 request_name_reply;
292   gboolean subscribe;
293
294   request_name_reply = 0;
295   result = NULL;
296
297   result = g_dbus_connection_call_finish (client->connection,
298                                           res,
299                                           NULL);
300   if (result != NULL)
301     {
302       g_variant_get (result, "(u)", &request_name_reply);
303       g_variant_unref (result);
304     }
305
306   subscribe = FALSE;
307
308   switch (request_name_reply)
309     {
310     case 1: /* DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER */
311       /* We got the name - now listen for NameLost and NameAcquired */
312       call_acquired_handler (client);
313       subscribe = TRUE;
314       client->needs_release = TRUE;
315       break;
316
317     case 2: /* DBUS_REQUEST_NAME_REPLY_IN_QUEUE */
318       /* Waiting in line - listen for NameLost and NameAcquired */
319       call_lost_handler (client);
320       subscribe = TRUE;
321       client->needs_release = TRUE;
322       break;
323
324     default:
325       /* assume we couldn't get the name - explicit fallthrough */
326     case 3: /* DBUS_REQUEST_NAME_REPLY_EXISTS */
327     case 4: /* DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER */
328       /* Some other part of the process is already owning the name */
329       call_lost_handler (client);
330       break;
331     }
332
333   if (subscribe)
334     {
335       /* start listening to NameLost and NameAcquired messages */
336       client->name_lost_subscription_id =
337         g_dbus_connection_signal_subscribe (client->connection,
338                                             "org.freedesktop.DBus",
339                                             "org.freedesktop.DBus",
340                                             "NameLost",
341                                             "/org/freedesktop/DBus",
342                                             client->name,
343                                             on_name_lost_or_acquired,
344                                             client,
345                                             NULL);
346       client->name_acquired_subscription_id =
347         g_dbus_connection_signal_subscribe (client->connection,
348                                             "org.freedesktop.DBus",
349                                             "org.freedesktop.DBus",
350                                             "NameAcquired",
351                                             "/org/freedesktop/DBus",
352                                             client->name,
353                                             on_name_lost_or_acquired,
354                                             client,
355                                             NULL);
356     }
357
358   client_unref (client);
359 }
360
361 /* ---------------------------------------------------------------------------------------------------- */
362
363 static void
364 on_connection_disconnected (GDBusConnection *connection,
365                             gboolean         remote_peer_vanished,
366                             GError          *error,
367                             gpointer         user_data)
368 {
369   Client *client = user_data;
370
371   if (client->disconnected_signal_handler_id > 0)
372     g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
373   if (client->name_acquired_subscription_id > 0)
374     g_dbus_connection_signal_unsubscribe (client->connection, client->name_acquired_subscription_id);
375   if (client->name_lost_subscription_id > 0)
376     g_dbus_connection_signal_unsubscribe (client->connection, client->name_lost_subscription_id);
377   g_object_unref (client->connection);
378   client->disconnected_signal_handler_id = 0;
379   client->name_acquired_subscription_id = 0;
380   client->name_lost_subscription_id = 0;
381   client->connection = NULL;
382
383   call_lost_handler (client);
384 }
385
386 /* ---------------------------------------------------------------------------------------------------- */
387
388 static void
389 has_connection (Client *client)
390 {
391   /* listen for disconnection */
392   client->disconnected_signal_handler_id = g_signal_connect (client->connection,
393                                                              "closed",
394                                                              G_CALLBACK (on_connection_disconnected),
395                                                              client);
396
397   /* attempt to acquire the name */
398   g_dbus_connection_call (client->connection,
399                           "org.freedesktop.DBus",  /* bus name */
400                           "/org/freedesktop/DBus", /* object path */
401                           "org.freedesktop.DBus",  /* interface name */
402                           "RequestName",           /* method name */
403                           g_variant_new ("(su)",
404                                          client->name,
405                                          client->flags),
406                           G_VARIANT_TYPE ("(u)"),
407                           G_DBUS_CALL_FLAGS_NONE,
408                           -1,
409                           NULL,
410                           (GAsyncReadyCallback) request_name_cb,
411                           client_ref (client));
412 }
413
414
415 static void
416 connection_get_cb (GObject      *source_object,
417                    GAsyncResult *res,
418                    gpointer      user_data)
419 {
420   Client *client = user_data;
421
422   client->connection = g_bus_get_finish (res, NULL);
423   if (client->connection == NULL)
424     {
425       call_lost_handler (client);
426       goto out;
427     }
428
429   /* No need to schedule this in idle as we're already in the thread
430    * that the user called g_bus_own_name() from. This is because
431    * g_bus_get() guarantees that.
432    *
433    * Also, we need to ensure that the handler is invoked *before*
434    * we call RequestName(). Otherwise there is a race.
435    */
436   if (client->bus_acquired_handler != NULL)
437     {
438       client->bus_acquired_handler (client->connection,
439                                     client->name,
440                                     client->user_data);
441     }
442
443   has_connection (client);
444
445  out:
446   client_unref (client);
447 }
448
449 /* ---------------------------------------------------------------------------------------------------- */
450
451 /**
452  * g_bus_own_name_on_connection:
453  * @connection: A #GDBusConnection that is not closed.
454  * @name: The well-known name to own.
455  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
456  * @name_acquired_handler: Handler to invoke when @name is acquired or %NULL.
457  * @name_lost_handler: Handler to invoke when @name is lost or %NULL.
458  * @user_data: User data to pass to handlers.
459  * @user_data_free_func: Function for freeing @user_data or %NULL.
460  *
461  * Like g_bus_own_name() but takes a #GDBusConnection instead of a
462  * #GBusType.
463  *
464  * Returns: An identifier (never 0) that an be used with
465  * g_bus_unown_name() to stop owning the name.
466  *
467  * Since: 2.26
468  */
469 guint
470 g_bus_own_name_on_connection (GDBusConnection          *connection,
471                               const gchar              *name,
472                               GBusNameOwnerFlags        flags,
473                               GBusNameAcquiredCallback  name_acquired_handler,
474                               GBusNameLostCallback      name_lost_handler,
475                               gpointer                  user_data,
476                               GDestroyNotify            user_data_free_func)
477 {
478   Client *client;
479
480   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), 0);
481   g_return_val_if_fail (!g_dbus_connection_is_closed (connection), 0);
482   g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), 0);
483
484   G_LOCK (lock);
485
486   client = g_new0 (Client, 1);
487   client->ref_count = 1;
488   client->id = next_global_id++; /* TODO: uh oh, handle overflow */
489   client->name = g_strdup (name);
490   client->flags = flags;
491   client->name_acquired_handler = name_acquired_handler;
492   client->name_lost_handler = name_lost_handler;
493   client->user_data = user_data;
494   client->user_data_free_func = user_data_free_func;
495   client->main_context = g_main_context_get_thread_default ();
496   if (client->main_context != NULL)
497     g_main_context_ref (client->main_context);
498
499   client->connection = g_object_ref (connection);
500
501   if (map_id_to_client == NULL)
502     {
503       map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
504     }
505   g_hash_table_insert (map_id_to_client,
506                        GUINT_TO_POINTER (client->id),
507                        client);
508
509   G_UNLOCK (lock);
510
511   has_connection (client);
512
513   return client->id;
514 }
515
516 /**
517  * g_bus_own_name:
518  * @bus_type: The type of bus to own a name on.
519  * @name: The well-known name to own.
520  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
521  * @bus_acquired_handler: Handler to invoke when connected to the bus of type @bus_type or %NULL.
522  * @name_acquired_handler: Handler to invoke when @name is acquired or %NULL.
523  * @name_lost_handler: Handler to invoke when @name is lost or %NULL.
524  * @user_data: User data to pass to handlers.
525  * @user_data_free_func: Function for freeing @user_data or %NULL.
526  *
527  * Starts acquiring @name on the bus specified by @bus_type and calls
528  * @name_acquired_handler and @name_lost_handler when the name is
529  * acquired respectively lost. Callbacks will be invoked in the <link
530  * linkend="g-main-context-push-thread-default">thread-default main
531  * loop</link> of the thread you are calling this function from.
532  *
533  * You are guaranteed that one of the @name_acquired_handler and @name_lost_handler
534  * callbacks will be invoked after calling this function - there are three
535  * possible cases:
536  * <itemizedlist>
537  *   <listitem><para>
538  *     @name_lost_handler with a %NULL connection (if a connection to the bus can't be made).
539  *   </para></listitem>
540  *   <listitem><para>
541  *     @bus_acquired_handler then @name_lost_handler (if the name can't be obtained)
542  *   </para></listitem>
543  *   <listitem><para>
544  *     @bus_acquired_handler then @name_acquired_handler (if the name was obtained).
545  *   </para></listitem>
546  * </itemizedlist>
547  * When you are done owning the name, just call g_bus_unown_name()
548  * with the owner id this function returns.
549  *
550  * If the name is acquired or lost (for example another application
551  * could acquire the name if you allow replacement or the application
552  * currently owning the name exits), the handlers are also invoked. If the
553  * #GDBusConnection that is used for attempting to own the name
554  * closes, then @name_lost_handler is invoked since it is no
555  * longer possible for other processes to access the process.
556  *
557  * You cannot use g_bus_own_name() several times for the same name (unless
558  * interleaved with calls to g_bus_unown_name()) - only the first call
559  * will work.
560  *
561  * Another guarantee is that invocations of @name_acquired_handler
562  * and @name_lost_handler are guaranteed to alternate; that
563  * is, if @name_acquired_handler is invoked then you are
564  * guaranteed that the next time one of the handlers is invoked, it
565  * will be @name_lost_handler. The reverse is also true.
566  *
567  * If you plan on exporting objects (using e.g.
568  * g_dbus_connection_register_object()), note that it is generally too late
569  * to export the objects in @name_acquired_handler. Instead, you can do this
570  * in @bus_acquired_handler since you are guaranteed that this will run
571  * before @name is requested from the bus.
572  *
573  * This behavior makes it very simple to write applications that wants
574  * to own names and export objects, see <xref linkend="gdbus-owning-names"/>.
575  * Simply register objects to be exported in @bus_acquired_handler and
576  * unregister the objects (if any) in @name_lost_handler.
577  *
578  * Returns: An identifier (never 0) that an be used with
579  * g_bus_unown_name() to stop owning the name.
580  *
581  * Since: 2.26
582  */
583 guint
584 g_bus_own_name (GBusType                  bus_type,
585                 const gchar              *name,
586                 GBusNameOwnerFlags        flags,
587                 GBusAcquiredCallback      bus_acquired_handler,
588                 GBusNameAcquiredCallback  name_acquired_handler,
589                 GBusNameLostCallback      name_lost_handler,
590                 gpointer                  user_data,
591                 GDestroyNotify            user_data_free_func)
592 {
593   Client *client;
594
595   g_return_val_if_fail (g_dbus_is_name (name) && !g_dbus_is_unique_name (name), 0);
596
597   G_LOCK (lock);
598
599   client = g_new0 (Client, 1);
600   client->ref_count = 1;
601   client->id = next_global_id++; /* TODO: uh oh, handle overflow */
602   client->name = g_strdup (name);
603   client->flags = flags;
604   client->bus_acquired_handler = bus_acquired_handler;
605   client->name_acquired_handler = name_acquired_handler;
606   client->name_lost_handler = name_lost_handler;
607   client->user_data = user_data;
608   client->user_data_free_func = user_data_free_func;
609   client->main_context = g_main_context_get_thread_default ();
610   if (client->main_context != NULL)
611     g_main_context_ref (client->main_context);
612
613   if (map_id_to_client == NULL)
614     {
615       map_id_to_client = g_hash_table_new (g_direct_hash, g_direct_equal);
616     }
617   g_hash_table_insert (map_id_to_client,
618                        GUINT_TO_POINTER (client->id),
619                        client);
620
621   g_bus_get (bus_type,
622              NULL,
623              connection_get_cb,
624              client_ref (client));
625
626   G_UNLOCK (lock);
627
628   return client->id;
629 }
630
631 typedef struct {
632   GClosure *bus_acquired_closure;
633   GClosure *name_acquired_closure;
634   GClosure *name_lost_closure;
635 } OwnNameData;
636
637 static void
638 own_with_closures_on_bus_acquired (GDBusConnection *connection,
639                                    const gchar     *name,
640                                    gpointer         user_data)
641 {
642   OwnNameData *data = user_data;
643   GValue params[2] = { { 0, }, { 0, } };
644
645   g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
646   g_value_set_object (&params[0], connection);
647
648   g_value_init (&params[1], G_TYPE_STRING);
649   g_value_set_string (&params[1], name);
650
651   g_closure_invoke (data->bus_acquired_closure, NULL, 2, params, NULL);
652 }
653
654 static void
655 own_with_closures_on_name_acquired (GDBusConnection *connection,
656                                     const gchar     *name,
657                                     gpointer         user_data)
658 {
659   OwnNameData *data = user_data;
660   GValue params[2] = { { 0, }, { 0, } };
661
662   g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
663   g_value_set_object (&params[0], connection);
664
665   g_value_init (&params[1], G_TYPE_STRING);
666   g_value_set_string (&params[1], name);
667
668   g_closure_invoke (data->name_acquired_closure, NULL, 2, params, NULL);
669 }
670
671 static void
672 own_with_closures_on_name_lost (GDBusConnection *connection,
673                                 const gchar     *name,
674                                 gpointer         user_data)
675 {
676   OwnNameData *data = user_data;
677   GValue params[2] = { { 0, }, { 0, } };
678
679   g_value_init (&params[0], G_TYPE_DBUS_CONNECTION);
680   g_value_set_object (&params[0], connection);
681
682   g_value_init (&params[1], G_TYPE_STRING);
683   g_value_set_string (&params[1], name);
684
685   g_closure_invoke (data->name_lost_closure, NULL, 2, params, NULL);
686 }
687
688 static void
689 bus_own_name_free_func (gpointer user_data)
690 {
691   OwnNameData *data = user_data;
692
693   if (data->bus_acquired_closure != NULL)
694     g_closure_unref (data->bus_acquired_closure);
695
696   if (data->name_acquired_closure != NULL)
697     g_closure_unref (data->name_acquired_closure);
698
699   if (data->name_lost_closure != NULL)
700     g_closure_unref (data->name_lost_closure);
701
702   g_free (data);
703 }
704
705 /**
706  * g_bus_own_name_with_closures:
707  * @bus_type: The type of bus to own a name on.
708  * @name: The well-known name to own.
709  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
710  * @bus_acquired_closure: (allow-none): #GClosure to invoke when connected to
711  * the bus of type @bus_type or %NULL.
712  * @name_acquired_closure: (allow-none): #GClosure to invoke when @name is
713  * acquired or %NULL.
714  * @name_lost_closure: (allow-none): #GClosure to invoke when @name is lost or
715  * %NULL.
716  *
717  * Version of g_bus_own_name() using closures instead of callbacks for
718  * easier binding in other languages.
719  *
720  * Returns: An identifier (never 0) that an be used with
721  * g_bus_unown_name() to stop owning the name.
722  *
723  * Rename to: g_bus_own_name
724  *
725  * Since: 2.26
726  */
727 guint
728 g_bus_own_name_with_closures (GBusType                  bus_type,
729                               const gchar              *name,
730                               GBusNameOwnerFlags        flags,
731                               GClosure                 *bus_acquired_closure,
732                               GClosure                 *name_acquired_closure,
733                               GClosure                 *name_lost_closure)
734 {
735   OwnNameData *data;
736
737   data = g_new0 (OwnNameData, 1);
738
739   if (bus_acquired_closure != NULL)
740     data->bus_acquired_closure = g_closure_ref (bus_acquired_closure);
741
742   if (name_acquired_closure != NULL)
743     data->name_acquired_closure = g_closure_ref (name_acquired_closure);
744
745   if (name_lost_closure != NULL)
746     data->name_lost_closure = g_closure_ref (name_lost_closure);
747
748   return g_bus_own_name (bus_type,
749           name,
750           flags,
751           bus_acquired_closure != NULL ? own_with_closures_on_bus_acquired : NULL,
752           name_acquired_closure != NULL ? own_with_closures_on_name_acquired : NULL,
753           name_lost_closure != NULL ? own_with_closures_on_name_lost : NULL,
754           data,
755           bus_own_name_free_func);
756 }
757
758 /**
759  * g_bus_own_name_on_connection_with_closures:
760  * @connection: A #GDBusConnection that is not closed.
761  * @name: The well-known name to own.
762  * @flags: A set of flags from the #GBusNameOwnerFlags enumeration.
763  * @name_acquired_closure: (allow-none): #GClosure to invoke when @name is
764  * acquired or %NULL.
765  * @name_lost_closure: (allow-none): #GClosure to invoke when @name is lost or
766  * %NULL.
767  *
768  * Version of g_bus_own_name_on_connection() using closures instead of callbacks for
769  * easier binding in other languages.
770  *
771  * Returns: An identifier (never 0) that an be used with
772  * g_bus_unown_name() to stop owning the name.
773  *
774  * Rename to: g_bus_own_name_on_connection
775  *
776  * Since: 2.26
777  */
778 guint
779 g_bus_own_name_on_connection_with_closures (GDBusConnection          *connection,
780                                             const gchar              *name,
781                                             GBusNameOwnerFlags        flags,
782                                             GClosure                 *name_acquired_closure,
783                                             GClosure                 *name_lost_closure)
784 {
785   OwnNameData *data;
786
787   data = g_new0 (OwnNameData, 1);
788
789   if (name_acquired_closure != NULL)
790     data->name_acquired_closure = g_closure_ref (name_acquired_closure);
791
792   if (name_lost_closure != NULL)
793     data->name_lost_closure = g_closure_ref (name_lost_closure);
794
795   return g_bus_own_name_on_connection (connection,
796           name,
797           flags,
798           name_acquired_closure != NULL ? own_with_closures_on_name_acquired : NULL,
799           name_lost_closure != NULL ? own_with_closures_on_name_lost : NULL,
800           data,
801           bus_own_name_free_func);
802 }
803
804 /**
805  * g_bus_unown_name:
806  * @owner_id: An identifier obtained from g_bus_own_name()
807  *
808  * Stops owning a name.
809  *
810  * Since: 2.26
811  */
812 void
813 g_bus_unown_name (guint owner_id)
814 {
815   Client *client;
816
817   g_return_if_fail (owner_id > 0);
818
819   client = NULL;
820
821   G_LOCK (lock);
822   if (owner_id == 0 || map_id_to_client == NULL ||
823       (client = g_hash_table_lookup (map_id_to_client, GUINT_TO_POINTER (owner_id))) == NULL)
824     {
825       g_warning ("Invalid id %d passed to g_bus_unown_name()", owner_id);
826       goto out;
827     }
828
829   client->cancelled = TRUE;
830   g_warn_if_fail (g_hash_table_remove (map_id_to_client, GUINT_TO_POINTER (owner_id)));
831
832  out:
833   G_UNLOCK (lock);
834
835   /* do callback without holding lock */
836   if (client != NULL)
837     {
838       /* Release the name if needed */
839       if (client->needs_release && client->connection != NULL)
840         {
841           GVariant *result;
842           GError *error;
843           guint32 release_name_reply;
844
845           /* TODO: it kinda sucks having to do a sync call to release the name - but if
846            * we don't, then a subsequent grab of the name will make the bus daemon return
847            * IN_QUEUE which will trigger name_lost().
848            *
849            * I believe this is a bug in the bus daemon.
850            */
851           error = NULL;
852           result = g_dbus_connection_call_sync (client->connection,
853                                                 "org.freedesktop.DBus",  /* bus name */
854                                                 "/org/freedesktop/DBus", /* object path */
855                                                 "org.freedesktop.DBus",  /* interface name */
856                                                 "ReleaseName",           /* method name */
857                                                 g_variant_new ("(s)", client->name),
858                                                 G_VARIANT_TYPE ("(u)"),
859                                                 G_DBUS_CALL_FLAGS_NONE,
860                                                 -1,
861                                                 NULL,
862                                                 &error);
863           if (result == NULL)
864             {
865               g_warning ("Error releasing name %s: %s", client->name, error->message);
866               g_error_free (error);
867             }
868           else
869             {
870               g_variant_get (result, "(u)", &release_name_reply);
871               if (release_name_reply != 1 /* DBUS_RELEASE_NAME_REPLY_RELEASED */)
872                 {
873                   g_warning ("Unexpected reply %d when releasing name %s", release_name_reply, client->name);
874                 }
875               g_variant_unref (result);
876             }
877         }
878
879       if (client->disconnected_signal_handler_id > 0)
880         g_signal_handler_disconnect (client->connection, client->disconnected_signal_handler_id);
881       if (client->name_acquired_subscription_id > 0)
882         g_dbus_connection_signal_unsubscribe (client->connection, client->name_acquired_subscription_id);
883       if (client->name_lost_subscription_id > 0)
884         g_dbus_connection_signal_unsubscribe (client->connection, client->name_lost_subscription_id);
885       client->disconnected_signal_handler_id = 0;
886       client->name_acquired_subscription_id = 0;
887       client->name_lost_subscription_id = 0;
888       if (client->connection != NULL)
889         {
890           g_object_unref (client->connection);
891           client->connection = NULL;
892         }
893
894       client_unref (client);
895     }
896 }
897
898 #define __G_DBUS_NAME_OWNING_C__
899 #include "gioaliasdef.c"