ares_cancel - Cancel a resolve
#include <ares.h> void ares_cancel(ares_channel channel)
ARES_CANCEL(3) Library Functions Manual ARES_CANCEL(3)
NAME
ares_cancel - Cancel a resolve
SYNOPSIS
#include <ares.h>
void ares_cancel(ares_channel channel)
DESCRIPTION
The ares_cancel(3) function cancels all lookups/requests made on the
the name service channel identified by channel. ares_cancel(3) invokes
the callbacks for each pending query on the channel, passing a status
of ARES_ECANCELLED. These calls give the callbacks a chance to clean
up any state which might have been stored in their arguments. If such a
callback invocation adds a new request to the channel, that request
will not be cancelled by the current invocation of ares_cancel(3).
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libcares |
+---------------+------------------+
|Stability | Volatile |
+---------------+------------------+
SEE ALSO
ares_init(3) ares_destroy(3)
NOTES
This function was added in c-ares 1.2.0
c-ares 1.6.0 and earlier pass a status of ARES_ETIMEOUT instead of
ARES_ECANCELLED.
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://c-ares.haxx.se/download/c-
ares-1.17.2.tar.gz.
Further information about this software can be found on the open source
community website at https://c-ares.haxx.se/.
AUTHOR
Dirk Manske
31 March 2004 ARES_CANCEL(3)