Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 44 lines (42 sloc) 1.484 kB
86ae234 @bagder Dirk Manske's ares_cancel() function was added.
authored
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
497afa9 @yangtse - Jakub Hrozek fixed more function prototypes in man pages to sync them
yangtse authored
23 .B void ares_cancel(ares_channel \fIchannel\fP)
86ae234 @bagder Dirk Manske's ares_cancel() function was added.
authored
24 .fi
25 .SH DESCRIPTION
26 The \fBares_cancel\fP function cancels all lookups/requests made on the the
27 name service channel identified by \fIchannel\fP. \fBares_cancel\fP invokes
28 the callbacks for each pending query on the channel, passing a status of
408df8e @bagder - Timo Teras changed the reason code used in the resolve callback don…
authored
29 .BR ARES_ECANCELLED .
86ae234 @bagder Dirk Manske's ares_cancel() function was added.
authored
30 These calls give the callbacks a chance to clean up any state which
31 might have been stored in their arguments.
32 .SH SEE ALSO
33 .BR ares_init (3)
34 .BR ares_destroy (3)
2c27c35 @bagder mention incompatibilities with ares
authored
35 .SH NOTES
ab18b89 @bagder This function was added in c-ares [version]
authored
36 This function was added in c-ares 1.2.0
408df8e @bagder - Timo Teras changed the reason code used in the resolve callback don…
authored
37
38 c-ares 1.6.0 and earlier pass a status of
39 .BR ARES_ETIMEOUT
40 instead of
41 .BR ARES_ECANCELLED .
86ae234 @bagder Dirk Manske's ares_cancel() function was added.
authored
42 .SH AUTHOR
43 Dirk Manske
Something went wrong with that request. Please try again.