Blame view

3rdparty/c-ares-1.18.1/docs/ares_cancel.3 1.6 KB
73ef4ff3   Hu Chunming   提交三方库
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
  .\"
  .\" Copyright 1998 by the Massachusetts Institute of Technology.
  .\"
  .\" Permission to use, copy, modify, and distribute this
  .\" software and its documentation for any purpose and without
  .\" fee is hereby granted, provided that the above copyright
  .\" notice appear in all copies and that both that copyright
  .\" notice and this permission notice appear in supporting
  .\" documentation, and that the name of M.I.T. not be used in
  .\" advertising or publicity pertaining to distribution of the
  .\" software without specific, written prior permission.
  .\" M.I.T. makes no representations about the suitability of
  .\" this software for any purpose.  It is provided "as is"
  .\" without express or implied warranty.
  .\"
  .TH ARES_CANCEL 3 "31 March 2004"
  .SH NAME
  ares_cancel \- Cancel a resolve
  .SH SYNOPSIS
  .nf
  #include <ares.h>
  
  void ares_cancel(ares_channel \fIchannel\fP)
  .fi
  .SH DESCRIPTION
  The \fBares_cancel(3)\fP function cancels all lookups/requests made on the the
  name service channel identified by \fIchannel\fP.  \fBares_cancel(3)\fP
  invokes the callbacks for each pending query on the channel, passing a status
  of
  .BR ARES_ECANCELLED .
  These calls give the callbacks a chance to clean up any state which 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(3)\fP.
  .SH SEE ALSO
  .BR ares_init (3)
  .BR ares_destroy (3)
  .SH NOTES
  This function was added in c-ares 1.2.0
  
  c-ares 1.6.0 and earlier pass a status of
  .BR ARES_ETIMEOUT
  instead of
  .BR ARES_ECANCELLED .
  .SH AUTHOR
  Dirk Manske