aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc
diff options
context:
space:
mode:
authorFredrik Gustafsson <[email protected]>2012-11-16 15:07:02 +0100
committerFredrik Gustafsson <[email protected]>2012-11-16 15:07:02 +0100
commit67bb449ebc3e51a39c73b04eefb25feba6e1aa1e (patch)
treeaa7752f9851ad87409542d206adb279598207841 /lib/ssh/doc
parent9278347678eea78419c0c310f767eaa1f4be4040 (diff)
parent49fef147845655e44f91cd4fdf4be92162e65710 (diff)
downloadotp-67bb449ebc3e51a39c73b04eefb25feba6e1aa1e.tar.gz
otp-67bb449ebc3e51a39c73b04eefb25feba6e1aa1e.tar.bz2
otp-67bb449ebc3e51a39c73b04eefb25feba6e1aa1e.zip
Merge branch 'fredrik/ssh/timer-on-connect/OTP-10514'
* fredrik/ssh/timer-on-connect/OTP-10514: New setup in testing idle_time Use same connect as the rest of testcases Fixed doc Added testcase for idle timer Not start the idle timer on connect Doc about idle_time option to ssh:connect Check cache on channel exec handle no idle-timer on check cache Option idle_time introduced, it will trigger the timer and if it is not given the timer_ref entry is infinity Timeout after 1h of idle on connection, which exits the connection Conflicts: lib/ssh/src/ssh.erl
Diffstat (limited to 'lib/ssh/doc')
-rw-r--r--lib/ssh/doc/src/ssh.xml5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 9de1dd1dad..aac4b462a2 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -193,7 +193,10 @@
(simply passed on to the transport protocol).</p></item>
<tag><c><![CDATA[{ip_v6_disabled, boolean()}]]></c></tag>
<item>
- <p>Determines if SSH shall use IPv6 or not.</p></item>
+ <p>Determines if SSH shall use IPv6 or not.</p></item>
+ <tag><c><![CDATA[{idle_time, timeout()}]]></c></tag>
+ <item>
+ <p>Sets a timeout on connection when no channels are active, default is infinity</p></item>
</taglist>
</desc>
</func>