aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2005-04-17 23:01:46 +0000
committerDaniel Stenberg <daniel@haxx.se>2005-04-17 23:01:46 +0000
commit7fba9ed398ab0b7eb98d70af03fbe6f2e26c02d9 (patch)
treeacc4622f624119b17b5c3e88520c156debd500f0
parent53280a196bd1edc124699d0a17343b18fc566f49 (diff)
somewhat clarified that this only sets the fd_sets and expects them to be
cleared before this function is called
-rw-r--r--docs/libcurl/curl_multi_fdset.312
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/libcurl/curl_multi_fdset.3 b/docs/libcurl/curl_multi_fdset.3
index e7e84fc3c..222c2f2d8 100644
--- a/docs/libcurl/curl_multi_fdset.3
+++ b/docs/libcurl/curl_multi_fdset.3
@@ -1,6 +1,6 @@
.\" $Id$
.\"
-.TH curl_multi_fdset 3 "15 Apr 2004" "libcurl 7.9.5" "libcurl Manual"
+.TH curl_multi_fdset 3 "18 Apr 2005" "libcurl 7.9.5" "libcurl Manual"
.SH NAME
curl_multi_fdset - extracts file descriptor information from a multi handle
.SH SYNOPSIS
@@ -15,15 +15,17 @@ CURLMcode curl_multi_fdset(CURLM *multi_handle,
.ad
.SH DESCRIPTION
This function extracts file descriptor information from a given multi_handle.
-libcurl returns its fd_set sets. The application can use these to select()
-on. The \fIcurl_multi_perform(3)\fP function should be called as soon as one
-of them are ready to be read from or written to.
+libcurl returns its fd_set sets. The application can use these to select() on,
+but be sure to FD_ZERO them before calling this function as
+\fIcurl_multi_fdset(3)\fP only adds its own descriptors it doesn't zero or
+otherwise remove any other. The \fIcurl_multi_perform(3)\fP function should be
+called as soon as one of them are ready to be read from or written to.
You should also be aware that when doing select(), you should consider using a
rather small (single-digit number of seconds) timeout and call
\fIcurl_multi_perform\fP regularly - even if no activity has been seen on the
fd_sets - as otherwise libcurl-internal retries and timeouts may not work as
-you'd think.
+you'd think and want.
.SH RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See
\fIlibcurl-errors(3)\fP