neo/curl/docs/libcurl/libcurl-multi.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\" $Id: libcurl-multi.3,v 1.8 2004/03/15 11:37:38 bagder Exp $
   4 .\"
   5 .TH libcurl-multi 3 "13 Oct 2001" "libcurl 7.10.1" "libcurl multi interface"
   6 .SH NAME
   7 libcurl-multi \- how to use the multi interface
   8 .SH DESCRIPTION
   9 This is an overview on how to use the libcurl multi interface in your C
  10 programs. There are specific man pages for each function mentioned in
  11 here. There's also the libcurl-the-guide document for a complete tutorial to
  12 programming with libcurl and the \fIlibcurl(3)\fP man page for an overview of
  13 the libcurl easy interface.
  14
  15 All functions in the multi interface are prefixed with curl_multi.
  16 .SH "PLEASE NOTICE"
  17 The multi interface is a rather new member of the libcurl family. It has not
  18 yet been very widely used. It may still be a few more bugs lurking in there
  19 than we are used to. That said, it might also just work in every aspect you
  20 try it. Please report all bugs and oddities you see.
  21 .SH "OBJECTIVES"
  22 The multi interface introduces several new abilities that the easy interface
  23 refuses to offer. They are mainly:
  24
  25 1. Enable a "pull" interface. The application that uses libcurl decides where
  26 and when to ask libcurl to get/send data.
  27
  28 2. Enable multiple simultaneous transfers in the same thread without making it
  29 complicated for the application.
  30
  31 3. Enable the application to select() on its own file descriptors and curl's
  32 file descriptors simultaneous easily.
  33 .SH "ONE MULTI HANDLE MANY EASY HANDLES"
  34 To use the multi interface, you must first create a 'multi handle' with
  35 \fIcurl_multi_init(3)\fP. This handle is then used as input to all further
  36 curl_multi_* functions.
  37
  38 Each single transfer is built up with an easy handle. You must create them,
  39 and setup the appropriate options for each easy handle, as outlined in the
  40 \fIlibcurl(3)\fP man page, using \fIcurl_easy_setopt(3)\fP.
  41
  42 When the easy handle is setup for a transfer, then instead of using
  43 \fIcurl_easy_perform(3)\fP (as when using the easy interface for transfers),
  44 you should instead add the easy handle to the multi handle using
  45 \fIcurl_multi_add_handle(3)\fP. The multi handle is sometimes referred to as a
  46 \'multi stack\' because of the fact that it may hold a large amount of easy
  47 handles.
  48
  49 Should you change your mind, the easy handle is again removed from the multi
  50 stack using \fIcurl_multi_remove_handle(3)\fP. Once removed from the multi
  51 handle, you can again use other easy interface functions like
  52 \fIcurl_easy_perform(3)\fP on the handle or whatever you think is necessary.
  53
  54 Adding the easy handle to the multi handle does not start the transfer.
  55 Remember that one of the main ideas with this interface is to let your
  56 application drive. You drive the transfers by invoking
  57 \fIcurl_multi_perform(3)\fP. libcurl will then transfer data if there is
  58 anything available to transfer. It'll use the callbacks and everything else
  59 you have setup in the individual easy handles. It'll transfer data on all
  60 current transfers in the multi stack that are ready to transfer anything. It
  61 may be all, it may be none.
  62
  63 Your application can acquire knowledge from libcurl when it would like to get
  64 invoked to transfer data, so that you don't have to busy-loop and call that
  65 \fIcurl_multi_perform(3)\fP like crazy. \fIcurl_multi_fdset(3)\fP offers an
  66 interface using which you can extract fd_sets from libcurl to use in select()
  67 or poll() calls in order to get to know when the transfers in the multi stack
  68 might need attention. This also makes it very easy for your program to wait
  69 for input on your own private file descriptors at the same time or perhaps
  70 timeout every now and then, should you want that.
  71
  72 A little note here about the return codes from the multi functions, and
  73 especially the \fIcurl_multi_perform(3)\fP: if you receive
  74 \fICURLM_CALL_MULTI_PERFORM\fP, this basicly means that you should call
  75 \fIcurl_multi_perform(3)\fP again, before you select() on more actions. You
  76 don't have to do it immediately, but the return code means that libcurl may
  77 have more data available to return or that there may be more data to send off
  78 before it is "satisfied".
  79
  80 \fIcurl_multi_perform(3)\fP stores the number of still running transfers in
  81 one of its input arguments, and by reading that you can figure out when all
  82 the transfers in the multi handles are done. 'done' does not mean
  83 successful. One or more of the transfers may have failed. Tracking when this
  84 number changes, you know when one or more transfers are done.
  85
  86 To get information about completed transfers, to figure out success or not and
  87 similar, \fIcurl_multi_info_read(3)\fP should be called. It can return a
  88 message about a current or previous transfer. Repeated invokes of the function
  89 get more messages until the message queue is empty. The information you
  90 receive there includes an easy handle pointer which you may use to identify
  91 which easy handle the information regards.
  92
  93 When all transfers in the multi stack are done, cleanup the multi handle with
  94 \fIcurl_multi_cleanup(3)\fP. Be careful and please note that you \fBMUST\fP
  95 invoke separate \fIcurl_easy_cleanup(3)\fP calls on every single easy handle
  96 to clean them up properly.
  97
  98 If you want to re-use an easy handle that was added to the multi handle for
  99 transfer, you must first remove it from the multi stack and then re-add it
 100 again (possbily after having altered some options at your own choice).