|
|
|
|
.\"
|
|
|
|
|
.\" Copyright 1998 by the Massachusetts Institute of Technology.
|
|
|
|
|
.\" SPDX-License-Identifier: MIT
|
|
|
|
|
.\"
|
|
|
|
|
.TH ARES_CANCEL 3 "31 March 2004"
|
|
|
|
|
.SH NAME
|
|
|
|
|
ares_cancel \- Cancel a resolve
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <ares.h>
|
|
|
|
|
|
`ares_channel` -> `ares_channel_t *`: don't bury the pointer (#595)
`ares_channel` is defined as `typedef struct ares_channeldata *ares_channel;`. The problem with this, is it embeds the pointer into the typedef, which means an `ares_channel` can never be declared as `const` as if you write `const ares_channel channel`, that expands to `struct ares_channeldata * const ares_channel` and not `const struct ares_channeldata *channel`.
We will now typedef `ares_channel_t` as `typedef struct ares_channeldata ares_channel_t;`, so if you write `const ares_channel_t *channel`, it properly expands to `const struct ares_channeldata *channel`.
We are maintaining the old typedef for API compatibility with existing integrations, and due to typedef expansion this should not even cause any compiler warnings for existing code. There are no ABI implications with this change. I could be convinced to keep existing public functions as `ares_channel` if a sufficient argument exists, but internally we really need make this change for modern best practices.
This change will allow us to internally use `const ares_channel_t *` where appropriate. Whether or not we decide to change any public interfaces to use `const` may require further discussion on if there might be ABI implications (I don't think so, but I'm also not 100% sure what a compiler internally does with `const` when emitting machine code ... I think more likely ABI implications would occur going the opposite direction).
FYI, This PR was done via a combination of sed and clang-format, the only manual code change was the addition of the new typedef, and a couple doc fixes :)
Fix By: Brad House (@bradh352)
1 year ago
|
|
|
void ares_cancel(ares_channel_t *\fIchannel\fP)
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The \fBares_cancel(3)\fP function cancels all lookups/requests made on the the
|
|
|
|
|
name service channel identified by \fIchannel\fP. \fBares_cancel(3)\fP
|
|
|
|
|
invokes the callbacks for each pending query on the channel, passing a status
|
|
|
|
|
of
|
|
|
|
|
.BR 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 \fInot\fP be cancelled by the
|
|
|
|
|
current invocation of \fBares_cancel(3)\fP.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR ares_init (3)
|
|
|
|
|
.BR ares_destroy (3)
|
|
|
|
|
.SH NOTES
|
|
|
|
|
This function was added in c-ares 1.2.0
|
|
|
|
|
|
|
|
|
|
c-ares 1.6.0 and earlier pass a status of
|
|
|
|
|
.BR ARES_ETIMEOUT
|
|
|
|
|
instead of
|
|
|
|
|
.BR ARES_ECANCELLED .
|
