Mercurial > repos > rliterman > csp2
annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man3/ares_destroy.3 @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
| author | jpayne |
|---|---|
| date | Tue, 18 Mar 2025 16:23:26 -0400 |
| parents | |
| children |
| rev | line source |
|---|---|
| jpayne@68 | 1 .\" |
| jpayne@68 | 2 .\" Copyright 1998 by the Massachusetts Institute of Technology. |
| jpayne@68 | 3 .\" SPDX-License-Identifier: MIT |
| jpayne@68 | 4 .\" |
| jpayne@68 | 5 .TH ARES_DESTROY 3 "7 December 2004" |
| jpayne@68 | 6 .SH NAME |
| jpayne@68 | 7 ares_destroy \- Destroy a resolver channel |
| jpayne@68 | 8 .SH SYNOPSIS |
| jpayne@68 | 9 .nf |
| jpayne@68 | 10 #include <ares.h> |
| jpayne@68 | 11 |
| jpayne@68 | 12 void ares_destroy(ares_channel_t *\fIchannel\fP) |
| jpayne@68 | 13 .fi |
| jpayne@68 | 14 .SH DESCRIPTION |
| jpayne@68 | 15 The \fBares_destroy(3)\fP function destroys the name service channel |
| jpayne@68 | 16 identified by \fIchannel\fP, freeing all memory and closing all sockets used |
| jpayne@68 | 17 by the channel. |
| jpayne@68 | 18 |
| jpayne@68 | 19 \fBares_destroy(3)\fP invokes the callbacks for each pending query on the |
| jpayne@68 | 20 channel, passing a status of \fIARES_EDESTRUCTION\fP. These calls give the |
| jpayne@68 | 21 callbacks a chance to clean up any state which might have been stored in their |
| jpayne@68 | 22 arguments. A callback must not add new requests to a channel being destroyed. |
| jpayne@68 | 23 |
| jpayne@68 | 24 There is no ability to make this function thread-safe. No additional calls |
| jpayne@68 | 25 using this channel may be made once this function is called. |
| jpayne@68 | 26 .SH SEE ALSO |
| jpayne@68 | 27 .BR ares_init (3), |
| jpayne@68 | 28 .BR ares_cancel (3), |
| jpayne@68 | 29 .BR ares_threadsafety (3) |