NS/main/source/curl/docs/libcurl/curl_multi_perform.html
Karl 8552ac617c Import from old repository
git-svn-id: https://unknownworlds.svn.cloudforge.com/ns1@1 67975925-1194-0748-b3d5-c16f83f1a3a1
2005-03-09 01:31:56 +00:00

74 lines
2.3 KiB
HTML

<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
curl_multi_perform - reads/writes available data from each
easy handle
</PRE>
<H2>SYNOPSIS</H2><PRE>
#include &lt;curl/curl.h&gt;
CURLMcode curl_multi_perform(CURLM *multi_handle, int
*running_handles);
</PRE>
<H2>DESCRIPTION</H2><PRE>
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 actu-
ally 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.
</PRE>
<H2>RETURN VALUE</H2><PRE>
CURLMcode type, general libcurl multi interface error
code.
If you receive <I>CURLM</I><B>_</B><I>CALL</I><B>_</B><I>MULTI</I><B>_</B><I>PERFORM</I>, this basicly
means that you should call <I>curl</I><B>_</B><I>multi</I><B>_</B><I>perform</I> 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".
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.
</PRE>
<H2>TYPICAL USAGE</H2><PRE>
Most application will use <I>curl</I><B>_</B><I>multi</I><B>_</B><I>fdset</I> 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, <I>curl</I><B>_</B><I>multi</I><B>_</B><I>perform</I> gets called.
</PRE>
<H2>SEE ALSO</H2><PRE>
<B>curl_multi_cleanup(3)</B>,<B>curl_multi_init(3)</B>
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>