aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2014-11-25 11:48:38 +0100
committerDaniel Stenberg <daniel@haxx.se>2014-11-25 11:48:38 +0100
commit29aa9a37cc318faf0ee0bb7631e8d5896ebc3357 (patch)
tree6ee89ea01baaf26b5e6268040422868500bd965d /docs/libcurl
parentbc860548c29b94270228ae4f306796d9c1cb844b (diff)
curl_multi_wait.3: clarify numfds being used if not NULL
Diffstat (limited to 'docs/libcurl')
-rw-r--r--docs/libcurl/curl_multi_wait.310
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/libcurl/curl_multi_wait.3 b/docs/libcurl/curl_multi_wait.3
index 21ade930b..a76fba360 100644
--- a/docs/libcurl/curl_multi_wait.3
+++ b/docs/libcurl/curl_multi_wait.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2013, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -33,9 +33,9 @@ CURLMcode curl_multi_wait(CURLM *multi_handle,
int *numfds);
.ad
.SH DESCRIPTION
-This function polls on all file descriptors used by the curl easy handles
-contained in the given multi handle set. It will block until activity is
-detected on at least one of the handles or \fItimeout_ms\fP has passed.
+\fIcurl_multi_wait(3)\fP polls all file descriptors used by the curl easy
+handles contained in the given multi handle set. It will block until activity
+is detected on at least one of the handles or \fItimeout_ms\fP has passed.
Alternatively, if the multi handle has a pending internal timeout that has a
shorter expiry time than \fItimeout_ms\fP, that shorter time will be used
instead to make sure timeout accuracy is reasonably kept.
@@ -43,7 +43,7 @@ instead to make sure timeout accuracy is reasonably kept.
The calling application may pass additional curl_waitfd structures which are
similar to \fIpoll(2)\fP's pollfd structure to be waited on in the same call.
-On completion, if \fInumfds\fP is supplied, it will be populated with the
+On completion, if \fInumfds\fP is non-NULL, it will be populated with the
total number of file descriptors on which interesting events occured. This
number can include both libcurl internal descriptors as well as descriptors
provided in \fIextra_fds\fP.