Blame ares_fds.3

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