diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2007-07-30 22:01:04 +0000 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2007-07-30 22:01:04 +0000 |
| commit | 16710a1c9bb763cc523738d61194fd40776c9fa5 (patch) | |
| tree | 2a8ab58ebe22c3693ad3eeb392626aaafffca583 /docs/libcurl/curl_multi_socket.3 | |
| parent | ba5c71b79b13e6674a68bc511043b085ed156048 (diff) | |
users should use the CURLMOPT_TIMERFUNCTION rather than curl_multi_timeout
when using the socket API
Diffstat (limited to 'docs/libcurl/curl_multi_socket.3')
| -rw-r--r-- | docs/libcurl/curl_multi_socket.3 | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/docs/libcurl/curl_multi_socket.3 b/docs/libcurl/curl_multi_socket.3 index 8caa0e83c..f8587fdee 100644 --- a/docs/libcurl/curl_multi_socket.3 +++ b/docs/libcurl/curl_multi_socket.3 @@ -106,7 +106,7 @@ The \fIuserp\fP argument is a private pointer you have previously set with CURLMcode type, general libcurl multi interface error code. If you receive \fICURLM_CALL_MULTI_PERFORM\fP, this basically means that you -should call \fIcurl_multi_perform\fP again, before you wait for more actions +should call \fIcurl_multi_socket(3)\fP again, before you wait for more actions on libcurl's sockets. You don't have to do it immediately, but the return code means that libcurl may have more data available to return or that there may be more data to send off before it is "satisfied". @@ -119,22 +119,25 @@ function returns OK. 2. Set the socket callback with CURLMOPT_SOCKETFUNCTION -3. Add easy handles +3. Set the timeout callback with CURLMOPT_TIMERFUNCTION, to get to know what +timeout value to use when waiting for socket activities. -4. Call curl_multi_socket_all() first once +4. Add easy handles -5. Provide some means to manage the sockets libcurl is using, so you can check +5. Call curl_multi_socket_all() first once + +6. Provide some means to manage the sockets libcurl is using, so you can check them for activity. This can be done through your application code, or by way of an external library such as libevent or glib. -6. Use curl_multi_timeout() to figure out how long to wait for activity - -7. Wait for activity on any of libcurl's sockets +7. Wait for activity on any of libcurl's sockets, use the timeout value your +calback has been told 8, When activity is detected, call curl_multi_socket_action() for the -socket(s) that got action. +socket(s) that got action. If no activity is detected and the timeout expires, +call \fIcurl_multi_socket(3)\fP with \fICURL_SOCKET_TIMEOUT\fP -9. Go back to step 6. +9. Go back to step 7. .SH AVAILABILITY This function was added in libcurl 7.15.4, although deemed stable since 7.16.0. |