docs/libcurl/curl_multi_fdset.3

   1 .\"
   2 .TH curl_multi_fdset 3 "2 Jan 2006" "libcurl 7.16.0" "libcurl Manual"
   3 .SH NAME
   4 curl_multi_fdset - extracts file descriptor information from a multi handle
   5 .SH SYNOPSIS
   6 .nf
   7 #include <curl/curl.h>
   8
   9 CURLMcode curl_multi_fdset(CURLM *multi_handle,
  10                            fd_set *read_fd_set,
  11                            fd_set *write_fd_set,
  12                            fd_set *exc_fd_set,
  13                            int *max_fd);
  14 .ad
  15 .SH DESCRIPTION
  16 This function extracts file descriptor information from a given multi_handle.
  17 libcurl returns its fd_set sets. The application can use these to select() on,
  18 but be sure to FD_ZERO them before calling this function as
  19 \fIcurl_multi_fdset(3)\fP only adds its own descriptors, it doesn't zero or
  20 otherwise remove any others. The \fIcurl_multi_perform(3)\fP function should be
  21 called as soon as one of them is ready to be read from or written to.
  22
  23 To be sure to have up-to-date results, you should call
  24 \fIcurl_multi_perform\fP until it does not return CURLM_CALL_MULTI_PERFORM
  25 prior to calling \fIcurl_multi_fdset\fP.  This will make sure that libcurl has
  26 updated the handles' socket states.
  27
  28 If no file descriptors are set by libcurl, \fImax_fd\fP will contain -1 when
  29 this function returns. Otherwise it will contain the higher descriptor number
  30 libcurl set.
  31
  32 When doing select(), you should use \fBcurl_multi_timeout\fP to figure out how
  33 long to wait for action. Call \fIcurl_multi_perform\fP even if no activity has
  34 been seen on the fd_sets after the timeout expires as otherwise internal
  35 retries and timeouts may not work as you'd think and want.
  36 .SH RETURN VALUE
  37 CURLMcode type, general libcurl multi interface error code. See
  38 \fIlibcurl-errors(3)\fP
  39 .SH "SEE ALSO"
  40 .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
  41 .BR curl_multi_timeout "(3), " curl_multi_perform "(3) "