summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2021-12-02 12:05:48 +0100
committerDaniel Stenberg <daniel@haxx.se>2021-12-02 12:05:48 +0100
commitc8a3046555378f81b22d51e3887df8a5cf1ab5bf (patch)
tree0872d87d75c0b819aeb98e2607f88f8c525c8315
parent456c53730d21b1fad0c7f72c1817999fba93d077 (diff)
downloadcurl-c8a3046555378f81b22d51e3887df8a5cf1ab5bf.tar.gz
CURLMOPT_TIMERFUNCTION.3: call it expire time, not interval
Since we say it is a non-repating timer
-rw-r--r--docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.36
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3 b/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3
index cacc23548..bea24e293 100644
--- a/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3
+++ b/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3
@@ -40,9 +40,9 @@ Certain features, such as timeouts and retries, require you to call libcurl
even when there is no activity on the file descriptors.
Your callback function \fBtimer_callback\fP should install a non-repeating
-timer with an interval of \fBtimeout_ms\fP. When that timer fires, call
-either \fIcurl_multi_socket_action(3)\fP or \fIcurl_multi_perform(3)\fP,
-depending on which interface you use.
+timer with an expire time of \fBtimeout_ms\fP milliseconds. When that timer
+fires, call either \fIcurl_multi_socket_action(3)\fP or
+\fIcurl_multi_perform(3)\fP, depending on which interface you use.
A \fBtimeout_ms\fP value of -1 passed to this callback means you should delete
the timer. All other values are valid expire times in number of milliseconds.