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, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: David Zeuthen <davidz@redhat.com>
25 #include "gdbusinterface.h"
26 #include "gdbusinterfaceskeleton.h"
27 #include "gdbusobjectskeleton.h"
28 #include "gioenumtypes.h"
29 #include "gdbusprivate.h"
30 #include "gdbusmethodinvocation.h"
31 #include "gdbusconnection.h"
38 * SECTION:gdbusinterfaceskeleton
39 * @short_description: Service-side D-Bus interface
42 * Abstract base class for D-Bus interfaces on the service side.
45 struct _GDBusInterfaceSkeletonPrivate
50 GDBusInterfaceSkeletonFlags flags
;
52 GSList
*connections
; /* List of ConnectionData */
53 gchar
*object_path
; /* The object path for this skeleton */
54 GDBusInterfaceVTable
*hooked_vtable
;
59 GDBusConnection
*connection
;
60 guint registration_id
;
65 G_AUTHORIZE_METHOD_SIGNAL
,
75 static guint signals
[LAST_SIGNAL
] = {0};
77 static void dbus_interface_interface_init (GDBusInterfaceIface
*iface
);
79 static void set_object_path_locked (GDBusInterfaceSkeleton
*interface_
,
80 const gchar
*object_path
);
81 static void remove_connection_locked (GDBusInterfaceSkeleton
*interface_
,
82 GDBusConnection
*connection
);
83 static void skeleton_intercept_handle_method_call (GDBusConnection
*connection
,
85 const gchar
*object_path
,
86 const gchar
*interface_name
,
87 const gchar
*method_name
,
89 GDBusMethodInvocation
*invocation
,
93 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GDBusInterfaceSkeleton
, g_dbus_interface_skeleton
, G_TYPE_OBJECT
,
94 G_IMPLEMENT_INTERFACE (G_TYPE_DBUS_INTERFACE
, dbus_interface_interface_init
));
97 g_dbus_interface_skeleton_finalize (GObject
*object
)
99 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (object
);
101 /* Hold the lock just incase any code we call verifies that the lock is held */
102 g_mutex_lock (&interface
->priv
->lock
);
104 /* unexport from all connections if we're exported anywhere */
105 while (interface
->priv
->connections
!= NULL
)
107 ConnectionData
*data
= interface
->priv
->connections
->data
;
108 remove_connection_locked (interface
, data
->connection
);
111 set_object_path_locked (interface
, NULL
);
113 g_mutex_unlock (&interface
->priv
->lock
);
115 g_free (interface
->priv
->hooked_vtable
);
117 if (interface
->priv
->object
!= NULL
)
118 g_object_remove_weak_pointer (G_OBJECT (interface
->priv
->object
), (gpointer
*) &interface
->priv
->object
);
120 g_mutex_clear (&interface
->priv
->lock
);
122 G_OBJECT_CLASS (g_dbus_interface_skeleton_parent_class
)->finalize (object
);
126 g_dbus_interface_skeleton_get_property (GObject
*object
,
131 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (object
);
136 g_value_set_flags (value
, g_dbus_interface_skeleton_get_flags (interface
));
140 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
146 g_dbus_interface_skeleton_set_property (GObject
*object
,
151 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (object
);
156 g_dbus_interface_skeleton_set_flags (interface
, g_value_get_flags (value
));
160 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
166 g_dbus_interface_skeleton_g_authorize_method_default (GDBusInterfaceSkeleton
*interface
,
167 GDBusMethodInvocation
*invocation
)
173 g_dbus_interface_skeleton_class_init (GDBusInterfaceSkeletonClass
*klass
)
175 GObjectClass
*gobject_class
;
177 gobject_class
= G_OBJECT_CLASS (klass
);
178 gobject_class
->finalize
= g_dbus_interface_skeleton_finalize
;
179 gobject_class
->set_property
= g_dbus_interface_skeleton_set_property
;
180 gobject_class
->get_property
= g_dbus_interface_skeleton_get_property
;
182 klass
->g_authorize_method
= g_dbus_interface_skeleton_g_authorize_method_default
;
185 * GDBusInterfaceSkeleton:g-flags:
187 * Flags from the #GDBusInterfaceSkeletonFlags enumeration.
191 g_object_class_install_property (gobject_class
,
193 g_param_spec_flags ("g-flags",
195 "Flags for the interface skeleton",
196 G_TYPE_DBUS_INTERFACE_SKELETON_FLAGS
,
197 G_DBUS_INTERFACE_SKELETON_FLAGS_NONE
,
200 G_PARAM_STATIC_STRINGS
));
203 * GDBusInterfaceSkeleton::g-authorize-method:
204 * @interface: The #GDBusInterfaceSkeleton emitting the signal.
205 * @invocation: A #GDBusMethodInvocation.
207 * Emitted when a method is invoked by a remote caller and used to
208 * determine if the method call is authorized.
210 * Note that this signal is emitted in a thread dedicated to
211 * handling the method call so handlers are allowed to perform
212 * blocking IO. This means that it is appropriate to call
214 * url="http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#polkit-authority-check-authorization-sync">polkit_authority_check_authorization_sync()</ulink>
216 * url="http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#POLKIT-CHECK-AUTHORIZATION-FLAGS-ALLOW-USER-INTERACTION:CAPS">POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION</ulink> flag set.
218 * If %FALSE is returned then no further handlers are run and the
219 * signal handler must take a reference to @invocation and finish
220 * handling the call (e.g. return an error via
221 * g_dbus_method_invocation_return_error()).
223 * Otherwise, if %TRUE is returned, signal emission continues. If no
224 * handlers return %FALSE, then the method is dispatched. If
225 * @interface has an enclosing #GDBusObjectSkeleton, then the
226 * #GDBusObjectSkeleton::authorize-method signal handlers run before
227 * the handlers for this signal.
229 * The default class handler just returns %TRUE.
231 * Please note that the common case is optimized: if no signals
232 * handlers are connected and the default class handler isn't
233 * overridden (for both @interface and the enclosing
234 * #GDBusObjectSkeleton, if any) and #GDBusInterfaceSkeleton:g-flags does
236 * %G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
237 * flags set, no dedicated thread is ever used and the call will be
238 * handled in the same thread as the object that @interface belongs
239 * to was exported in.
241 * Returns: %TRUE if the call is authorized, %FALSE otherwise.
245 signals
[G_AUTHORIZE_METHOD_SIGNAL
] =
246 g_signal_new ("g-authorize-method",
247 G_TYPE_DBUS_INTERFACE_SKELETON
,
249 G_STRUCT_OFFSET (GDBusInterfaceSkeletonClass
, g_authorize_method
),
250 _g_signal_accumulator_false_handled
,
255 G_TYPE_DBUS_METHOD_INVOCATION
);
257 g_type_class_add_private (klass
, sizeof (GDBusInterfaceSkeletonPrivate
));
261 g_dbus_interface_skeleton_init (GDBusInterfaceSkeleton
*interface
)
263 interface
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (interface
, G_TYPE_DBUS_INTERFACE_SKELETON
, GDBusInterfaceSkeletonPrivate
);
264 g_mutex_init (&interface
->priv
->lock
);
267 /* ---------------------------------------------------------------------------------------------------- */
270 * g_dbus_interface_skeleton_get_flags:
271 * @interface_: A #GDBusInterfaceSkeleton.
273 * Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior
276 * Returns: One or more flags from the #GDBusInterfaceSkeletonFlags enumeration.
280 GDBusInterfaceSkeletonFlags
281 g_dbus_interface_skeleton_get_flags (GDBusInterfaceSkeleton
*interface_
)
283 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), G_DBUS_INTERFACE_SKELETON_FLAGS_NONE
);
284 return interface_
->priv
->flags
;
288 * g_dbus_interface_skeleton_set_flags:
289 * @interface_: A #GDBusInterfaceSkeleton.
290 * @flags: Flags from the #GDBusInterfaceSkeletonFlags enumeration.
292 * Sets flags describing what the behavior of @skeleton should be.
297 g_dbus_interface_skeleton_set_flags (GDBusInterfaceSkeleton
*interface_
,
298 GDBusInterfaceSkeletonFlags flags
)
300 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
));
301 g_mutex_lock (&interface_
->priv
->lock
);
302 if (interface_
->priv
->flags
!= flags
)
304 interface_
->priv
->flags
= flags
;
305 g_mutex_unlock (&interface_
->priv
->lock
);
306 g_object_notify (G_OBJECT (interface_
), "g-flags");
310 g_mutex_unlock (&interface_
->priv
->lock
);
315 * g_dbus_interface_skeleton_get_info:
316 * @interface_: A #GDBusInterfaceSkeleton.
318 * Gets D-Bus introspection information for the D-Bus interface
319 * implemented by @interface_.
321 * Returns: (transfer none): A #GDBusInterfaceInfo (never %NULL). Do not free.
326 g_dbus_interface_skeleton_get_info (GDBusInterfaceSkeleton
*interface_
)
328 GDBusInterfaceInfo
*ret
;
329 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), NULL
);
330 ret
= G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_
)->get_info (interface_
);
331 g_warn_if_fail (ret
!= NULL
);
336 * g_dbus_interface_skeleton_get_vtable: (skip)
337 * @interface_: A #GDBusInterfaceSkeleton.
339 * Gets the interface vtable for the D-Bus interface implemented by
340 * @interface_. The returned function pointers should expect @interface_
341 * itself to be passed as @user_data.
343 * Returns: A #GDBusInterfaceVTable (never %NULL).
347 GDBusInterfaceVTable
*
348 g_dbus_interface_skeleton_get_vtable (GDBusInterfaceSkeleton
*interface_
)
350 GDBusInterfaceVTable
*ret
;
351 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), NULL
);
352 ret
= G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_
)->get_vtable (interface_
);
353 g_warn_if_fail (ret
!= NULL
);
358 * g_dbus_interface_skeleton_get_properties:
359 * @interface_: A #GDBusInterfaceSkeleton.
361 * Gets all D-Bus properties for @interface_.
363 * Returns: (transfer full): A #GVariant of type <link linkend="G-VARIANT-TYPE-VARDICT:CAPS">'a{sv}'</link>. Free with g_variant_unref().
368 g_dbus_interface_skeleton_get_properties (GDBusInterfaceSkeleton
*interface_
)
371 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), NULL
);
372 ret
= G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_
)->get_properties (interface_
);
373 return g_variant_take_ref (ret
);
377 * g_dbus_interface_skeleton_flush:
378 * @interface_: A #GDBusInterfaceSkeleton.
380 * If @interface_ has outstanding changes, request for these changes to be
381 * emitted immediately.
383 * For example, an exported D-Bus interface may queue up property
384 * changes and emit the
385 * <literal>org.freedesktop.DBus.Properties::PropertiesChanged</literal>
386 * signal later (e.g. in an idle handler). This technique is useful
387 * for collapsing multiple property changes into one.
392 g_dbus_interface_skeleton_flush (GDBusInterfaceSkeleton
*interface_
)
394 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
));
395 G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface_
)->flush (interface_
);
398 /* ---------------------------------------------------------------------------------------------------- */
400 static GDBusInterfaceInfo
*
401 _g_dbus_interface_skeleton_get_info (GDBusInterface
*interface_
)
403 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (interface_
);
404 return g_dbus_interface_skeleton_get_info (interface
);
408 g_dbus_interface_skeleton_get_object (GDBusInterface
*interface_
)
410 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (interface_
);
412 g_mutex_lock (&interface
->priv
->lock
);
413 ret
= interface
->priv
->object
;
414 g_mutex_unlock (&interface
->priv
->lock
);
419 g_dbus_interface_skeleton_dup_object (GDBusInterface
*interface_
)
421 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (interface_
);
423 g_mutex_lock (&interface
->priv
->lock
);
424 ret
= interface
->priv
->object
;
427 g_mutex_unlock (&interface
->priv
->lock
);
432 g_dbus_interface_skeleton_set_object (GDBusInterface
*interface_
,
435 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (interface_
);
436 g_mutex_lock (&interface
->priv
->lock
);
437 if (interface
->priv
->object
!= NULL
)
438 g_object_remove_weak_pointer (G_OBJECT (interface
->priv
->object
), (gpointer
*) &interface
->priv
->object
);
439 interface
->priv
->object
= object
;
441 g_object_add_weak_pointer (G_OBJECT (interface
->priv
->object
), (gpointer
*) &interface
->priv
->object
);
442 g_mutex_unlock (&interface
->priv
->lock
);
446 dbus_interface_interface_init (GDBusInterfaceIface
*iface
)
448 iface
->get_info
= _g_dbus_interface_skeleton_get_info
;
449 iface
->get_object
= g_dbus_interface_skeleton_get_object
;
450 iface
->dup_object
= g_dbus_interface_skeleton_dup_object
;
451 iface
->set_object
= g_dbus_interface_skeleton_set_object
;
454 /* ---------------------------------------------------------------------------------------------------- */
458 volatile gint ref_count
;
459 GDBusInterfaceSkeleton
*interface
;
460 GDBusInterfaceMethodCallFunc method_call_func
;
461 GDBusMethodInvocation
*invocation
;
465 dispatch_data_unref (DispatchData
*data
)
467 if (g_atomic_int_dec_and_test (&data
->ref_count
))
468 g_slice_free (DispatchData
, data
);
471 static DispatchData
*
472 dispatch_data_ref (DispatchData
*data
)
474 g_atomic_int_inc (&data
->ref_count
);
479 dispatch_invoke_in_context_func (gpointer user_data
)
481 DispatchData
*data
= user_data
;
482 data
->method_call_func (g_dbus_method_invocation_get_connection (data
->invocation
),
483 g_dbus_method_invocation_get_sender (data
->invocation
),
484 g_dbus_method_invocation_get_object_path (data
->invocation
),
485 g_dbus_method_invocation_get_interface_name (data
->invocation
),
486 g_dbus_method_invocation_get_method_name (data
->invocation
),
487 g_dbus_method_invocation_get_parameters (data
->invocation
),
489 g_dbus_method_invocation_get_user_data (data
->invocation
));
494 dispatch_in_thread_func (GTask
*task
,
495 gpointer source_object
,
497 GCancellable
*cancellable
)
499 DispatchData
*data
= task_data
;
500 GDBusInterfaceSkeletonFlags flags
;
504 g_mutex_lock (&data
->interface
->priv
->lock
);
505 flags
= data
->interface
->priv
->flags
;
506 object
= data
->interface
->priv
->object
;
508 g_object_ref (object
);
509 g_mutex_unlock (&data
->interface
->priv
->lock
);
511 /* first check on the enclosing object (if any), then the interface */
515 g_signal_emit_by_name (object
,
523 g_signal_emit (data
->interface
,
524 signals
[G_AUTHORIZE_METHOD_SIGNAL
],
532 gboolean run_in_thread
;
533 run_in_thread
= (flags
& G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
);
536 /* might as well just re-use the existing thread */
537 data
->method_call_func (g_dbus_method_invocation_get_connection (data
->invocation
),
538 g_dbus_method_invocation_get_sender (data
->invocation
),
539 g_dbus_method_invocation_get_object_path (data
->invocation
),
540 g_dbus_method_invocation_get_interface_name (data
->invocation
),
541 g_dbus_method_invocation_get_method_name (data
->invocation
),
542 g_dbus_method_invocation_get_parameters (data
->invocation
),
544 g_dbus_method_invocation_get_user_data (data
->invocation
));
548 /* bah, back to original context */
549 g_main_context_invoke_full (g_task_get_context (task
),
550 g_task_get_priority (task
),
551 dispatch_invoke_in_context_func
,
552 dispatch_data_ref (data
),
553 (GDestroyNotify
) dispatch_data_unref
);
562 g_object_unref (object
);
566 g_dbus_interface_method_dispatch_helper (GDBusInterfaceSkeleton
*interface
,
567 GDBusInterfaceMethodCallFunc method_call_func
,
568 GDBusMethodInvocation
*invocation
)
570 gboolean has_handlers
;
571 gboolean has_default_class_handler
;
572 gboolean emit_authorized_signal
;
573 gboolean run_in_thread
;
574 GDBusInterfaceSkeletonFlags flags
;
577 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface
));
578 g_return_if_fail (method_call_func
!= NULL
);
579 g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation
));
581 g_mutex_lock (&interface
->priv
->lock
);
582 flags
= interface
->priv
->flags
;
583 object
= interface
->priv
->object
;
585 g_object_ref (object
);
586 g_mutex_unlock (&interface
->priv
->lock
);
588 /* optimization for the common case where
590 * a) no handler is connected and class handler is not overridden (both interface and object); and
591 * b) method calls are not dispatched in a thread
593 has_handlers
= g_signal_has_handler_pending (interface
,
594 signals
[G_AUTHORIZE_METHOD_SIGNAL
],
597 has_default_class_handler
= (G_DBUS_INTERFACE_SKELETON_GET_CLASS (interface
)->g_authorize_method
==
598 g_dbus_interface_skeleton_g_authorize_method_default
);
600 emit_authorized_signal
= (has_handlers
|| !has_default_class_handler
);
601 if (!emit_authorized_signal
)
604 emit_authorized_signal
= _g_dbus_object_skeleton_has_authorize_method_handlers (G_DBUS_OBJECT_SKELETON (object
));
607 run_in_thread
= (flags
& G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
);
608 if (!emit_authorized_signal
&& !run_in_thread
)
610 method_call_func (g_dbus_method_invocation_get_connection (invocation
),
611 g_dbus_method_invocation_get_sender (invocation
),
612 g_dbus_method_invocation_get_object_path (invocation
),
613 g_dbus_method_invocation_get_interface_name (invocation
),
614 g_dbus_method_invocation_get_method_name (invocation
),
615 g_dbus_method_invocation_get_parameters (invocation
),
617 g_dbus_method_invocation_get_user_data (invocation
));
624 data
= g_slice_new0 (DispatchData
);
625 data
->interface
= interface
;
626 data
->method_call_func
= method_call_func
;
627 data
->invocation
= invocation
;
630 task
= g_task_new (interface
, NULL
, NULL
, NULL
);
631 g_task_set_task_data (task
, data
, (GDestroyNotify
) dispatch_data_unref
);
632 g_task_run_in_thread (task
, dispatch_in_thread_func
);
633 g_object_unref (task
);
637 g_object_unref (object
);
641 skeleton_intercept_handle_method_call (GDBusConnection
*connection
,
643 const gchar
*object_path
,
644 const gchar
*interface_name
,
645 const gchar
*method_name
,
646 GVariant
*parameters
,
647 GDBusMethodInvocation
*invocation
,
650 GDBusInterfaceSkeleton
*interface
= G_DBUS_INTERFACE_SKELETON (user_data
);
651 g_dbus_interface_method_dispatch_helper (interface
,
652 g_dbus_interface_skeleton_get_vtable (interface
)->method_call
,
656 /* ---------------------------------------------------------------------------------------------------- */
658 static ConnectionData
*
659 new_connection (GDBusConnection
*connection
,
660 guint registration_id
)
662 ConnectionData
*data
;
664 data
= g_slice_new0 (ConnectionData
);
665 data
->connection
= g_object_ref (connection
);
666 data
->registration_id
= registration_id
;
672 free_connection (ConnectionData
*data
)
676 g_object_unref (data
->connection
);
677 g_slice_free (ConnectionData
, data
);
682 add_connection_locked (GDBusInterfaceSkeleton
*interface_
,
683 GDBusConnection
*connection
,
686 ConnectionData
*data
;
687 guint registration_id
;
688 gboolean ret
= FALSE
;
690 if (interface_
->priv
->hooked_vtable
== NULL
)
692 /* Hook the vtable since we need to intercept method calls for
693 * ::g-authorize-method and for dispatching in thread vs
696 * We need to wait until subclasses have had time to initialize
697 * properly before building the hooked_vtable, so we create it
698 * once at the last minute.
700 interface_
->priv
->hooked_vtable
= g_memdup (g_dbus_interface_skeleton_get_vtable (interface_
), sizeof (GDBusInterfaceVTable
));
701 interface_
->priv
->hooked_vtable
->method_call
= skeleton_intercept_handle_method_call
;
704 registration_id
= g_dbus_connection_register_object (connection
,
705 interface_
->priv
->object_path
,
706 g_dbus_interface_skeleton_get_info (interface_
),
707 interface_
->priv
->hooked_vtable
,
709 NULL
, /* user_data_free_func */
712 if (registration_id
> 0)
714 data
= new_connection (connection
, registration_id
);
715 interface_
->priv
->connections
= g_slist_append (interface_
->priv
->connections
, data
);
723 remove_connection_locked (GDBusInterfaceSkeleton
*interface_
,
724 GDBusConnection
*connection
)
726 ConnectionData
*data
;
729 /* Get the connection in the list and unregister ... */
730 for (l
= interface_
->priv
->connections
; l
!= NULL
; l
= l
->next
)
733 if (data
->connection
== connection
)
735 g_warn_if_fail (g_dbus_connection_unregister_object (data
->connection
, data
->registration_id
));
736 free_connection (data
);
737 interface_
->priv
->connections
= g_slist_delete_link (interface_
->priv
->connections
, l
);
738 /* we are guaranteed that the connection is only added once, so bail out early */
747 set_object_path_locked (GDBusInterfaceSkeleton
*interface_
,
748 const gchar
*object_path
)
750 if (g_strcmp0 (interface_
->priv
->object_path
, object_path
) != 0)
752 g_free (interface_
->priv
->object_path
);
753 interface_
->priv
->object_path
= g_strdup (object_path
);
757 /* ---------------------------------------------------------------------------------------------------- */
760 * g_dbus_interface_skeleton_get_connection:
761 * @interface_: A #GDBusInterfaceSkeleton.
763 * Gets the first connection that @interface_ is exported on, if any.
765 * Returns: (transfer none): A #GDBusConnection or %NULL if @interface_ is
766 * not exported anywhere. Do not free, the object belongs to @interface_.
771 g_dbus_interface_skeleton_get_connection (GDBusInterfaceSkeleton
*interface_
)
773 ConnectionData
*data
;
774 GDBusConnection
*ret
;
776 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), NULL
);
777 g_mutex_lock (&interface_
->priv
->lock
);
780 if (interface_
->priv
->connections
!= NULL
)
782 data
= interface_
->priv
->connections
->data
;
784 ret
= data
->connection
;
787 g_mutex_unlock (&interface_
->priv
->lock
);
793 * g_dbus_interface_skeleton_get_connections:
794 * @interface_: A #GDBusInterfaceSkeleton.
796 * Gets a list of the connections that @interface_ is exported on.
798 * Returns: (element-type GDBusConnection) (transfer full): A list of
799 * all the connections that @interface_ is exported on. The returned
800 * list should be freed with g_list_free() after each element has
801 * been freed with g_object_unref().
806 g_dbus_interface_skeleton_get_connections (GDBusInterfaceSkeleton
*interface_
)
810 ConnectionData
*data
;
812 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), NULL
);
814 g_mutex_lock (&interface_
->priv
->lock
);
817 for (l
= interface_
->priv
->connections
; l
!= NULL
; l
= l
->next
)
820 connections
= g_list_prepend (connections
,
821 /* Return a reference to each connection */
822 g_object_ref (data
->connection
));
825 g_mutex_unlock (&interface_
->priv
->lock
);
827 return g_list_reverse (connections
);
831 * g_dbus_interface_skeleton_has_connection:
832 * @interface_: A #GDBusInterfaceSkeleton.
833 * @connection: A #GDBusConnection.
835 * Checks if @interface_ is exported on @connection.
837 * Returns: %TRUE if @interface_ is exported on @connection, %FALSE otherwise.
842 g_dbus_interface_skeleton_has_connection (GDBusInterfaceSkeleton
*interface_
,
843 GDBusConnection
*connection
)
846 gboolean ret
= FALSE
;
848 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), FALSE
);
849 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection
), FALSE
);
851 g_mutex_lock (&interface_
->priv
->lock
);
853 for (l
= interface_
->priv
->connections
; l
!= NULL
; l
= l
->next
)
855 ConnectionData
*data
= l
->data
;
856 if (data
->connection
== connection
)
864 g_mutex_unlock (&interface_
->priv
->lock
);
869 * g_dbus_interface_skeleton_get_object_path:
870 * @interface_: A #GDBusInterfaceSkeleton.
872 * Gets the object path that @interface_ is exported on, if any.
874 * Returns: A string owned by @interface_ or %NULL if @interface_ is not exported
875 * anywhere. Do not free, the string belongs to @interface_.
880 g_dbus_interface_skeleton_get_object_path (GDBusInterfaceSkeleton
*interface_
)
883 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), NULL
);
884 g_mutex_lock (&interface_
->priv
->lock
);
885 ret
= interface_
->priv
->object_path
;
886 g_mutex_unlock (&interface_
->priv
->lock
);
891 * g_dbus_interface_skeleton_export:
892 * @interface_: The D-Bus interface to export.
893 * @connection: A #GDBusConnection to export @interface_ on.
894 * @object_path: The path to export the interface at.
895 * @error: Return location for error or %NULL.
897 * Exports @interface_ at @object_path on @connection.
899 * This can be called multiple times to export the same @interface_
900 * onto multiple connections however the @object_path provided must be
901 * the same for all connections.
903 * Use g_dbus_interface_skeleton_unexport() to unexport the object.
905 * Returns: %TRUE if the interface was exported on @connection, otherwise %FALSE with
911 g_dbus_interface_skeleton_export (GDBusInterfaceSkeleton
*interface_
,
912 GDBusConnection
*connection
,
913 const gchar
*object_path
,
916 gboolean ret
= FALSE
;
918 g_return_val_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
), FALSE
);
919 g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection
), FALSE
);
920 g_return_val_if_fail (g_variant_is_object_path (object_path
), FALSE
);
921 g_return_val_if_fail (error
== NULL
|| *error
== NULL
, FALSE
);
923 /* Assert that the object path is the same for multiple connections here */
924 g_return_val_if_fail (interface_
->priv
->object_path
== NULL
||
925 g_strcmp0 (interface_
->priv
->object_path
, object_path
) == 0, FALSE
);
927 g_mutex_lock (&interface_
->priv
->lock
);
929 /* Set the object path */
930 set_object_path_locked (interface_
, object_path
);
932 /* Add the connection */
933 ret
= add_connection_locked (interface_
, connection
, error
);
935 g_mutex_unlock (&interface_
->priv
->lock
);
940 * g_dbus_interface_skeleton_unexport:
941 * @interface_: A #GDBusInterfaceSkeleton.
943 * Stops exporting @interface_ on all connections it is exported on.
945 * To unexport @interface_ from only a single connection, use
946 * g_dbus_interface_skeleton_unexport_from_connection()
951 g_dbus_interface_skeleton_unexport (GDBusInterfaceSkeleton
*interface_
)
953 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
));
954 g_return_if_fail (interface_
->priv
->connections
!= NULL
);
956 g_mutex_lock (&interface_
->priv
->lock
);
958 g_assert (interface_
->priv
->object_path
!= NULL
);
959 g_assert (interface_
->priv
->hooked_vtable
!= NULL
);
961 /* Remove all connections */
962 while (interface_
->priv
->connections
!= NULL
)
964 ConnectionData
*data
= interface_
->priv
->connections
->data
;
965 remove_connection_locked (interface_
, data
->connection
);
968 /* Unset the object path since there are no connections left */
969 set_object_path_locked (interface_
, NULL
);
971 g_mutex_unlock (&interface_
->priv
->lock
);
976 * g_dbus_interface_skeleton_unexport_from_connection:
977 * @interface_: A #GDBusInterfaceSkeleton.
978 * @connection: A #GDBusConnection.
980 * Stops exporting @interface_ on @connection.
982 * To stop exporting on all connections the interface is exported on,
983 * use g_dbus_interface_skeleton_unexport().
988 g_dbus_interface_skeleton_unexport_from_connection (GDBusInterfaceSkeleton
*interface_
,
989 GDBusConnection
*connection
)
991 g_return_if_fail (G_IS_DBUS_INTERFACE_SKELETON (interface_
));
992 g_return_if_fail (G_IS_DBUS_CONNECTION (connection
));
993 g_return_if_fail (interface_
->priv
->connections
!= NULL
);
995 g_mutex_lock (&interface_
->priv
->lock
);
997 g_assert (interface_
->priv
->object_path
!= NULL
);
998 g_assert (interface_
->priv
->hooked_vtable
!= NULL
);
1000 remove_connection_locked (interface_
, connection
);
1002 /* Reset the object path if we removed the last connection */
1003 if (interface_
->priv
->connections
== NULL
)
1004 set_object_path_locked (interface_
, NULL
);
1006 g_mutex_unlock (&interface_
->priv
->lock
);
1009 /* ---------------------------------------------------------------------------------------------------- */