QRScanner/mobile/jni/thirdparty/curl/docs/libcurl/libcurl-multi.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 .\"
  23 .TH libcurl-multi 3 "3 Feb 2007" "libcurl 7.16.0" "libcurl multi interface"
  24 .SH NAME
  25 libcurl-multi \- how to use the multi interface
  26 .SH DESCRIPTION
  27 This is an overview on how to use the libcurl multi interface in your C
  28 programs. There are specific man pages for each function mentioned in
  29 here. There's also the \fIlibcurl-tutorial(3)\fP man page for a complete
  30 tutorial to programming with libcurl and the \fIlibcurl-easy(3)\fP man page
  31 for an overview of the libcurl easy interface.
  32
  33 All functions in the multi interface are prefixed with curl_multi.
  34 .SH "OBJECTIVES"
  35 The multi interface offers several abilities that the easy interface doesn't.
  36 They are mainly:
  37
  38 1. Enable a "pull" interface. The application that uses libcurl decides where
  39 and when to ask libcurl to get/send data.
  40
  41 2. Enable multiple simultaneous transfers in the same thread without making it
  42 complicated for the application.
  43
  44 3. Enable the application to wait for action on its own file descriptors and
  45 curl's file descriptors simultaneous easily.
  46 .SH "ONE MULTI HANDLE MANY EASY HANDLES"
  47 To use the multi interface, you must first create a 'multi handle' with
  48 \fIcurl_multi_init(3)\fP. This handle is then used as input to all further
  49 curl_multi_* functions.
  50
  51 Each single transfer is built up with an easy handle. You must create them,
  52 and setup the appropriate options for each easy handle, as outlined in the
  53 \fIlibcurl(3)\fP man page, using \fIcurl_easy_setopt(3)\fP.
  54
  55 When the easy handle is setup for a transfer, then instead of using
  56 \fIcurl_easy_perform(3)\fP (as when using the easy interface for transfers),
  57 you should instead add the easy handle to the multi handle using
  58 \fIcurl_multi_add_handle(3)\fP. The multi handle is sometimes referred to as a
  59 \'multi stack\' because of the fact that it may hold a large amount of easy
  60 handles.
  61
  62 Should you change your mind, the easy handle is again removed from the multi
  63 stack using \fIcurl_multi_remove_handle(3)\fP. Once removed from the multi
  64 handle, you can again use other easy interface functions like
  65 \fIcurl_easy_perform(3)\fP on the handle or whatever you think is necessary.
  66
  67 Adding the easy handle to the multi handle does not start the transfer.
  68 Remember that one of the main ideas with this interface is to let your
  69 application drive. You drive the transfers by invoking
  70 \fIcurl_multi_perform(3)\fP. libcurl will then transfer data if there is
  71 anything available to transfer. It'll use the callbacks and everything else
  72 you have setup in the individual easy handles. It'll transfer data on all
  73 current transfers in the multi stack that are ready to transfer anything. It
  74 may be all, it may be none.
  75
  76 Your application can acquire knowledge from libcurl when it would like to get
  77 invoked to transfer data, so that you don't have to busy-loop and call that
  78 \fIcurl_multi_perform(3)\fP like crazy. \fIcurl_multi_fdset(3)\fP offers an
  79 interface using which you can extract fd_sets from libcurl to use in select()
  80 or poll() calls in order to get to know when the transfers in the multi stack
  81 might need attention. This also makes it very easy for your program to wait
  82 for input on your own private file descriptors at the same time or perhaps
  83 timeout every now and then, should you want that.
  84
  85 \fIcurl_multi_perform(3)\fP stores the number of still running transfers in
  86 one of its input arguments, and by reading that you can figure out when all
  87 the transfers in the multi handles are done. 'done' does not mean
  88 successful. One or more of the transfers may have failed. Tracking when this
  89 number changes, you know when one or more transfers are done.
  90
  91 To get information about completed transfers, to figure out success or not and
  92 similar, \fIcurl_multi_info_read(3)\fP should be called. It can return a
  93 message about a current or previous transfer. Repeated invokes of the function
  94 get more messages until the message queue is empty. The information you
  95 receive there includes an easy handle pointer which you may use to identify
  96 which easy handle the information regards.
  97
  98 When a single transfer is completed, the easy handle is still left added to
  99 the multi stack. You need to first remove the easy handle with
 100 \fIcurl_multi_remove_handle(3)\fP and then close it with
 101 \fIcurl_easy_cleanup(3)\fP, or possibly set new options to it and add it again
 102 with \fIcurl_multi_add_handle(3)\fP to start another transfer.
 103
 104 When all transfers in the multi stack are done, cleanup the multi handle with
 105 \fIcurl_multi_cleanup(3)\fP. Be careful and please note that you \fBMUST\fP
 106 invoke separate \fIcurl_easy_cleanup(3)\fP calls on every single easy handle
 107 to clean them up properly.
 108
 109 If you want to re-use an easy handle that was added to the multi handle for
 110 transfer, you must first remove it from the multi stack and then re-add it
 111 again (possibly after having altered some options at your own choice).
 112 .SH "MULTI_SOCKET"
 113 \fIcurl_multi_socket_action(3)\fP function offers a way for applications to
 114 not only avoid being forced to use select(), but it also offers a much more
 115 high-performance API that will make a significant difference for applications
 116 using large numbers of simultaneous connections.
 117
 118 \fIcurl_multi_socket_action(3)\fP is then used instead of
 119 \fIcurl_multi_perform(3)\fP.
 120
 121 When using this API, you add easy handles to the multi handle just as with the
 122 normal multi interface. Then you also set two callbacks with the
 123 CURLMOPT_SOCKETFUNCTION and CURLMOPT_TIMERFUNCTION options to
 124 \fIcurl_multi_setopt(3)\fP.
 125
 126 The API is then designed to inform your application about which sockets
 127 libcurl is currently using and for what activities (read and/or write) on
 128 those sockets your application is expected to wait for.
 129
 130 Your application must then make sure to receive all sockets informed about in
 131 the CURLMOPT_SOCKETFUNCTION callback and make sure it reacts on the given
 132 activity on them. When a socket has the given activity, you call
 133 \fIcurl_multi_socket_action(3)\fP specifying which socket and action there
 134 are.
 135
 136 The CURLMOPT_TIMERFUNCTION callback is called to set a timeout. When that
 137 timeout expires, your application should call the
 138 \fIcurl_multi_socket_action(3)\fP function saying it was due to a timeout.
 139 .SH "BLOCKING"
 140 A few areas in the code are still using blocking code, even when used from the
 141 multi interface. While we certainly want and intend for these to get fixed in
 142 the future, you should be aware of the following current restrictions:
 143
 144 .nf
 145  - Name resolves unless the c-ares or threaded-resolver backends are used
 146  - NSS SSL connections
 147  - HTTP proxy CONNECT operations
 148  - SOCKS proxy handshakes
 149  - file:// transfers
 150  - TELNET transfers
 151 .fi