ares_destroy.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_DESTROY 3 "7 December 2004"
  17 .SH NAME
  18 ares_destroy \- Destroy a resolver channel
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <ares.h>
  22 .PP
  23 .B void ares_destroy(ares_channel \fIchannel\fP)
  24 .fi
  25 .SH DESCRIPTION
  26 The \fBares_destroy(3)\fP function destroys the name service channel
  27 identified by \fIchannel\fP, freeing all memory and closing all sockets used
  28 by the channel.
  29
  30 \fBares_destroy(3)\fP invokes the callbacks for each pending query on the
  31 channel, passing a status of \IARES_EDESTRUCTION\fP. These calls give the
  32 callbacks a chance to clean up any state which might have been stored in their
  33 arguments. A callback must not add new requests to a channel being destroyed.
  34 .SH SEE ALSO
  35 .BR ares_init (3),
  36 .BR ares_cancel (3)
  37 .SH AUTHOR
  38 Greg Hudson, MIT Information Systems
  39 .br
  40 Copyright 1998 by the Massachusetts Institute of Technology.