ares_cancel.3

   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\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
  29 .BR ARES_ECANCELLED .
  30 These calls give the callbacks a chance to clean up any state which
  31 might have been stored in their arguments. If such a callback invocation adds
  32 a new request to the channel, that request will \fInot\fP be cancelled by the
  33 current invocation of \fBares_cancel\fP.
  34 .SH SEE ALSO
  35 .BR ares_init (3)
  36 .BR ares_destroy (3)
  37 .SH NOTES
  38 This function was added in c-ares 1.2.0
  39
  40 c-ares 1.6.0 and earlier pass a status of
  41 .BR ARES_ETIMEOUT
  42 instead of
  43 .BR ARES_ECANCELLED .
  44 .SH AUTHOR
  45 Dirk Manske