aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2013-09-30 16:35:09 +0200
committerHans Nilsson <[email protected]>2013-10-28 16:09:20 +0100
commitf5495aa1560daf65c063a8d5b99a5ea17520ea92 (patch)
tree93a94f73c882ab25f9ed3c7fddd4f5237551bd9b /lib/ssh/doc
parentd54e4318a77c7a42a7b8952780b33987775c7608 (diff)
downloadotp-f5495aa1560daf65c063a8d5b99a5ea17520ea92.tar.gz
otp-f5495aa1560daf65c063a8d5b99a5ea17520ea92.tar.bz2
otp-f5495aa1560daf65c063a8d5b99a5ea17520ea92.zip
ssh: Add ssh:sockname/1 incl doc and tests
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 ddfb50ebd2..896b98edc2 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -367,6 +367,20 @@
</func>
<func>
+ <name>sockname(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 local address and port number for a connection.
+ </p>
+ </desc>
+ </func>
+
+ <func>
<name>start() -> </name>
<name>start(Type) -> ok | {error, Reason}</name>
<fsummary>Starts the SSH application. </fsummary>