luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

curl_multi_socket_all.md: soften the deprecation warning

Browse Source 
- 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
This commit is contained in:
Jay Satiro 2024-11-13 16:17:37 -05:00
parent dada880fc5
commit cb2ae6e8a8
2 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/libcurl/curl_multi_socket.md
View File

@ -29,8 +29,8 @@ CURLMcode curl_multi_socket(CURLM *multi_handle, curl_socket_t sockfd,
# DESCRIPTION # DESCRIPTION
This function is deprecated. Do not use. See curl_multi_socket_action(3) This function is deprecated. Use curl_multi_socket_action(3) instead with
instead. **ev_bitmask** set to 0.
At return, the integer **running_handles** points to contains the number of At return, the integer **running_handles** points to contains the number of
still running easy handles within the multi handle. When this number reaches still running easy handles within the multi handle. When this number reaches
@ -54,9 +54,6 @@ to CURL_SOCKET_TIMEOUT. You can also use the curl_multi_timeout(3) function to
poll the value at any given time, but for an event-based system using the poll the value at any given time, but for an event-based system using the
callback is far better than relying on polling the timeout value. callback is far better than relying on polling the timeout value.
Usage of curl_multi_socket(3) is deprecated, whereas the function is
equivalent to curl_multi_socket_action(3) with **ev_bitmask** set to 0.
# %PROTOCOLS% # %PROTOCOLS%
# EXAMPLE # EXAMPLE

4
docs/libcurl/curl_multi_socket_all.md
View File

@ -30,8 +30,8 @@ CURLMcode curl_multi_socket_all(CURLM *multi_handle,
# DESCRIPTION # DESCRIPTION
This function is deprecated. Do not use. See curl_multi_socket_action(3) This function is deprecated for performance reasons but there are no plans to
instead. remove it from the API. Use curl_multi_socket_action(3) instead.
At return, the integer **running_handles** points to contains the number of At return, the integer **running_handles** points to contains the number of
still running easy handles within the multi handle. When this number reaches still running easy handles within the multi handle. When this number reaches