summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSara Golemon <sgolemon@fb.com>2012-09-15 10:38:52 -0700
committerDaniel Stenberg <daniel@haxx.se>2012-09-16 19:58:02 +0200
commitb78944146a0670b74be00e189f468adfc5fca5b7 (patch)
tree5e466784b19e166a1600ec934df0c3e2643da4e6 /docs
parent9b25b00fa3c0d57c9356fbdcec9883a3cdd16c93 (diff)
downloadcurl-b78944146a0670b74be00e189f468adfc5fca5b7.tar.gz
curl_multi_wait: Add parameter to return number of active sockets
Minor change to recently introduced function. BC breaking, but since curl_multi_wait() doesn't exist in any releases that should be fine.
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/curl_multi_wait.36
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/libcurl/curl_multi_wait.3 b/docs/libcurl/curl_multi_wait.3
index 96b3c7e66..9250a77eb 100644
--- a/docs/libcurl/curl_multi_wait.3
+++ b/docs/libcurl/curl_multi_wait.3
@@ -29,7 +29,8 @@ curl_multi_select - polls on all easy handles in a multi handle
CURLMcode curl_multi_wait(CURLM *multi_handle,
struct curl_waitfd extra_fds[],
unsigned int extra_nfds,
- int timeout_ms);
+ int timeout_ms,
+ int *ret);
.ad
.SH DESCRIPTION
This function polls on all file descriptors used by the curl easy handles
@@ -39,6 +40,9 @@ detected on at least one of the handles or \fItimeout_ms\fP has passed.
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 \fIret\fI is supplied, it will be populated with the
+number of file descriptors on which interesting events occured.
+
This function is encouraged to be used instead of select(3) when using the
multi interface to allow applications to easier circumvent the common problem
with 1024 maximum file descriptors.