summaryrefslogtreecommitdiff
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
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.
-rw-r--r--ares_cancel.34
-rw-r--r--ares_gethostbyaddr.33
-rw-r--r--ares_gethostbyname.33
-rw-r--r--ares_getnameinfo.33
-rw-r--r--ares_query.33
-rw-r--r--ares_search.33
-rw-r--r--ares_send.33
7 files changed, 21 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)
diff --git a/ares_gethostbyaddr.3 b/ares_gethostbyaddr.3
index f589868..7727307 100644
--- a/ares_gethostbyaddr.3
+++ b/ares_gethostbyaddr.3
@@ -70,6 +70,9 @@ was not found.
.B ARES_ENOMEM
Memory was exhausted.
.TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
.B ARES_EDESTRUCTION
The name service channel
.I channel
diff --git a/ares_gethostbyname.3 b/ares_gethostbyname.3
index a578a53..6b24ea4 100644
--- a/ares_gethostbyname.3
+++ b/ares_gethostbyname.3
@@ -74,6 +74,9 @@ was not found.
.B ARES_ENOMEM
Memory was exhausted.
.TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
.B ARES_EDESTRUCTION
The name service channel
.I channel
diff --git a/ares_getnameinfo.3 b/ares_getnameinfo.3
index 7e4990c..d227606 100644
--- a/ares_getnameinfo.3
+++ b/ares_getnameinfo.3
@@ -109,6 +109,9 @@ was not found.
.B ARES_ENOMEM
Memory was exhausted.
.TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
.B ARES_EDESTRUCTION
The name service channel
.I channel
diff --git a/ares_query.3 b/ares_query.3
index 0c5df84..733fbc9 100644
--- a/ares_query.3
+++ b/ares_query.3
@@ -118,6 +118,9 @@ No name servers could be contacted.
.B ARES_ENOMEM
Memory was exhausted.
.TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
.B ARES_EDESTRUCTION
The name service channel
.I channel
diff --git a/ares_search.3 b/ares_search.3
index 4184b00..2c85d20 100644
--- a/ares_search.3
+++ b/ares_search.3
@@ -119,6 +119,9 @@ No name servers could be contacted.
.B ARES_ENOMEM
Memory was exhausted.
.TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
.B ARES_EDESTRUCTION
The name service channel
.I channel
diff --git a/ares_send.3 b/ares_send.3
index 48d90ab..b89abfe 100644
--- a/ares_send.3
+++ b/ares_send.3
@@ -73,6 +73,9 @@ No name servers could be contacted.
.B ARES_ENOMEM
Memory was exhausted.
.TP 19
+.B ARES_ECANCELLED
+The query was cancelled.
+.TP 19
.B ARES_EDESTRUCTION
The name service channel
.I channel