somewhat clarified that this only sets the fd_sets and expects them to be

cleared before this function is called
This commit is contained in:
Daniel Stenberg 2005-04-17 23:01:46 +00:00
parent 53280a196b
commit 7fba9ed398

View File

@ -1,6 +1,6 @@
.\" $Id$ .\" $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 .SH NAME
curl_multi_fdset - extracts file descriptor information from a multi handle curl_multi_fdset - extracts file descriptor information from a multi handle
.SH SYNOPSIS .SH SYNOPSIS
@ -15,15 +15,17 @@ CURLMcode curl_multi_fdset(CURLM *multi_handle,
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
This function extracts file descriptor information from a given multi_handle. This function extracts file descriptor information from a given multi_handle.
libcurl returns its fd_set sets. The application can use these to select() libcurl returns its fd_set sets. The application can use these to select() on,
on. The \fIcurl_multi_perform(3)\fP function should be called as soon as one but be sure to FD_ZERO them before calling this function as
of them are ready to be read from or written to. \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 You should also be aware that when doing select(), you should consider using a
rather small (single-digit number of seconds) timeout and call rather small (single-digit number of seconds) timeout and call
\fIcurl_multi_perform\fP regularly - even if no activity has been seen on the \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 fd_sets - as otherwise libcurl-internal retries and timeouts may not work as
you'd think. you'd think and want.
.SH RETURN VALUE .SH RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See CURLMcode type, general libcurl multi interface error code. See
\fIlibcurl-errors(3)\fP \fIlibcurl-errors(3)\fP