aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc/src/ssh.xml
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2017-04-04 17:38:32 +0200
committerHans Nilsson <[email protected]>2017-04-04 17:38:32 +0200
commitc6e7c2d0f818b53cb2d1fa3ed85ff8723859f746 (patch)
treefb513fa4ff588f9dcaf21a080bdcf6b545a54b69 /lib/ssh/doc/src/ssh.xml
parentfbe1980e5ca85e516648420e0fed0d00b20a0529 (diff)
parent1cc5affef1dee69e5cb4b7d4aca0465e1072d4d9 (diff)
downloadotp-c6e7c2d0f818b53cb2d1fa3ed85ff8723859f746.tar.gz
otp-c6e7c2d0f818b53cb2d1fa3ed85ff8723859f746.tar.bz2
otp-c6e7c2d0f818b53cb2d1fa3ed85ff8723859f746.zip
Merge branch 'hans/ssh/idle_time_server/OTP-14312'
Diffstat (limited to 'lib/ssh/doc/src/ssh.xml')
-rw-r--r--lib/ssh/doc/src/ssh.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index 968983c862..88d402cf38 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -699,6 +699,12 @@
<p><c>Peer</c> is in the format of <c>{Host,Port}</c>.</p>
</item>
+ <tag><c><![CDATA[{idle_time, integer()}]]></c></tag>
+ <item>
+ <p>Sets a time-out on a connection when no channels are active.
+ Defaults to <c>infinity</c>.</p>
+ </item>
+
<tag><c><![CDATA[{ssh_msg_debug_fun, fun(ConnectionRef::ssh_connection_ref(), AlwaysDisplay::boolean(), Msg::binary(), LanguageTag::binary()) -> _}]]></c></tag>
<item>
<p>Provide a fun to implement your own logging of the SSH message SSH_MSG_DEBUG. The last three parameters are from the message, see RFC4253, section 11.3. The <c>ConnectionRef</c> is the reference to the connection on which the message arrived. The return value from the fun is not checked.</p>