[telepathy-glib/master] tp_proxy_signal_connection_unref: document when this function is unsafe to call

Simon McVittie simon.mcvittie at collabora.co.uk
Wed Aug 19 09:32:30 PDT 2009


---
 telepathy-glib/proxy-signals.c |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)

diff --git a/telepathy-glib/proxy-signals.c b/telepathy-glib/proxy-signals.c
index 38db326..c472f3d 100644
--- a/telepathy-glib/proxy-signals.c
+++ b/telepathy-glib/proxy-signals.c
@@ -194,6 +194,17 @@ tp_proxy_signal_connection_unref (TpProxySignalConnection *sc)
  * must not assume that the signal connection remains valid, but you must not
  * explicitly free it either.
  *
+ * It is not safe to call this function if @sc has been disconnected already,
+ * which happens in each of these situations:
+ *
+ * <itemizedlist>
+ * <listitem>the @weak_object used when @sc was created has been
+ *  destroyed</listitem>
+ * <listitem>tp_proxy_signal_connection_disconnect has already been
+ *  used</listitem>
+ * <listitem>the proxy has been invalidated</listitem>
+ * </itemizedlist>
+ *
  * Since: 0.7.1
  */
 void
-- 
1.5.6.5



More information about the telepathy-commits mailing list