neo/curl/docs/libcurl/curl_multi_perform.html

   1 <html><head>
   2 <title>curl_multi_perform man page</title>
   3 <meta name="generator" content="roffit 0.5">
   4 <STYLE type="text/css">
   5 P.level0 {
   6  padding-left: 2em;
   7 }
   8
   9 P.level1 {
  10  padding-left: 4em;
  11 }
  12
  13 P.level2 {
  14  padding-left: 6em;
  15 }
  16
  17 span.emphasis {
  18  font-style: italic;
  19 }
  20
  21 span.bold {
  22  font-weight: bold;
  23 }
  24
  25 span.manpage {
  26  font-weight: bold;
  27 }
  28
  29 h2.nroffsh {
  30  background-color: #e0e0e0;
  31 }
  32
  33 span.nroffip {
  34  font-weight: bold;
  35  font-size: 120%;
  36  font-family: monospace;
  37 }
  38
  39 p.roffit {
  40  text-align: center;
  41  font-size: 80%;
  42 }
  43 </STYLE>
  44 </head><body>
  45
  46 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  47 <p class="level0">curl_multi_perform - reads/writes available data from each easy handle <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  48 <p class="level0">#include &lt;curl/curl.h&gt;
  49 <p class="level0">CURLMcode curl_multi_perform(CURLM *multi_handle, int *running_handles);
  50 <p class="level0"><a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  51 <p class="level0">When the app thinks there's data available for the multi_handle, it should call this function to read/write whatever there is to read or write right now. curl_multi_perform() returns as soon as the reads/writes are done. This function does not require that there actually is any data available for reading or that data can be written, it can be called just in case. It will write the number of handles that still transfer data in the second argument's integer-pointer. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  52 <p class="level0">CURLMcode type, general libcurl multi interface error code.
  53 <p class="level0">If you receive <span Class="emphasis">CURLM_CALL_MULTI_PERFORM</span>, this basicly means that you should call <span Class="emphasis">curl_multi_perform</span> again, before you select() on more actions. You don't have to do it immediately, but the return code means that libcurl may have more data available to return or that there may be more data to send off before it is "satisfied".
  54 <p class="level0">NOTE that this only returns errors etc regarding the whole multi stack. There might still have occurred problems on invidual transfers even when this function returns OK. <a name="TYPICAL"></a><h2 class="nroffsh">TYPICAL USAGE</h2>
  55 <p class="level0">Most application will use <a class="emphasis" href="./curl_multi_fdset.html">curl_multi_fdset(3)</a> to get the multi_handle's file descriptors, then it'll wait for action on them using select() and as soon as one or more of them are ready, <a class="emphasis" href="./curl_multi_perform.html">curl_multi_perform(3)</a> gets called. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  56 <p class="level0"><a class="manpage" href="./curl_multi_cleanup.html">curl_multi_cleanup (3)</a> <a class="manpage" href="./curl_multi_init.html"> curl_multi_init (3)</a> <a class="manpage" href="./curl_multi_fdset.html"> curl_multi_fdset (3)</a> <p class="roffit">
  57  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  58 </body></html>