From ca118e9f6945bcf224318be15b24ca97992d0208 Mon Sep 17 00:00:00 2001 From: Brad House Date: Thu, 8 Feb 2018 19:05:40 -0500 Subject: [PATCH] document handling of timeouts for ares_process and ares_process_fd to close PR #57 --- ares_process.3 | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/ares_process.3 b/ares_process.3 index 62836ad2..caabbf13 100644 --- a/ares_process.3 +++ b/ares_process.3 @@ -45,6 +45,11 @@ if they complete successfully or fail. specific file descriptors (sockets) you pass in to the function. Use ARES_SOCKET_BAD for "no action". This function is provided to allow users of c-ares to void \fIselect(3)\fP in their applications and within c-ares. + +To only process possible timeout conditions without a socket event occurring, +one may pass NULL as the values for both \fIread_fds\fP and \fIwrite_fds\fP for +\fBares_process(3)\fP, or ARES_SOCKET_BAD for both \fIread_fd\fP and +\fIwrite_fd\fP for \fBares_process_fd(3)\fP. .SH EXAMPLE The following code fragment waits for all pending queries on a channel to complete: