aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2007-12-06 22:36:52 +0000
committerDaniel Stenberg <daniel@haxx.se>2007-12-06 22:36:52 +0000
commitf8172f85b1c09554fc4134c4fc972bcfe4c7a9aa (patch)
tree4babfce86fa9cec85c99589cb7b28c331bd0c6b2 /docs
parent7d3ea12b625fd07d9d41a68e7cc2cd5322247584 (diff)
clarify that when curl_multi_timeout() returns -1 it just means that there
is no current timeout. It does not mean wait forever and it does not mean do not wait at all. It means there is no timeout value known at this point in time.
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/curl_multi_timeout.34
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/libcurl/curl_multi_timeout.3 b/docs/libcurl/curl_multi_timeout.3
index b04acf890..fbdb8fb03 100644
--- a/docs/libcurl/curl_multi_timeout.3
+++ b/docs/libcurl/curl_multi_timeout.3
@@ -23,6 +23,10 @@ The timeout value returned in the long \fBtimeout\fP points to, is in number
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.
+
+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.
.SH "RETURN VALUE"
The standard CURLMcode for multi interface error codes.
.SH "TYPICAL USAGE"