| lh | 9ed821d | 2023-04-07 01:36:19 -0700 | [diff] [blame^] | 1 | .\" |
| 2 | .\" Copyright 1998 by the Massachusetts Institute of Technology. |
| 3 | .\" |
| 4 | .\" Permission to use, copy, modify, and distribute this |
| 5 | .\" software and its documentation for any purpose and without |
| 6 | .\" fee is hereby granted, provided that the above copyright |
| 7 | .\" notice appear in all copies and that both that copyright |
| 8 | .\" notice and this permission notice appear in supporting |
| 9 | .\" documentation, and that the name of M.I.T. not be used in |
| 10 | .\" advertising or publicity pertaining to distribution of the |
| 11 | .\" software without specific, written prior permission. |
| 12 | .\" M.I.T. makes no representations about the suitability of |
| 13 | .\" this software for any purpose. It is provided "as is" |
| 14 | .\" without express or implied warranty. |
| 15 | .\" |
| 16 | .TH ARES_CANCEL 3 "31 March 2004" |
| 17 | .SH NAME |
| 18 | ares_cancel \- Cancel a resolve |
| 19 | .SH SYNOPSIS |
| 20 | .nf |
| 21 | .B #include <ares.h> |
| 22 | .PP |
| 23 | .B void ares_cancel(ares_channel \fIchannel\fP) |
| 24 | .fi |
| 25 | .SH DESCRIPTION |
| 26 | The \fBares_cancel(3)\fP function cancels all lookups/requests made on the the |
| 27 | name service channel identified by \fIchannel\fP. \fBares_cancel(3)\fP |
| 28 | invokes the callbacks for each pending query on the channel, passing a status |
| 29 | of |
| 30 | .BR ARES_ECANCELLED . |
| 31 | These calls give the callbacks a chance to clean up any state which might have |
| 32 | been stored in their arguments. If such a callback invocation adds a new |
| 33 | request to the channel, that request will \fInot\fP be cancelled by the |
| 34 | current invocation of \fBares_cancel(3)\fP. |
| 35 | .SH SEE ALSO |
| 36 | .BR ares_init (3) |
| 37 | .BR ares_destroy (3) |
| 38 | .SH NOTES |
| 39 | This function was added in c-ares 1.2.0 |
| 40 | |
| 41 | c-ares 1.6.0 and earlier pass a status of |
| 42 | .BR ARES_ETIMEOUT |
| 43 | instead of |
| 44 | .BR ARES_ECANCELLED . |
| 45 | .SH AUTHOR |
| 46 | Dirk Manske |