summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-pending-call.c
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2006-10-21 23:09:18 +0000
committerHavoc Pennington <hp@redhat.com>2006-10-21 23:09:18 +0000
commitbf172ce4c5856af21f5ee208960bf718a5058ad9 (patch)
tree67f6be61c858a92d8ba388190d5ae3915c5f46b5 /dbus/dbus-pending-call.c
parent58a0d2759aedc854ccac78d7252f117662734142 (diff)
2006-10-21 Havoc Pennington <hp@redhat.com>
* Documentation! Whee! Doxygen now 100% silent. If you make it angry again, you will be punished.
Diffstat (limited to 'dbus/dbus-pending-call.c')
-rw-r--r--dbus/dbus-pending-call.c10
1 files changed, 8 insertions, 2 deletions
diff --git a/dbus/dbus-pending-call.c b/dbus/dbus-pending-call.c
index 403bf57c..ba174ef5 100644
--- a/dbus/dbus-pending-call.c
+++ b/dbus/dbus-pending-call.c
@@ -615,8 +615,14 @@ dbus_pending_call_set_notify (DBusPendingCall *pending,
* Cancels the pending call, such that any reply or error received
* will just be ignored. Drops the dbus library's internal reference
* to the #DBusPendingCall so will free the call if nobody else is
- * holding a reference. However you usually get a reference
- * from dbus_connection_send() so probably your app owns a ref also.
+ * holding a reference. However you usually get a reference from
+ * dbus_connection_send_with_reply() so probably your app owns a ref
+ * also.
+ *
+ * Note that canceling a pending call will <em>not</em> simulate a
+ * timed-out call; if a call times out, then a timeout error reply is
+ * received. If you cancel the call, no reply is received unless the
+ * the reply was already received before you canceled.
*
* @param pending the pending call
*/