Blame ares_destroy.3

Packit 514978
.\"
Packit 514978
.\" Copyright 1998 by the Massachusetts Institute of Technology.
Packit 514978
.\"
Packit 514978
.\" Permission to use, copy, modify, and distribute this
Packit 514978
.\" software and its documentation for any purpose and without
Packit 514978
.\" fee is hereby granted, provided that the above copyright
Packit 514978
.\" notice appear in all copies and that both that copyright
Packit 514978
.\" notice and this permission notice appear in supporting
Packit 514978
.\" documentation, and that the name of M.I.T. not be used in
Packit 514978
.\" advertising or publicity pertaining to distribution of the
Packit 514978
.\" software without specific, written prior permission.
Packit 514978
.\" M.I.T. makes no representations about the suitability of
Packit 514978
.\" this software for any purpose.  It is provided "as is"
Packit 514978
.\" without express or implied warranty.
Packit 514978
.\"
Packit 514978
.TH ARES_DESTROY 3 "7 December 2004"
Packit 514978
.SH NAME
Packit 514978
ares_destroy \- Destroy a resolver channel
Packit 514978
.SH SYNOPSIS
Packit 514978
.nf
Packit 514978
#include <ares.h>
Packit 514978
Packit 514978
void ares_destroy(ares_channel \fIchannel\fP)
Packit 514978
.fi
Packit 514978
.SH DESCRIPTION
Packit 514978
The \fBares_destroy(3)\fP function destroys the name service channel
Packit 514978
identified by \fIchannel\fP, freeing all memory and closing all sockets used
Packit 514978
by the channel.
Packit 514978
Packit 514978
\fBares_destroy(3)\fP invokes the callbacks for each pending query on the
Packit 514978
channel, passing a status of \fIARES_EDESTRUCTION\fP. These calls give the
Packit 514978
callbacks a chance to clean up any state which might have been stored in their
Packit 514978
arguments. A callback must not add new requests to a channel being destroyed.
Packit 514978
.SH SEE ALSO
Packit 514978
.BR ares_init (3),
Packit 514978
.BR ares_cancel (3)
Packit 514978
.SH AUTHOR
Packit 514978
Greg Hudson, MIT Information Systems
Packit 514978
.br
Packit 514978
Copyright 1998 by the Massachusetts Institute of Technology.