summaryrefslogtreecommitdiff
path: root/ares_cancel.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2009-08-03 11:51:06 (GMT)
committerDaniel Stenberg <daniel@haxx.se>2009-08-03 11:51:06 (GMT)
commit408df8efcdc7d724e3c94c2ae14b9b35372f95c4 (patch)
tree4e897543572f1c3b15cb29cdd1dc6881413952f1 /ares_cancel.3
parentd0a8c3b68bcea7c790bcb7c338aea0411def3fba (diff)
downloadc-ares-408df8efcdc7d724e3c94c2ae14b9b35372f95c4.zip
c-ares-408df8efcdc7d724e3c94c2ae14b9b35372f95c4.tar.gz
c-ares-408df8efcdc7d724e3c94c2ae14b9b35372f95c4.tar.bz2
- Timo Teras changed the reason code used in the resolve callback done when
ares_cancel() is used, to be ARES_ECANCELLED instead of ARES_ETIMEOUT to better allow the callback to know what's happening.
Diffstat (limited to 'ares_cancel.3')
-rw-r--r--ares_cancel.37
1 files changed, 6 insertions, 1 deletions
diff --git a/ares_cancel.3 b/ares_cancel.3
index 875f0f4..fc1e983 100644
--- a/ares_cancel.3
+++ b/ares_cancel.3
@@ -27,7 +27,7 @@ ares_cancel \- Cancel a resolve
The \fBares_cancel\fP function cancels all lookups/requests made on the the
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_ETIMEOUT .
+.BR ARES_ECANCELLED .
These calls give the callbacks a chance to clean up any state which
might have been stored in their arguments.
.SH SEE ALSO
@@ -35,5 +35,10 @@ might have been stored in their arguments.
.BR ares_destroy (3)
.SH NOTES
This function was added in c-ares 1.2.0
+
+c-ares 1.6.0 and earlier pass a status of
+.BR ARES_ETIMEOUT
+instead of
+.BR ARES_ECANCELLED .
.SH AUTHOR
Dirk Manske