2002-03-04 05:09:48 -05:00
|
|
|
.\" $Id$
|
|
|
|
|
.\"
|
|
|
|
|
.TH curl_multi_perform 3 "1 March 2002" "libcurl 7.9.5" "libcurl Manual"
|
|
|
|
|
.SH NAME
|
2002-10-15 04:39:30 -04:00
|
|
|
curl_multi_perform - reads/writes available data from each easy handle
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLMcode curl_multi_perform(CURLM *multi_handle, int *running_handles);
|
|
|
|
|
.ad
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
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.
|
2004-10-03 13:38:57 -04:00
|
|
|
|
|
|
|
|
When you call curl_multi_perform() and the amount of \fIrunning_handles\fP is
|
|
|
|
|
changed from the previous call (or is less than the amount of easy handles
|
|
|
|
|
you've added to the multi handle), you know that there is one or more
|
|
|
|
|
transfers less "running". You can then call \fIcurl_multi_info_read(3)\fP to
|
|
|
|
|
get information about each individual completed transfer, and that returned
|
|
|
|
|
info includes CURLcode and more.
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH "RETURN VALUE"
|
|
|
|
|
CURLMcode type, general libcurl multi interface error code.
|
|
|
|
|
|
2004-03-24 16:40:45 -05:00
|
|
|
If you receive \fICURLM_CALL_MULTI_PERFORM\fP, this basically means that you
|
2002-12-03 07:40:12 -05:00
|
|
|
should call \fIcurl_multi_perform\fP 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".
|
|
|
|
|
|
2002-03-04 05:09:48 -05:00
|
|
|
NOTE that this only returns errors etc regarding the whole multi stack. There
|
2004-03-24 16:40:45 -05:00
|
|
|
might still have occurred problems on individual transfers even when this
|
2002-03-04 05:09:48 -05:00
|
|
|
function returns OK.
|
|
|
|
|
.SH "TYPICAL USAGE"
|
2004-03-15 06:37:37 -05:00
|
|
|
Most application will use \fIcurl_multi_fdset(3)\fP to get the multi_handle's
|
2002-03-04 05:09:48 -05:00
|
|
|
file descriptors, then it'll wait for action on them using select() and as
|
2004-03-15 06:37:37 -05:00
|
|
|
soon as one or more of them are ready, \fIcurl_multi_perform(3)\fP gets
|
|
|
|
|
called.
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH "SEE ALSO"
|
2004-10-03 13:38:57 -04:00
|
|
|
.BR curl_multi_cleanup "(3), " curl_multi_init "(3), "
|
|
|
|
|
.BR curl_multi_fdset "(3), " curl_multi_info_read "(3)"
|
