diff options
| author | Hans Nilsson <[email protected]> | 2016-06-01 11:47:52 +0200 |
|---|---|---|
| committer | Hans Nilsson <[email protected]> | 2016-06-01 11:47:52 +0200 |
| commit | 317079a89bdf69888e398cb7e5703bfda7bd2c74 (patch) | |
| tree | 82e0a323967b1506eb21cc0ec652476e4c3933ac /lib/ssh/doc/src/ssh_sftp.xml | |
| parent | b2cefac14a6b26c78f584592801413611ff6f31c (diff) | |
| parent | 84051a76ee4c07f7453ba2bf24fe32c8cf8c7b48 (diff) | |
| download | otp-317079a89bdf69888e398cb7e5703bfda7bd2c74.tar.gz otp-317079a89bdf69888e398cb7e5703bfda7bd2c74.tar.bz2 otp-317079a89bdf69888e398cb7e5703bfda7bd2c74.zip | |
Merge branch 'hans/ssh/use_open_socket_client/OTP-12860'
Diffstat (limited to 'lib/ssh/doc/src/ssh_sftp.xml')
| -rw-r--r-- | lib/ssh/doc/src/ssh_sftp.xml | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 071d46ec57..67531b7d99 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -526,16 +526,24 @@ </func> <func> + <name>start_channel(TcpSocket) -></name> + <name>start_channel(TcpSocket, Options) -> + {ok, Pid, ConnectionRef} | {error, reason()|term()}</name> + <name>start_channel(ConnectionRef) -></name> - <name>start_channel(ConnectionRef, Options) -></name> + <name>start_channel(ConnectionRef, Options) -> + {ok, Pid} | {error, reason()|term()}</name> + <name>start_channel(Host, Options) -></name> - <name>start_channel(Host, Port, Options) -> {ok, Pid} | {ok, Pid, ConnectionRef} | - {error, reason()|term()}</name> + <name>start_channel(Host, Port, Options) -> + {ok, Pid, ConnectionRef} | {error, reason()|term()}</name> <fsummary>Starts an SFTP client.</fsummary> <type> <v>Host = string()</v> <v>ConnectionRef = ssh_connection_ref()</v> <v>Port = integer()</v> + <v>TcpSocket = port()</v> + <d>The socket is supposed to be from <c>gen_tcp:connect</c> with option <c>{active,false}</c></d> <v>Options = [{Option, Value}]</v> </type> <desc> |