summaryrefslogtreecommitdiff
path: root/ares_cancel.3
diff options
context:
space:
mode:
authorAlexander Klauer <Alexander.Klauer@itwm.fraunhofer.de>2013-04-08 09:48:44 (GMT)
committerDaniel Stenberg <daniel@haxx.se>2013-04-08 20:16:48 (GMT)
commitfa19279bba7aa9c0b452ff41ee252be2adffdee8 (patch)
tree74660f56e04d98f98c8a1e1703cbc98ff67f55ff /ares_cancel.3
parent54faf09da68691a88dbf1936f5969b53af364261 (diff)
downloadc-ares-fa19279bba7aa9c0b452ff41ee252be2adffdee8.zip
c-ares-fa19279bba7aa9c0b452ff41ee252be2adffdee8.tar.gz
c-ares-fa19279bba7aa9c0b452ff41ee252be2adffdee8.tar.bz2
Documentation: properly document ARES_ECANCELLED
This commit clarifies the behaviour of ares_cancel() with respect to callbacks and adds missing documentation of ARES_ECANCELLED to the man pages of the affected functions.
Diffstat (limited to 'ares_cancel.3')
-rw-r--r--ares_cancel.34
1 files changed, 3 insertions, 1 deletions
diff --git a/ares_cancel.3 b/ares_cancel.3
index ef10ec5..0bf6281 100644
--- a/ares_cancel.3
+++ b/ares_cancel.3
@@ -28,7 +28,9 @@ name service channel identified by \fIchannel\fP. \fBares_cancel\fP invokes
the callbacks for each pending query on the channel, passing a status of
.BR ARES_ECANCELLED .
These calls give the callbacks a chance to clean up any state which
-might have been stored in their arguments.
+might have been stored in their arguments. If such a callback invocation adds
+a new request to the channel, that request will \fInot\fP be cancelled by the
+current invocation of \fBares_cancel\fP.
.SH SEE ALSO
.BR ares_init (3)
.BR ares_destroy (3)