aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2013-09-25 14:56:19 +0200
committerHans Nilsson <[email protected]>2013-10-28 16:09:20 +0100
commitd54e4318a77c7a42a7b8952780b33987775c7608 (patch)
tree1d05e90565293daa09b337e18e5021f78390c5d6 /lib/ssh/doc
parent609e1414a0685c2082d30f9d5c50ca65209a1236 (diff)
downloadotp-d54e4318a77c7a42a7b8952780b33987775c7608.tar.gz
otp-d54e4318a77c7a42a7b8952780b33987775c7608.tar.bz2
otp-d54e4318a77c7a42a7b8952780b33987775c7608.zip
ssh: Add function ssh:peername/1 with test
OTP-11345, sto575, tsk374
Diffstat (limited to 'lib/ssh/doc')
-rw-r--r--lib/ssh/doc/src/ssh.xml14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index fb58a4b014..ddfb50ebd2 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -334,6 +334,20 @@
</func>
<func>
+ <name>peername(ConnectionRef) -> {ok, {Address,Port}} | {error,Error} </name>
+ <fsummary> </fsummary>
+ <type>
+ <v> ConnectionRef = ssh_connection_ref()</v>
+ <v> Address = ip_address()</v>
+ <v> Port = integer()</v>
+ </type>
+ <desc>
+ <p>Returns the address and port for the other end of a connection.
+ </p>
+ </desc>
+ </func>
+
+ <func>
<name>shell(Host) -> </name>
<name>shell(Host, Option) -> </name>
<name>shell(Host, Port, Option) -> _</name>