aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2007-12-11 21:19:38 +0000
committerDaniel Stenberg <daniel@haxx.se>2007-12-11 21:19:38 +0000
commit92eae30f4d9b8ea204bb56d6fbeb244561169e3a (patch)
treebb2a98c379f72db7aad15f5a4e8ce44761abf9d4
parent79ef08f63145c9e1646359ff0866862bdcb742c2 (diff)
clarify that the CURLMOPT_TIMERFUNCTION callback can pass in 0 and -1 as legal
values and what they mean
-rw-r--r--docs/libcurl/curl_multi_setopt.39
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/libcurl/curl_multi_setopt.3 b/docs/libcurl/curl_multi_setopt.3
index f05ba2d36..7053735f5 100644
--- a/docs/libcurl/curl_multi_setopt.3
+++ b/docs/libcurl/curl_multi_setopt.3
@@ -47,10 +47,11 @@ changes. The timeout value is at what latest time the application should call
one of the \&"performing" functions of the multi interface
(\fIcurl_multi_socket(3)\fP, \fIcurl_multi_socket_all(3)\fP and
\fIcurl_multi_perform(3)\fP) - to allow libcurl to keep timeouts and retries
-etc to work. Libcurl attempts to limit calling this only when the fixed future
-timeout time actually change. See also \fICURLMOPT_TIMERDATA\fP. This callback
-can be used instead of, or in addition to, \fIcurl_multi_timeout(3)\fP. (Added
-in 7.16.0)
+etc to work. A timeout value of -1 means that there is no timeout at all, and
+0 means that the timeout is already reached. Libcurl attempts to limit calling
+this only when the fixed future timeout time actually change. See also
+\fICURLMOPT_TIMERDATA\fP. This callback can be used instead of, or in addition
+to, \fIcurl_multi_timeout(3)\fP. (Added in 7.16.0)
.IP CURLMOPT_TIMERDATA
Pass a pointer to whatever you want passed to the
\fBcurl_multi_timer_callback\fP's third argument, the userp pointer. This is