|
|
|
.\"
|
|
|
|
.\" Copyright 1998 by the Massachusetts Institute of Technology.
|
|
|
|
.\" SPDX-License-Identifier: MIT
|
|
|
|
.\"
|
|
|
|
.TH ARES_PROCESS 3 "25 July 1998"
|
|
|
|
.SH NAME
|
|
|
|
ares_process_fd, ares_process \- Process events for name resolution
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
#include <ares.h>
|
|
|
|
|
|
|
|
void ares_process_fd(ares_channel_t *\fIchannel\fP,
|
|
|
|
ares_socket_t \fIread_fd\fP,
|
|
|
|
ares_socket_t \fIwrite_fd\fP)
|
|
|
|
|
`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_process(ares_channel_t *\fIchannel\fP,
|
|
|
|
fd_set *\fIread_fds\fP,
|
|
|
|
fd_set *\fIwrite_fds\fP)
|
|
|
|
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The \fBares_process_fd(3)\fP function handles input/output events and timeouts
|
|
|
|
associated with queries pending on the name service channel identified by
|
|
|
|
\fIchannel\fP. The file descriptor passed in \fIread_fd\fP and \fIwrite_fd\fP
|
|
|
|
indicate if the file descriptor has been notified of a read event or write
|
|
|
|
event, respectively. If a notification has not occurred, use
|
|
|
|
\fIARES_SOCKET_BAD\fP.
|
|
|
|
|
|
|
|
This function is typically used with the \fIARES_OPT_SOCK_STATE_CB\fP option.
|
|
|
|
|
|
|
|
\fBares_timeout(3)\fP should be used to retrieve the desired timeout, and when
|
|
|
|
the timeout expires, the integrator must call \fBares_process_fd(3)\fP with
|
|
|
|
both sockets set to \fIARES_SOCKET_BAD\fP. There is no need to do this if
|
|
|
|
events are also delivered for any file descriptors as timeout processing
|
|
|
|
will automatically be handled by any call to \fBares_process_fd(3)\fP.
|
|
|
|
|
|
|
|
The \fBares_process(3)\fP function works in the same manner, except it works
|
|
|
|
on \fIfd_sets\fP as is used by \fBselect(3)\fP and retrieved by
|
|
|
|
\fBares_fds(3)\fP. This method is deprecated and should not be used in modern
|
|
|
|
applications due to known limitations to the \fBselect(3)\fP implementation.
|
|
|
|
|
|
|
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR ares_fds (3),
|
|
|
|
.BR ares_timeout (3),
|
|
|
|
.BR ares_init_options (3)
|
|
|
|
with \fIARES_OPT_EVENT_THREAD\fP or \fIARES_OPT_SOCK_STATE_CB\fP
|