summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2019-05-03 15:44:49 +0200
committerDaniel Stenberg <daniel@haxx.se>2019-05-03 23:21:07 +0200
commit139202bb68dcccd01eab031db5b331db1f999d3b (patch)
treea770e61fdf8477d6053b09d8b4e5da163aa0ff3d
parent28f38da5063d88fd8fc503cb56a8b6bafa1d953d (diff)
downloadcurl-139202bb68dcccd01eab031db5b331db1f999d3b.tar.gz
CURLMOPT_TIMERFUNCTION.3: warn about the recursive risk [ci skip]
Reported-by: Ricardo Gomes Bug: #3537 Closes #3836
-rw-r--r--docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.35
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3 b/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3
index d926d811d..344813fe8 100644
--- a/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3
+++ b/docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.3
@@ -54,6 +54,11 @@ The \fBuserp\fP pointer is set with \fICURLMOPT_TIMERDATA(3)\fP.
The timer callback should return 0 on success, and -1 on error. This callback
can be used instead of, or in addition to, \fIcurl_multi_timeout(3)\fP.
+
+\fBWARNING:\fP even if it feels tempting, avoid calling libcurl directly from
+within the callback itself when the \fBtimeout_ms\fP value is zero, since it
+risks triggering an unpleasant recursive behavior that immediately calls
+another call to the callback with a zero timeout...
.SH DEFAULT
NULL
.SH PROTOCOLS