29789ae312
- use imperative form - use lowercase - no period - unify some phrases - fix curl_multi_socket and curl_multi_socket_all to keep their own descriptions Closes #14062
68 lines
1.5 KiB
Markdown
68 lines
1.5 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_multi_socket
|
|
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
|
|
---
|
|
|
|
# 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. Do not use. See 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.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
int running;
|
|
int rc;
|
|
CURLM *multi;
|
|
rc = curl_multi_socket_all(multi, &running);
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0.
|
|
|
|
curl_multi_socket_all(3) is deprecated, use
|
|
curl_multi_socket_action(3) instead!
|
|
|
|
# RETURN VALUE
|
|
|
|
CURLMcode type, general libcurl multi interface error code.
|
|
|
|
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.
|