Jay Satiro cb2ae6e8a8 curl_multi_socket_all.md: soften the deprecation warning

- Instead of saying "do not use", explain that the function was
  deprecated for performance reasons.

Some users may have a legitimate use of this function even though we
deprecated it. Since there are no plans to remove it from the API get
rid of the "do not use" warning.

Bug: https://curl.se/mail/lib-2024-11/0029.html
Reported-by: Jacob Champion

Closes https://github.com/curl/curl/pull/15576

2024-11-18 14:17:14 -05:00

1.5 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

curl_multi_socket_all

libcurl

curl_multi_cleanup (3)

curl_multi_fdset (3)

curl_multi_info_read (3)

curl_multi_init (3)

the hiperfifo.c example

All

7.15.4

NAME

curl_multi_socket_all - reads/writes available data for all easy handles

SYNOPSIS

#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

int main(void)
{
  int running;
  int rc;
  CURLM *multi;
  rc = curl_multi_socket_all(multi, &running);
}

%AVAILABILITY%

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.

1.5 KiB Raw Blame History