curl/docs/libcurl/curl_multi_socket_all.md
Daniel Stenberg 4501b7e28d
docs/libcurl: return value overhall
Unified, extended, clarified the return values for numerous functions

Closes #15899
2025-01-02 16:58:05 +01:00

69 lines
1.6 KiB
Markdown

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: curl_multi_socket_all
Section: 3
Source: libcurl
See-also:
- curl_multi_cleanup (3)
- curl_multi_fdset (3)
- curl_multi_info_read (3)
- curl_multi_init (3)
- the hiperfifo.c example
Protocol:
- All
Added-in: 7.15.4
---
# NAME
curl_multi_socket_all - reads/writes available data for all easy handles
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLMcode curl_multi_socket_all(CURLM *multi_handle,
int *running_handles);
~~~
# DESCRIPTION
This function is deprecated for performance reasons but there are no plans to
remove it from the API. Use curl_multi_socket_action(3) instead.
At return, the integer **running_handles** 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 curl_multi_socket_all(3). Note that there should
not be any reason to use this function.
# %PROTOCOLS%
# EXAMPLE
~~~c
int main(void)
{
int running;
int rc;
CURLM *multi;
rc = curl_multi_socket_all(multi, &running);
}
~~~
# %AVAILABILITY%
# 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
libcurl-errors(3).
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.