diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2010-04-12 11:08:06 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2010-04-12 11:08:06 +0200 |
| commit | d18fb4a12968c6a8ed26488dfe6169fc294d10be (patch) | |
| tree | c5407e723fe8e785abec5dcb850e2fe29f1bb0ee /docs | |
| parent | 26e3c74ab7859ae0e7640580b8227865d6dfb88b (diff) | |
refer to CURLMOPT_TIMERFUNCTION for multi_socket users
curl_multi_timeout(3) is simply the wrong function to use
if you're using the multi_socket API and this document now
states this pretty clearly to help guiding users.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/libcurl/curl_multi_timeout.3 | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/libcurl/curl_multi_timeout.3 b/docs/libcurl/curl_multi_timeout.3 index 8ba8da7fb..9e53d0b8a 100644 --- a/docs/libcurl/curl_multi_timeout.3 +++ b/docs/libcurl/curl_multi_timeout.3 @@ -22,6 +22,10 @@ of milliseconds at this very moment. If 0, it means you should proceed immediately without waiting for anything. If it returns -1, there's no timeout at all set. +An application that uses the multi_socket API SHOULD not use this function, but +SHOULD instead use \fIcurl_multi_setopt(3)\fP and its +\fPCURLMOPT_TIMERFUNCTION\fP option for proper and desired behavior. + Note: if libcurl returns a -1 timeout here, it just means that libcurl currently has no stored timeout value. You must not wait too long (more than a few seconds perhaps) before you call curl_multi_perform() again. @@ -34,7 +38,6 @@ by a previous call to \fBcurl_multi_socket(3)\fP. .SH AVAILABILITY This function was added in libcurl 7.15.4. .SH "SEE ALSO" -.BR curl_multi_cleanup "(3), " curl_multi_init "(3), " .BR curl_multi_fdset "(3), " curl_multi_info_read "(3), " -.BR curl_multi_socket "(3) " +.BR curl_multi_socket "(3), " curl_multi_setopt "(3) " |