romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-08-25 14:13:34 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs/libcurl: polish the single-line descriptions

Browse source 
- 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
This commit is contained in:
Daniel Stenberg 2024-06-30 00:08:06 +02:00
parent 0f26abeef1
commit 29789ae312
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
27 changed files with 55 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

48
docs/libcurl/curl_multi_socket_all.md
View file

@ -16,14 +16,12 @@ Protocol:
# NAME
curl_multi_socket - reads/writes available data
curl_multi_socket_all - reads/writes available data for all easy handles
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLMcode curl_multi_socket(CURLM *multi_handle, curl_socket_t sockfd,
int *running_handles);
CURLMcode curl_multi_socket_all(CURLM *multi_handle,
int *running_handles);
@ -31,62 +29,34 @@ CURLMcode curl_multi_socket_all(CURLM *multi_handle,
# DESCRIPTION
These functions are deprecated. Do not use. See
curl_multi_socket_action(3) instead.
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. Note that when you call
curl_multi_socket_action(3) on a specific socket and the counter
decreases by one, it DOES NOT necessarily mean that this exact socket/transfer
is the one that completed. Use curl_multi_info_read(3) to figure out
which easy handle that completed.
The curl_multi_socket_action(3) functions inform the application about
updates in the socket (file descriptor) status by doing none, one, or multiple
calls to the socket callback function set with the
CURLMOPT_SOCKETFUNCTION(3) option to curl_multi_setopt(3). They
update the status with changes since the previous time the callback was
called.
Get the timeout time by setting the CURLMOPT_TIMERFUNCTION(3) option
with curl_multi_setopt(3). Your application then gets called with
information on how long to wait for socket actions at most before doing the
timeout action: call the curl_multi_socket_action(3) function with the
**sockfd** argument set 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 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.
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.
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)
{
/* the event-library gets told when there activity on the socket 'fd',
which we translate to a call to curl_multi_socket_action() */
int running;
int rc;
int fd;
CURLM *multi;
rc = curl_multi_socket(multi, fd, &running);
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.
This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0.
curl_multi_socket(3) is deprecated, use
curl_multi_socket_all(3) is deprecated, use
curl_multi_socket_action(3) instead!
# RETURN VALUE