diff options
author | Jakub Hrozek <jhrozek@redhat.com> | 2010-01-28 20:04:19 +0100 |
---|---|---|
committer | Jakub Hrozek <jhrozek@redhat.com> | 2010-01-28 20:04:19 +0100 |
commit | 03ff51230ea260b3aab05fe07c0c7f66c94b176c (patch) | |
tree | 504b6929a32c518712b9da03f3e02d0a7536957e /ares_process.3 | |
download | c-ares-03ff51230ea260b3aab05fe07c0c7f66c94b176c.tar.gz c-ares-03ff51230ea260b3aab05fe07c0c7f66c94b176c.tar.xz c-ares-03ff51230ea260b3aab05fe07c0c7f66c94b176c.zip |
Initial import
Diffstat (limited to 'ares_process.3')
-rw-r--r-- | ares_process.3 | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/ares_process.3 b/ares_process.3 new file mode 100644 index 0000000..fa46852 --- /dev/null +++ b/ares_process.3 @@ -0,0 +1,81 @@ +.\" $Id: ares_process.3,v 1.3 2007-05-30 12:58:47 bagder Exp $ +.\" +.\" 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. +.\" +.TH ARES_PROCESS 3 "25 July 1998" +.SH NAME +ares_process \- Process events for name resolution +.SH SYNOPSIS +.nf +.B #include <ares.h> +.PP +.B void ares_process(ares_channel \fIchannel\fP, fd_set *\fIread_fds\fP, +.B fd_set *\fIwrite_fds\fP) +.fi +.PP +.B void ares_process_fd(ares_channel \fIchannel\fP, +.B ares_socket_t \fIread_fd\fP, +.B ares_socket_t \fIwrite_fd\fP) +.fi +.SH DESCRIPTION +The \fBares_process(3)\fP function handles input/output events and timeouts +associated with queries pending on the name service channel identified by +.IR channel . +The file descriptor sets pointed to by \fIread_fds\fP and \fIwrite_fds\fP +should have file descriptors set in them according to whether the file +descriptors specified by \fIares_fds(3)\fP are ready for reading and writing. +(The easiest way to determine this information is to invoke +.B select +with a timeout no greater than the timeout given by \fIares_timeout(3)\fP ). +.PP +The +.B ares_process +function will invoke callbacks for pending queries if they complete +successfully or fail. + +\fBares_process_fd(3)\fP works the same way but acts and operates only on the +specific file descriptors (sockets) you pass in to the function. Use +ARES_SOCKET_BAD for "no action". This function is of course provided to allow +users of c-ares to void select() in their applications and within c-ares. +.SS EXAMPLE +The following code fragment waits for all pending queries on a channel +to complete: +.PP +.RS +.nf +int nfds, count; +fd_set readers, writers; +struct timeval tv, *tvp; + +while (1) + { + FD_ZERO(&readers); + FD_ZERO(&writers); + nfds = ares_fds(channel, &readers, &writers); + if (nfds == 0) + break; + tvp = ares_timeout(channel, NULL, &tv); + count = select(nfds, &readers, &writers, NULL, tvp); + ares_process(channel, &readers, &writers); + } +.fi +.RE +.SH SEE ALSO +.BR ares_fds (3), +.BR ares_timeout (3) +.SH AUTHOR +Greg Hudson, MIT Information Systems +.br +Copyright 1998 by the Massachusetts Institute of Technology. |