diff options
Diffstat (limited to 'docs/libcurl/libcurl-multi.3')
| -rw-r--r-- | docs/libcurl/libcurl-multi.3 | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/docs/libcurl/libcurl-multi.3 b/docs/libcurl/libcurl-multi.3 index 95c3681ae..654d7eb9b 100644 --- a/docs/libcurl/libcurl-multi.3 +++ b/docs/libcurl/libcurl-multi.3 @@ -5,11 +5,11 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * 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 -.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * are also available at https://curl.se/docs/copyright.html. .\" * .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell .\" * copies of the Software, and permit persons to whom the Software is @@ -20,7 +20,7 @@ .\" * .\" ************************************************************************** .\" -.TH libcurl-multi 3 "April 26, 2020" "libcurl 7.73.0" "libcurl multi interface" +.TH libcurl-multi 3 "December 23, 2021" "libcurl 7.81.0" "libcurl multi interface" .SH NAME libcurl-multi \- how to use the multi interface @@ -33,7 +33,7 @@ for an overview of the libcurl easy interface. All functions in the multi interface are prefixed with curl_multi. .SH "OBJECTIVES" -The multi interface offers several abilities that the easy interface doesn't. +The multi interface offers several abilities that the easy interface does not. They are mainly: 1. Enable a "pull" interface. The application that uses libcurl decides where @@ -72,14 +72,14 @@ Should you change your mind, the easy handle is again removed from the multi stack using \fIcurl_multi_remove_handle(3)\fP. Once removed from the multi handle, you can again use other easy interface functions like \fIcurl_easy_perform(3)\fP on the handle or whatever you think is -necessary. You can remove handles at any point in time during transfers. +necessary. You can remove handles at any point during transfers. Adding the easy handle to the multi handle does not start the transfer. Remember that one of the main ideas with this interface is to let your application drive. You drive the transfers by invoking \fIcurl_multi_perform(3)\fP. libcurl will then transfer data if there is -anything available to transfer. It'll use the callbacks and everything else -you have setup in the individual easy handles. It'll transfer data on all +anything available to transfer. it will use the callbacks and everything else +you have setup in the individual easy handles. it will transfer data on all current transfers in the multi stack that are ready to transfer anything. It may be all, it may be none. When there's nothing more to do for now, it returns back to the calling application. @@ -98,7 +98,7 @@ period for your select() calls. \fIcurl_multi_perform(3)\fP stores the number of still running transfers in one of its input arguments, and by reading that you can figure out when all the transfers in the multi handles are done. 'done' does not mean -successful. One or more of the transfers may have failed. +successful. One or more of the transfers may have failed. To get information about completed transfers, to figure out success or not and similar, \fIcurl_multi_info_read(3)\fP should be called. It can return a @@ -158,11 +158,11 @@ libevent, libev, kqueue, epoll or similar) with which the application better scale upward and beyond thousands of simultaneous transfers without losing performance. -When you've added your initial set of handles, you call +When you have added your initial set of handles, you call \fIcurl_multi_socket_action(3)\fP with CURL_SOCKET_TIMEOUT set in the sockfd -argument, and you'll get callbacks call that sets you up and you then continue +argument, and you will get callbacks call that sets you up and you then continue to call \fIcurl_multi_socket_action(3)\fP accordingly when you get activity on -the sockets you've been asked to wait on, or if the timeout timer expires. +the sockets you have been asked to wait on, or if the timeout timer expires. You can poll \fIcurl_multi_info_read(3)\fP to see if any transfer has completed, as it then has a message saying so. @@ -173,7 +173,6 @@ the future, you should be aware of the following current restrictions: .nf - Name resolves unless the c-ares or threaded-resolver backends are used - - SOCKS proxy handshakes - file:// transfers - TELNET transfers .fi |