From 3f095ac75873015fc6758f1da7c21f955d5b5ab4 Mon Sep 17 00:00:00 2001 From: Danielle Madeley Date: Mon, 31 Oct 2011 22:33:38 +1100 Subject: Document the meaning of TpProxy::invalidated It turns out that when we talked about invalidation, people didn't actually know what this meant. --- telepathy-glib/proxy.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/telepathy-glib/proxy.c b/telepathy-glib/proxy.c index ae7fbec3..0a0b6dce 100644 --- a/telepathy-glib/proxy.c +++ b/telepathy-glib/proxy.c @@ -1383,6 +1383,14 @@ tp_proxy_class_init (TpProxyClass *klass) * * Emitted when this proxy has been become invalid for * whatever reason. Any more specific signal should be emitted first. + * + * An invalidated proxy is one which can make no more method calls and will + * emit no more D-Bus signals. This is typically because the D-Bus object + * represented by the proxy ceased to exist, or there was some error + * obtaining the initial state. + * + * Any pending or future method calls made on this proxy will fail gracefully + * with the same error as returned by tp_proxy_get_invalidated(). */ signals[SIGNAL_INVALIDATED] = g_signal_new ("invalidated", G_OBJECT_CLASS_TYPE (klass), -- cgit v1.2.3