[master] 97d2c57 sync idle_send_timeout and send_timeout documentation with reality
Nils Goroll
nils.goroll at uplex.de
Fri May 12 14:53:05 CEST 2017
commit 97d2c575521fc75a7e63c05545658131b300aece
Author: Nils Goroll <nils.goroll at uplex.de>
Date: Fri May 12 13:03:39 2017 +0200
sync idle_send_timeout and send_timeout documentation with reality
The name idle_send_timeout does not seem to describe well where the timeout
applies (individual write()/writev() calls for arbitraty amounts of data).
The fact that the explanation is complicated might be an indication that a
different timeout implementation be more appropriate.
HTTP2 should probably implement send_timeout somewhen.
diff --git a/include/tbl/params.h b/include/tbl/params.h
index 2dee510..870ba41 100644
--- a/include/tbl/params.h
+++ b/include/tbl/params.h
@@ -715,10 +715,11 @@ PARAM(
/* units */ "seconds",
/* flags */ XYZZY,
/* s-text */
- "Time to wait with no data sent. If no data has been transmitted "
- "in this many\n"
- "seconds the session is closed.\n"
- "See setsockopt(2) under SO_SNDTIMEO for more information.",
+ "Send timeout for individual pieces of data on client connections."
+ " May get extended if 'send_timeout' applies.\n\n"
+ "When this timeout is hit, the session is closed.\n\n"
+ "See the man page for `setsockopt(2)` under ``SO_SNDTIMEO`` for more"
+ " information.",
/* l-text */ "",
/* func */ NULL
)
@@ -980,10 +981,12 @@ PARAM(
/* units */ "seconds",
/* flags */ XYZZY,
/* s-text */
- "Send timeout for client connections. If the HTTP response hasn't "
- "been transmitted in this many\n"
- "seconds the session is closed.\n"
- "See setsockopt(2) under SO_SNDTIMEO for more information.",
+ "Total timeout for ordinary HTTP1 responses. Does not apply to some"
+ " internally generated errors and pipe mode.\n\n"
+ "When 'send_idle_timeout' is hit while sending an HTTP1 response, the"
+ " timeout is extended unless the total time already taken for sending"
+ " the response in its entirety exceeds this many seconds.\n\n"
+ "When this timeout is hit, the session is closed",
/* l-text */ "",
/* func */ NULL
)
More information about the varnish-commit
mailing list