ares_destroy.3 (986B)
1 .\" 2 .\" Copyright 1998 by the Massachusetts Institute of Technology. 3 .\" SPDX-License-Identifier: MIT 4 .\" 5 .TH ARES_DESTROY 3 "7 December 2004" 6 .SH NAME 7 ares_destroy \- Destroy a resolver channel 8 .SH SYNOPSIS 9 .nf 10 #include <ares.h> 11 12 void ares_destroy(ares_channel_t *\fIchannel\fP) 13 .fi 14 .SH DESCRIPTION 15 The \fBares_destroy(3)\fP function destroys the name service channel 16 identified by \fIchannel\fP, freeing all memory and closing all sockets used 17 by the channel. 18 19 \fBares_destroy(3)\fP invokes the callbacks for each pending query on the 20 channel, passing a status of \fIARES_EDESTRUCTION\fP. These calls give the 21 callbacks a chance to clean up any state which might have been stored in their 22 arguments. A callback must not add new requests to a channel being destroyed. 23 24 There is no ability to make this function thread-safe. No additional calls 25 using this channel may be made once this function is called. 26 .SH SEE ALSO 27 .BR ares_init (3), 28 .BR ares_cancel (3), 29 .BR ares_threadsafety (3)