AP05/curl_arm64/share/man/man3/curl_multi_socket_all.3
2025-12-02 13:06:35 +08:00

52 lines
1.6 KiB
Groff

.\" generated by cd2nroff 0.1 from curl_multi_socket_all.md
.TH curl_multi_socket_all 3 "2025-07-07" libcurl
.SH NAME
curl_multi_socket_all \- reads/writes available data for all easy handles
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLMcode curl_multi_socket_all(CURLM *multi_handle,
int *running_handles);
.fi
.SH DESCRIPTION
This function is deprecated for performance reasons but there are no plans to
remove it from the API. Use \fIcurl_multi_socket_action(3)\fP instead.
At return, the integer \fBrunning_handles\fP points to contains the number of
still running easy handles within the multi handle. When this number reaches
zero, all transfers are complete/done.
Force libcurl to (re\-)check all its internal sockets and transfers instead of
just a single one by calling \fIcurl_multi_socket_all(3)\fP. Note that there should
not be any reason to use this function.
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
{
int running;
int rc;
CURLM *multi = curl_multi_init();
rc = curl_multi_socket_all(multi, &running);
}
.fi
.SH AVAILABILITY
Added in curl 7.15.4
.SH RETURN VALUE
This function returns a CURLMcode indicating success or error.
CURLM_OK (0) means everything was OK, non\-zero means an error occurred, see
\fIlibcurl\-errors(3)\fP.
The return code is for the whole multi stack. Problems still might have
occurred on individual transfers even when one of these functions return OK.
.SH SEE ALSO
.BR curl_multi_cleanup (3),
.BR curl_multi_fdset (3),
.BR curl_multi_info_read (3),
.BR curl_multi_init (3),
.BR the hiperfifo.c example