diff options
Diffstat (limited to 'docs/libcurl/curl_multi_socket_action.3')
| -rw-r--r-- | docs/libcurl/curl_multi_socket_action.3 | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/libcurl/curl_multi_socket_action.3 b/docs/libcurl/curl_multi_socket_action.3 index 61d997984..d62168429 100644 --- a/docs/libcurl/curl_multi_socket_action.3 +++ b/docs/libcurl/curl_multi_socket_action.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -19,7 +19,7 @@ .\" * KIND, either express or implied. .\" * .\" ************************************************************************** -.TH curl_multi_socket_action 3 "November 05, 2020" "libcurl 7.78.0" "libcurl Manual" +.TH curl_multi_socket_action 3 "October 25, 2021" "libcurl 7.80.0" "libcurl Manual" .SH NAME curl_multi_socket_action \- reads/writes available data given an action @@ -27,7 +27,7 @@ curl_multi_socket_action \- reads/writes available data given an action .nf #include <curl/curl.h> -CURLMcode curl_multi_socket_action(CURLM * multi_handle, +CURLMcode curl_multi_socket_action(CURLM *multi_handle, curl_socket_t sockfd, int ev_bitmask, int *running_handles); @@ -89,8 +89,19 @@ callback has been told. 8, When activity is detected, call curl_multi_socket_action() for the socket(s) that got action. If no activity is detected and the timeout expires, call \fIcurl_multi_socket_action(3)\fP with \fICURL_SOCKET_TIMEOUT\fP. +.SH EXAMPLE +.nf +/* 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; +rc = curl_multi_socket_action(multi_handle, fd, EVENT, + &running); +.fi .SH AVAILABILITY This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0. +.SH RETURN VALUE +CURLMcode type, general libcurl multi interface error code. See +\fIlibcurl-errors(3)\fP .SH "SEE ALSO" .BR curl_multi_cleanup "(3), " curl_multi_init "(3), " .BR curl_multi_fdset "(3), " curl_multi_info_read "(3), " |