diff options
Diffstat (limited to 'lib/ssh/doc/src/ssh_channel.xml')
| -rw-r--r-- | lib/ssh/doc/src/ssh_channel.xml | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml index f0083ae8d1..66b3b8b656 100644 --- a/lib/ssh/doc/src/ssh_channel.xml +++ b/lib/ssh/doc/src/ssh_channel.xml @@ -5,7 +5,7 @@ <header> <copyright> <year>2009</year> - <year>2012</year> + <year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> @@ -31,7 +31,7 @@ <p>SSH services (clients and servers) are implemented as channels that are multiplexed over an SSH connection and communicates via the <url href="http://www.ietf.org/rfc/rfc4254.txt"> SSH - Connection Protocol </url>. This module provides a callback API + Connection Protocol</url>. This module provides a callback API that takes care of generic channel aspects such as flow control and close messages and lets the callback functions take care of the service (application) specific parts. This behavior also ensures @@ -41,12 +41,12 @@ the SSH applications supervisor tree. </p> - <note> When implementing a SSH subsystem use the - <c>-behaviour(ssh_subsystem).</c> instead of <c>-behaviour(ssh_channel).</c> + <note> <p>When implementing a SSH subsystem use the + <c>-behaviour(ssh_daemon_channel).</c> instead of <c>-behaviour(ssh_channel).</c> as the only relevant callback functions for subsystems are - init/1, handle_ssh_msg/2, handle_msg/2 and terminate/2, so the ssh_subsystem + init/1, handle_ssh_msg/2, handle_msg/2 and terminate/2, so the ssh_daemon_channel behaviour is limited version of the ssh_channel behaviour. - </note> + </p> </note> </description> <section> @@ -83,7 +83,7 @@ <desc> <p>Makes a synchronous call to the channel process by sending a message and waiting until a reply arrives or a timeout - occurs. The channel will call <seealso mark = + occurs. The channel will call <seealso marker = "#Module:handle_call-3">Module:handle_call/3</seealso> to handle the message. If the channel process does not exist <c>{error, closed}</c> is returned. @@ -104,7 +104,7 @@ <p>Sends an asynchronous message to the channel process and returns ok immediately, ignoring if the destination node or channel process does not exist. The channel will call - <seealso mark = "#Module:handle_cast-3">Module:handle_cast/2</seealso> + <seealso marker = "#Module:handle_cast-2">Module:handle_cast/2</seealso> to handle the message. </p> </desc> @@ -114,7 +114,7 @@ <name>enter_loop(State) -> _ </name> <fsummary> Makes an existing process an ssh_channel process. </fsummary> <type> - <v> State = term() - as returned by <seealso mark = "#init-1">ssh_channel:init/1</seealso></v> + <v> State = term() - as returned by <seealso marker = "#init-1">ssh_channel:init/1</seealso></v> </type> <desc> <p> Makes an existing process an <c>ssh_channel</c> @@ -124,7 +124,7 @@ one of the start functions in proc_lib, see <seealso marker="stdlib:proc_lib">proc_lib(3)</seealso>. The user is responsible for any initialization of the process - and needs to call <seealso mark = "#init-1">ssh_channel:init/1</seealso> + and needs to call <seealso marker = "#init-1">ssh_channel:init/1</seealso> </p> </desc> </func> @@ -155,7 +155,7 @@ marker="ssh#connect-3">ssh:connect/3</seealso></item> <tag><c><![CDATA[{channel_id, channel_id()}]]></c></tag> - <item> Id of the ssh channel.</item> + <item> Id of the SSH channel.</item> </taglist> @@ -222,8 +222,8 @@ <title> CALLBACK TIMEOUTS</title> <p>The timeout values that may be returned by the callback functions - has the same semantics as in a <seealso marker="stdlib#gen_server">gen_server</seealso> - If the timeout occurs <seealso marker="#handle_msg">handle_msg/2</seealso> + has the same semantics as in a <seealso marker="stdlib:gen_server">gen_server</seealso> + If the timeout occurs <seealso marker="#Module:handle_msg-2">handle_msg/2</seealso> will be called as <c>handle_msg(timeout, State). </c></p> </section> @@ -334,7 +334,6 @@ </p> <p>For more detailed information on timeouts see the section <seealso marker="#cb_timeouts">CALLBACK TIMEOUTS</seealso>. </p> - <marker id="handle_msg"></marker> </desc> </func> @@ -342,10 +341,11 @@ <name>Module:handle_msg(Msg, State) -> {ok, State} | {stop, ChannelId, State}</name> - <fsummary> Handle other messages than ssh connection protocol, + <fsummary> Handle other messages than SSH connection protocol, call or cast messages sent to the channel.</fsummary> <type> <v>Msg = timeout | term()</v> + <v>ChannelId = ssh_channel_id()</v> <v>State = term() </v> </type> <desc> @@ -361,7 +361,7 @@ ssh_connection_ref()}]]></c></tag> <item>This is the first messages that will be received by the channel, it is sent just before the <seealso - marker="#init-2">ssh_channel:init/1</seealso> function + marker="#init-1">ssh_channel:init/1</seealso> function returns successfully. This is especially useful if the server wants to send a message to the client without first receiving a message from it. If the message is not @@ -374,19 +374,20 @@ <func> <name>Module:handle_ssh_msg(Msg, State) -> {ok, State} | {stop, - ssh_channel_id(), State}</name> + ChannelId, State}</name> <fsummary> Handles ssh connection protocol messages. </fsummary> <type> <v>Msg = <seealso marker="ssh_connection"> ssh_connection:event() </seealso> </v> + <v>ChannelId = ssh_channel_id()</v> <v>State = term()</v> </type> <desc> - <p> Handles ssh connection protocol messages that may need + <p> Handles SSH connection protocol messages that may need service specific attention. </p> <p> The following message is completely taken care of by the - ssh channel behavior</p> + SSH channel behavior</p> <taglist> <tag><c><![CDATA[{closed, ssh_channel_id()}]]></c></tag> |