Commit d18fb4a1 authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

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.
parent 26e3c74a

docs/libcurl/curl_multi_timeout.3

+5 −2
Original line number Original line Diff line number Diff line
@@ -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

immediately without waiting for anything. If it returns -1, there's no timeout

at all set.

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

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

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.

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

.SH AVAILABILITY

This function was added in libcurl 7.15.4.

This function was added in libcurl 7.15.4.

.SH "SEE ALSO"

.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_fdset "(3), " curl_multi_info_read "(3), "

.BR curl_multi_socket "(3) "

.BR curl_multi_socket "(3), " curl_multi_setopt "(3) "