mingw/share/man/man3/libcurl-multi.3

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