QRScanner/mobile/jni/thirdparty/curl/docs/libcurl/curl_multi_fdset.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .TH curl_multi_fdset 3 "2 Jan 2006" "libcurl 7.16.0" "libcurl Manual"
  23 .SH NAME
  24 curl_multi_fdset - extracts file descriptor information from a multi handle
  25 .SH SYNOPSIS
  26 .nf
  27 #include <curl/curl.h>
  28
  29 CURLMcode curl_multi_fdset(CURLM *multi_handle,
  30                            fd_set *read_fd_set,
  31                            fd_set *write_fd_set,
  32                            fd_set *exc_fd_set,
  33                            int *max_fd);
  34 .ad
  35 .SH DESCRIPTION
  36 This function extracts file descriptor information from a given multi_handle.
  37 libcurl returns its fd_set sets. The application can use these to select() on,
  38 but be sure to FD_ZERO them before calling this function as
  39 \fIcurl_multi_fdset(3)\fP only adds its own descriptors, it doesn't zero or
  40 otherwise remove any others. The \fIcurl_multi_perform(3)\fP function should be
  41 called as soon as one of them is ready to be read from or written to.
  42
  43 If no file descriptors are set by libcurl, \fImax_fd\fP will contain -1 when
  44 this function returns. Otherwise it will contain the higher descriptor number
  45 libcurl set. When libcurl returns -1 in \fImax_fd\fP, it is because libcurl
  46 currently does something that isn't possible for your application to monitor
  47 with a socket and unfortunately you can then not know exactly when the current
  48 action is completed using select(). When max_fd returns with -1, you need to
  49 wait a while and then proceed and call \fIcurl_multi_perform\fP anyway. How
  50 long to wait? I would suggest 100 milliseconds at least, but you may want to
  51 test it out in your own particular conditions to find a suitable value.
  52
  53 When doing select(), you should use \fBcurl_multi_timeout\fP to figure out how
  54 long to wait for action. Call \fIcurl_multi_perform\fP even if no activity has
  55 been seen on the fd_sets after the timeout expires as otherwise internal
  56 retries and timeouts may not work as you'd think and want.
  57
  58 If one of the sockets used by libcurl happens to be larger than what can be
  59 set in an fd_set, which on POSIX systems means that the file descriptor is
  60 larger than FD_SETSIZE, then libcurl will try to not set it. Setting a too
  61 large file descriptor in an fd_set implies an out of bounds write which can
  62 cause crashes, or worse. The effect of NOT storing it will possibly save you
  63 from the crash, but will make your program NOT wait for sockets it should wait
  64 for...
  65 .SH RETURN VALUE
  66 CURLMcode type, general libcurl multi interface error code. See
  67 \fIlibcurl-errors(3)\fP
  68 .SH "SEE ALSO"
  69 .BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
  70 .BR curl_multi_timeout "(3), " curl_multi_perform "(3) "