|
|
|
|
.\"
|
|
|
|
|
.\" Copyright 1998 by the Massachusetts Institute of Technology.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Permission to use, copy, modify, and distribute this
|
|
|
|
|
.\" software and its documentation for any purpose and without
|
|
|
|
|
.\" fee is hereby granted, provided that the above copyright
|
|
|
|
|
.\" notice appear in all copies and that both that copyright
|
|
|
|
|
.\" notice and this permission notice appear in supporting
|
|
|
|
|
.\" documentation, and that the name of M.I.T. not be used in
|
|
|
|
|
.\" advertising or publicity pertaining to distribution of the
|
|
|
|
|
.\" software without specific, written prior permission.
|
|
|
|
|
.\" M.I.T. makes no representations about the suitability of
|
|
|
|
|
.\" this software for any purpose. It is provided "as is"
|
|
|
|
|
.\" without express or implied warranty.
|
|
|
|
|
.\"
|
|
|
|
|
.\" SPDX-License-Identifier: MIT
|
|
|
|
|
.\"
|
|
|
|
|
.TH ARES_FDS 3 "23 July 1998"
|
|
|
|
|
.SH NAME
|
|
|
|
|
ares_fds \- return file descriptors to select on
|
|
|
|
|
.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
|
|
|
int ares_fds(ares_channel_t *\fIchannel\fP,
|
|
|
|
|
fd_set *\fIread_fds\fP,
|
|
|
|
|
fd_set *\fIwrite_fds\fP)
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The \fBares_fds(3)\fP function retrieves the set of file descriptors which the
|
|
|
|
|
calling application should select on for reading and writing for the
|
|
|
|
|
processing of name service queries pending on the name service channel
|
|
|
|
|
identified by \fIchannel\fP.
|
|
|
|
|
|
|
|
|
|
File descriptors will be set in the file descriptor sets pointed to by
|
|
|
|
|
\fIread_fds\fP and \fIwrite_fds\fP as appropriate. File descriptors already
|
|
|
|
|
set in \fIread_fds\fP and \fIwrite_fds\fP will remain set; initialization of
|
|
|
|
|
the file descriptor sets (using \fBFD_ZERO\fP) is the responsibility of the
|
|
|
|
|
caller.
|
|
|
|
|
.SH RETURN VALUES
|
|
|
|
|
\fBares_fds(3)\fP returns a value that is one greater than the number of the
|
|
|
|
|
highest socket set in either \fIread_fds\fP or \fIwrite_fds\fP. If no queries
|
|
|
|
|
are active, \fBares_fds(3)\fP returns 0.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR ares_timeout (3),
|
|
|
|
|
.BR ares_process (3)
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Greg Hudson, MIT Information Systems
|
|
|
|
|
.br
|
|
|
|
|
Copyright 1998 by the Massachusetts Institute of Technology.
|
