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