Mercurial > repos > rliterman > csp2
annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man3/ares_cancel.3 @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
| author | jpayne |
|---|---|
| date | Tue, 18 Mar 2025 16:23:26 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| jpayne@68 | 1 .\" |
| jpayne@68 | 2 .\" Copyright 1998 by the Massachusetts Institute of Technology. |
| jpayne@68 | 3 .\" SPDX-License-Identifier: MIT |
| jpayne@68 | 4 .\" |
| jpayne@68 | 5 .TH ARES_CANCEL 3 "31 March 2004" |
| jpayne@68 | 6 .SH NAME |
| jpayne@68 | 7 ares_cancel \- Cancel a resolve |
| jpayne@68 | 8 .SH SYNOPSIS |
| jpayne@68 | 9 .nf |
| jpayne@68 | 10 #include <ares.h> |
| jpayne@68 | 11 |
| jpayne@68 | 12 void ares_cancel(ares_channel_t *\fIchannel\fP) |
| jpayne@68 | 13 .fi |
| jpayne@68 | 14 .SH DESCRIPTION |
| jpayne@68 | 15 The \fBares_cancel(3)\fP function cancels all lookups/requests made on the the |
| jpayne@68 | 16 name service channel identified by \fIchannel\fP. \fBares_cancel(3)\fP |
| jpayne@68 | 17 invokes the callbacks for each pending query on the channel, passing a status |
| jpayne@68 | 18 of |
| jpayne@68 | 19 .BR ARES_ECANCELLED . |
| jpayne@68 | 20 These calls give the callbacks a chance to clean up any state which might have |
| jpayne@68 | 21 been stored in their arguments. If such a callback invocation adds a new |
| jpayne@68 | 22 request to the channel, that request will \fInot\fP be cancelled by the |
| jpayne@68 | 23 current invocation of \fBares_cancel(3)\fP. |
| jpayne@68 | 24 .SH SEE ALSO |
| jpayne@68 | 25 .BR ares_init (3) |
| jpayne@68 | 26 .BR ares_destroy (3) |
| jpayne@68 | 27 .SH NOTES |
| jpayne@68 | 28 This function was added in c-ares 1.2.0 |
| jpayne@68 | 29 |
| jpayne@68 | 30 c-ares 1.6.0 and earlier pass a status of |
| jpayne@68 | 31 .BR ARES_ETIMEOUT |
| jpayne@68 | 32 instead of |
| jpayne@68 | 33 .BR ARES_ECANCELLED . |