Name

ares_destroy - Destroy a resolver channel

Synopsis

#include <ares.h>
 
void ares_destroy(ares_channel_t *channel)

Description

The ares_destroy function destroys the name service channel identified by channel, freeing all memory and closing all sockets used by the channel.

ares_destroy invokes the callbacks for each pending query on the channel, passing a status of ARES_EDESTRUCTION. These calls give the callbacks a chance to clean up any state which might have been stored in their arguments. A callback must not add new requests to a channel being destroyed. Such a request is refused: the request is not started, and its callback is invoked with a status of ARES_EDESTRUCTION so that any state attached to its argument can be released. A request made from within that notification is refused without a further notification, so that a callback which responds to failure by retrying cannot recurse without bound; its argument is not handed back. This applies as of c-ares version 1.35.0, and c-ares version 1.34.9 on the 1.34 branch.

There is no ability to make this function thread-safe. No additional calls using this channel may be made once this function is called.

See also

ares_init(3), ares_cancel(3), ares_threadsafety(3)

This HTML page was made with roffit.