jpayne@68: .\"
jpayne@68: .\" Copyright 1998 by the Massachusetts Institute of Technology.
jpayne@68: .\" SPDX-License-Identifier: MIT
jpayne@68: .\"
jpayne@68: .TH ARES_CANCEL 3 "31 March 2004"
jpayne@68: .SH NAME
jpayne@68: ares_cancel \- Cancel a resolve
jpayne@68: .SH SYNOPSIS
jpayne@68: .nf
jpayne@68: #include <ares.h>
jpayne@68: 
jpayne@68: void ares_cancel(ares_channel_t *\fIchannel\fP)
jpayne@68: .fi
jpayne@68: .SH DESCRIPTION
jpayne@68: The \fBares_cancel(3)\fP function cancels all lookups/requests made on the the
jpayne@68: name service channel identified by \fIchannel\fP.  \fBares_cancel(3)\fP
jpayne@68: invokes the callbacks for each pending query on the channel, passing a status
jpayne@68: of
jpayne@68: .BR ARES_ECANCELLED .
jpayne@68: These calls give the callbacks a chance to clean up any state which might have
jpayne@68: been stored in their arguments. If such a callback invocation adds a new
jpayne@68: request to the channel, that request will \fInot\fP be cancelled by the
jpayne@68: current invocation of \fBares_cancel(3)\fP.
jpayne@68: .SH SEE ALSO
jpayne@68: .BR ares_init (3)
jpayne@68: .BR ares_destroy (3)
jpayne@68: .SH NOTES
jpayne@68: This function was added in c-ares 1.2.0
jpayne@68: 
jpayne@68: c-ares 1.6.0 and earlier pass a status of
jpayne@68: .BR ARES_ETIMEOUT
jpayne@68: instead of
jpayne@68: .BR ARES_ECANCELLED .