diff options
Diffstat (limited to 'docs/libcurl/libcurl-multi.3')
| -rw-r--r-- | docs/libcurl/libcurl-multi.3 | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/libcurl/libcurl-multi.3 b/docs/libcurl/libcurl-multi.3 index 76f8c3620..96013552f 100644 --- a/docs/libcurl/libcurl-multi.3 +++ b/docs/libcurl/libcurl-multi.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2018, 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 @@ -132,24 +132,24 @@ using large numbers of simultaneous connections. When using this API, you add easy handles to the multi handle just as with the normal multi interface. Then you also set two callbacks with the -CURLMOPT_SOCKETFUNCTION and CURLMOPT_TIMERFUNCTION options to -\fIcurl_multi_setopt(3)\fP. They are two callback functions that libcurl will -call with information about what sockets to wait for, and for what activity, -and what the current timeout time is - if that expires libcurl should be -notified. +\fICURLMOPT_SOCKETFUNCTION(3)\fP and \fICURLMOPT_TIMERFUNCTION(3)\fP options +to \fIcurl_multi_setopt(3)\fP. They are two callback functions that libcurl +will call with information about what sockets to wait for, and for what +activity, and what the current timeout time is - if that expires libcurl +should be notified. The multi_socket API is designed to inform your application about which sockets libcurl is currently using and for what activities (read and/or write) on those sockets your application is expected to wait for. Your application must make sure to receive all sockets informed about in the -CURLMOPT_SOCKETFUNCTION callback and make sure it reacts on the given activity -on them. When a socket has the given activity, you call +\fICURLMOPT_SOCKETFUNCTION(3)\fP callback and make sure it reacts on the given +activity on them. When a socket has the given activity, you call \fIcurl_multi_socket_action(3)\fP specifying which socket and action there are. -The CURLMOPT_TIMERFUNCTION callback is called to set a timeout. When that -timeout expires, your application should call the +The \fICURLMOPT_TIMERFUNCTION(3)\fP callback is called to set a timeout. When +that timeout expires, your application should call the \fIcurl_multi_socket_action(3)\fP function saying it was due to a timeout. This API is typically used with an event-driven underlying functionality (like |