summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2011-10-21 11:42:10 +0100
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2011-10-24 10:40:29 +0100
commita124562d1bdd51de4b136725b3902b1e518d991f (patch)
tree95203306e00102719c5101b469ac5e54fa3811da
parenta031bacaac77d5de7388203dbe1ccc67b9142482 (diff)
GDBusConnection: document that this object is (meant to be) thread-safeHEADmaster
Bug: https://bugzilla.gnome.org/show_bug.cgi?id=661992 Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: David Zeuthen <davidz@redhat.com>
-rw-r--r--gio/gdbusconnection.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/gio/gdbusconnection.c b/gio/gdbusconnection.c
index 1b01624ab..76701e657 100644
--- a/gio/gdbusconnection.c
+++ b/gio/gdbusconnection.c
@@ -148,6 +148,15 @@
* an D-Bus client, it is often easier to use the g_bus_own_name(),
* g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs.
*
+ * As an exception to the usual GLib rule that a particular object must not be
+ * used by two threads at the same time, #GDBusConnection's methods may be
+ * called from any thread<footnote>
+ * <para>
+ * This is so that g_bus_get() and g_bus_get_sync() can safely return the
+ * same #GDBusConnection when called from any thread.
+ * </para>
+ * </footnote>.
+ *
* Most of the ways to obtain a #GDBusConnection automatically initialize it
* (i.e. connect to D-Bus): for instance, g_dbus_connection_new() and
* g_bus_get(), and the synchronous versions of those methods, give you an