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.
pull/10/head
Alexander Klauer 12 years ago committed by Daniel Stenberg
parent 54faf09da6
commit fa19279bba
  1. 4
      ares_cancel.3
  2. 3
      ares_gethostbyaddr.3
  3. 3
      ares_gethostbyname.3
  4. 3
      ares_getnameinfo.3
  5. 3
      ares_query.3
  6. 3
      ares_search.3
  7. 3
      ares_send.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 the callbacks for each pending query on the channel, passing a status of
.BR ARES_ECANCELLED . .BR ARES_ECANCELLED .
These calls give the callbacks a chance to clean up any state which 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 .SH SEE ALSO
.BR ares_init (3) .BR ares_init (3)
.BR ares_destroy (3) .BR ares_destroy (3)

@ -70,6 +70,9 @@ was not found.
.B ARES_ENOMEM .B ARES_ENOMEM
Memory was exhausted. Memory was exhausted.
.TP 19 .TP 19
.B ARES_ECANCELLED
The query was cancelled.
.TP 19
.B ARES_EDESTRUCTION .B ARES_EDESTRUCTION
The name service channel The name service channel
.I channel .I channel

@ -74,6 +74,9 @@ was not found.
.B ARES_ENOMEM .B ARES_ENOMEM
Memory was exhausted. Memory was exhausted.
.TP 19 .TP 19
.B ARES_ECANCELLED
The query was cancelled.
.TP 19
.B ARES_EDESTRUCTION .B ARES_EDESTRUCTION
The name service channel The name service channel
.I channel .I channel

@ -109,6 +109,9 @@ was not found.
.B ARES_ENOMEM .B ARES_ENOMEM
Memory was exhausted. Memory was exhausted.
.TP 19 .TP 19
.B ARES_ECANCELLED
The query was cancelled.
.TP 19
.B ARES_EDESTRUCTION .B ARES_EDESTRUCTION
The name service channel The name service channel
.I channel .I channel

@ -118,6 +118,9 @@ No name servers could be contacted.
.B ARES_ENOMEM .B ARES_ENOMEM
Memory was exhausted. Memory was exhausted.
.TP 19 .TP 19
.B ARES_ECANCELLED
The query was cancelled.
.TP 19
.B ARES_EDESTRUCTION .B ARES_EDESTRUCTION
The name service channel The name service channel
.I channel .I channel

@ -119,6 +119,9 @@ No name servers could be contacted.
.B ARES_ENOMEM .B ARES_ENOMEM
Memory was exhausted. Memory was exhausted.
.TP 19 .TP 19
.B ARES_ECANCELLED
The query was cancelled.
.TP 19
.B ARES_EDESTRUCTION .B ARES_EDESTRUCTION
The name service channel The name service channel
.I channel .I channel

@ -73,6 +73,9 @@ No name servers could be contacted.
.B ARES_ENOMEM .B ARES_ENOMEM
Memory was exhausted. Memory was exhausted.
.TP 19 .TP 19
.B ARES_ECANCELLED
The query was cancelled.
.TP 19
.B ARES_EDESTRUCTION .B ARES_EDESTRUCTION
The name service channel The name service channel
.I channel .I channel

Loading…
Cancel
Save