diff options
| author | Hans Nilsson <[email protected]> | 2013-10-28 16:12:29 +0100 |
|---|---|---|
| committer | Hans Nilsson <[email protected]> | 2013-10-28 16:12:29 +0100 |
| commit | 207a13a549052e014a82362032995e347ffb68ff (patch) | |
| tree | 93a94f73c882ab25f9ed3c7fddd4f5237551bd9b /lib/ssh/doc | |
| parent | 609e1414a0685c2082d30f9d5c50ca65209a1236 (diff) | |
| parent | f5495aa1560daf65c063a8d5b99a5ea17520ea92 (diff) | |
| download | otp-207a13a549052e014a82362032995e347ffb68ff.tar.gz otp-207a13a549052e014a82362032995e347ffb68ff.tar.bz2 otp-207a13a549052e014a82362032995e347ffb68ff.zip | |
Merge branch 'hans/ssh/srcip/OTP-11339' into maint
* hans/ssh/srcip/OTP-11339:
ssh: Add ssh:sockname/1 incl doc and tests
ssh: Add function ssh:peername/1 with test
Diffstat (limited to 'lib/ssh/doc')
| -rw-r--r-- | lib/ssh/doc/src/ssh.xml | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index fb58a4b014..896b98edc2 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> @@ -353,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> |