summaryrefslogtreecommitdiff
path: root/ares_process.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2003-10-07 21:54:04 +0000
committerDaniel Stenberg <daniel@haxx.se>2003-10-07 21:54:04 +0000
commit5e847a14bd65383ce65f143c578e120899981fd9 (patch)
tree0072e647fe22e05aee94cf4e4bf101209e30626c /ares_process.3
downloadc-ares-5e847a14bd65383ce65f143c578e120899981fd9.tar.gz
c-ares-5e847a14bd65383ce65f143c578e120899981fd9.tar.bz2
c-ares-5e847a14bd65383ce65f143c578e120899981fd9.zip
ares 1.1.1 with collected applied patches
Diffstat (limited to 'ares_process.3')
-rw-r--r--ares_process.379
1 files changed, 79 insertions, 0 deletions
diff --git a/ares_process.3 b/ares_process.3
new file mode 100644
index 0000000..a707a41
--- /dev/null
+++ b/ares_process.3
@@ -0,0 +1,79 @@
+.\" $Id$
+.\"
+.\" 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
+.SH DESCRIPTION
+The
+.B ares_process
+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
+.I read_fds
+and
+.I write_fds
+should have file descriptors set in them according to whether the file
+descriptors specified by
+.BR ares_fds (3)
+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
+.BR ares_timeout (3)).
+.PP
+The
+.B ares_process
+function will invoke callbacks for pending queries if they complete
+successfully or fail.
+.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.