ssh: ssh_channel replaced by ssh_client_channel

11 files changed, 32 insertions, 81 deletions

diff --git a/lib/ssh/doc/src/Makefile b/lib/ssh/doc/src/Makefile
index 9b5bee34fa..7c4dbd7af8 100644
--- a/lib/ssh/doc/src/Makefile
+++ b/lib/ssh/doc/src/Makefile
@@ -40,10 +40,9 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
 XML_APPLICATION_FILES = ref_man.xml
 XML_REF3_FILES = \
 	ssh.xml \
-	ssh_channel.xml \
+	ssh_client_channel.xml \
 	ssh_client_key_api.xml \
 	ssh_connection.xml \
-	ssh_daemon_channel.xml \
 	ssh_server_channel.xml \
 	ssh_server_key_api.xml \
 	ssh_sftp.xml \
diff --git a/lib/ssh/doc/src/introduction.xml b/lib/ssh/doc/src/introduction.xml
index b7a73e2597..6fd8425adf 100644
--- a/lib/ssh/doc/src/introduction.xml
+++ b/lib/ssh/doc/src/introduction.xml
@@ -145,7 +145,7 @@
       data that can be sent to the channel peer without adjusting the
       window. Typically, an SSH client opens a channel, sends data (commands),
       receives data (control information), and then closes the channel.
-      The <seealso marker="ssh_channel">ssh_channel</seealso> behaviour
+      The <seealso marker="ssh_client_channel">ssh_client_channel</seealso> behaviour
       handles generic parts of SSH channel management. This makes it easy
       to write your own SSH client/server processes that use flow-control
       and thus opens for more focus on the application logic.
diff --git a/lib/ssh/doc/src/ref_man.xml b/lib/ssh/doc/src/ref_man.xml
index 3351699c66..76e6520f94 100644
--- a/lib/ssh/doc/src/ref_man.xml
+++ b/lib/ssh/doc/src/ref_man.xml
@@ -35,9 +35,8 @@
   </description>
   <xi:include href="ssh_app.xml"/>
   <xi:include href="ssh.xml"/>
-  <xi:include href="ssh_channel.xml"/>
+  <xi:include href="ssh_client_channel.xml"/>
   <xi:include href="ssh_server_channel.xml"/>
-  <!-- xi:include href="ssh_daemon_channel.xml"/ -->
   <xi:include href="ssh_connection.xml"/>
   <xi:include href="ssh_client_key_api.xml"/>
   <xi:include href="ssh_server_key_api.xml"/>
diff --git a/lib/ssh/doc/src/specs.xml b/lib/ssh/doc/src/specs.xml
index 15e76cb5fa..acdbe2ddfd 100644
--- a/lib/ssh/doc/src/specs.xml
+++ b/lib/ssh/doc/src/specs.xml
@@ -1,10 +1,9 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <specs xmlns:xi="http://www.w3.org/2001/XInclude">
   <xi:include href="../specs/specs_ssh.xml"/>
-  <xi:include href="../specs/specs_ssh_channel.xml"/>
+  <xi:include href="../specs/specs_ssh_client_channel.xml"/>
   <xi:include href="../specs/specs_ssh_client_key_api.xml"/>
   <xi:include href="../specs/specs_ssh_connection.xml"/>
-  <xi:include href="../specs/specs_ssh_daemon_channel.xml"/>
   <xi:include href="../specs/specs_ssh_server_channel.xml"/>
   <xi:include href="../specs/specs_ssh_server_key_api.xml"/>
   <xi:include href="../specs/specs_ssh_sftp.xml"/>
diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index da122b6081..0223831cb1 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -68,7 +68,7 @@
     <seealso marker="ssh_sftp#start_channel/1">ssh_sftp:start_channel/1,2,3</seealso>.
     </p>
     <p>To write your own client channel handler, use the behaviour 
-    <seealso marker="ssh_channel">ssh_channel</seealso>. For server channel handlers use 
+    <seealso marker="ssh_client_channel">ssh_client_channel</seealso>. For server channel handlers use 
     <seealso marker="ssh_server_channel">ssh_server_channel</seealso> behaviour (replaces ssh_daemon_channel).
     </p>
     <p>Both clients and daemons accepts options that controls the exact behaviour. Some options are common to both.
diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_client_channel.xml
index 63a480d747..eed49beffa 100644
--- a/lib/ssh/doc/src/ssh_channel.xml
+++ b/lib/ssh/doc/src/ssh_client_channel.xml
@@ -23,16 +23,22 @@
 
       The Initial Developer of the Original Code is Ericsson AB.
     </legalnotice>
-    <title>ssh_channel</title>
+    <title>ssh_client_channel</title>
     <prepared></prepared>
     <docno></docno>
     <date></date>
     <rev></rev>
   </header>
-  <module>ssh_channel</module>
-  <modulesummary>-behaviour(ssh_channel).
+  <module>ssh_client_channel</module>
+  <modulesummary>-behaviour(ssh_client_channel). (Replaces ssh_channel)
   </modulesummary>
   <description>
+    <note>
+      <p>This module replaces ssh_channel.</p>
+      <p>The old module is still available for compatibility, but should not be used for new programs.
+      The old module will not be maintained except for some error corrections
+      </p>
+    </note>
     <p>SSH services (clients and servers) are implemented as channels
     that are multiplexed over an SSH connection and communicates over
     the <url href="http://www.ietf.org/rfc/rfc4254.txt"> SSH
@@ -106,16 +112,16 @@
 
     <func>
       <name>enter_loop(State) -> _ </name>
-      <fsummary>Makes an existing process an ssh_channel process.</fsummary>
+      <fsummary>Makes an existing process an ssh_client_channel (replaces ssh_channel) process.</fsummary>
       <type>
 	<v>State = term()</v>
 	<d>as returned by <seealso marker = "#init-1">init/1</seealso></d>
       </type>
       <desc>
-	<p>Makes an existing process an <c>ssh_channel</c>
+	<p>Makes an existing process an <c>ssh_client_channel</c> (replaces ssh_channel)
 	process. Does not return, instead the calling process
-	enters the <c>ssh_channel</c> process receive loop and become an
-	<c>ssh_channel process</c>. The process must have been started using
+	enters the <c>ssh_client_channel</c> (replaces ssh_channel) process receive loop and become an
+	<c>ssh_client_channel</c> process. The process must have been started using
 	one of the start functions in <c>proc_lib</c>, see the <seealso
 	marker="stdlib:proc_lib">proc_lib(3)</seealso> manual page in STDLIB.
 	The user is responsible for any initialization of the process
@@ -126,7 +132,7 @@
     
     <func>
       <name>init(Options) -> {ok, State} |  {ok, State, Timeout} | {stop, Reason} </name>
-      <fsummary>Initiates an <c>ssh_channel</c> process.</fsummary>
+      <fsummary>Initiates an <c>ssh_client_channel</c> process.</fsummary>
       <type>
 	<v>Options = [{Option, Value}]</v>
 	<v>State = term()</v>
@@ -224,7 +230,7 @@
     <title>Callback Functions</title>
     <p>
       The following functions are to be exported from a
-      <c>ssh_channel</c> callback module.
+      <c>ssh_client_channel</c> callback module.
     </p>
     <marker id="cb_timeouts"></marker>
     <section>
@@ -398,7 +404,7 @@
 	</p>
 	
 	<p>The following message is taken care of by the
-	<c>ssh_channel</c> behavior.</p>
+	<c>ssh_client_channel</c> behavior.</p>
 	
 	<taglist>
 	  <tag><c>{closed, ssh:channel_id()}</c></tag>
diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml
index cfe5385eb4..821dfef93d 100644
--- a/lib/ssh/doc/src/ssh_connection.xml
+++ b/lib/ssh/doc/src/ssh_connection.xml
@@ -44,9 +44,9 @@
     If the receiving channel is an Erlang process, the
     messages have the format
     <c><![CDATA[{ssh_cm, connection_ref(), ssh_event_msg()}]]></c>.
-    If the <seealso marker="ssh_channel">ssh_channel</seealso> behavior is used to
+    If the <seealso marker="ssh_client_channel">ssh_client_channel</seealso> behavior is used to
     implement the channel process, these messages are handled by
-    <seealso marker="ssh_channel#Module:handle_ssh_msg-2">handle_ssh_msg/2</seealso>.</p>
+    <seealso marker="ssh_client_channel#Module:handle_ssh_msg-2">handle_ssh_msg/2</seealso>.</p>
   </description>
 
   <section>
@@ -131,7 +131,7 @@
 	<item><p>This event is sent as a result of calling
 	<seealso marker="ssh_connection#close-2">ssh_connection:close/2</seealso>.
 	Both the handling of this event and sending it are taken care of by the
-	<seealso marker="ssh_channel">ssh_channel</seealso> behavior.</p></item>
+	<seealso marker="ssh_client_channel">ssh_client_channel</seealso> behavior.</p></item>
 
       </taglist>
      </item>
@@ -212,10 +212,10 @@
 	<p>Adjusts the SSH flow control window. This is to be done by both the
 	client- and server-side channel processes.</p>
 	
-	<note><p>Channels implemented with the <seealso marker="ssh_channel"> ssh_channel</seealso>
+	<note><p>Channels implemented with the <seealso marker="ssh_client_channel"> ssh_client_channel</seealso>
 	behavior do not normally need to call this function as flow control
 	is handled by the behavior. The behavior adjusts the window every time
-	the callback <seealso marker="ssh_channel#Module:handle_ssh_msg-2">
+	the callback <seealso marker="ssh_client_channel#Module:handle_ssh_msg-2">
 	handle_ssh_msg/2</seealso> returns after processing channel data.</p></note>
       </desc>
    </func>
@@ -232,9 +232,9 @@
        sending a close event.
        </p>
 
-       <note><p>This function is called by the <c>ssh_channel</c>
+       <note><p>This function is called by the <c>ssh_client_channel</c>
        behavior when the channel is terminated, see <seealso
-       marker="ssh_channel"> ssh_channel(3)</seealso>. Thus, channels implemented
+       marker="ssh_client_channel"> ssh_client_channel(3)</seealso>. Thus, channels implemented
        with the behavior are not to call this function explicitly.</p></note>
      </desc>
    </func>
@@ -277,7 +277,7 @@
 
 	  <tag><c>1 x {ssh_cm, connection_ref(),
 	  {closed, channel_id()}}</c></tag>
-	  <item><p>Indicates that the <c>ssh_channel</c> started for the
+	  <item><p>Indicates that the <c>ssh_client_channel</c> started for the
 	  execution of the command has now been shut down.</p></item>
        </taglist>
      </desc>
diff --git a/lib/ssh/doc/src/ssh_daemon_channel.xml b/lib/ssh/doc/src/ssh_daemon_channel.xml
deleted file mode 100644
index 254f75a4de..0000000000
--- a/lib/ssh/doc/src/ssh_daemon_channel.xml
+++ /dev/null
@@ -1,52 +0,0 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE erlref SYSTEM "erlref.dtd">
-
-<erlref>
-  <header>
-    <copyright>
-      <year>2009</year>
-      <year>2016</year>
-      <holder>Ericsson AB, All Rights Reserved</holder>
-    </copyright>
-    <legalnotice>
-      Licensed under the Apache License, Version 2.0 (the "License");
-      you may not use this file except in compliance with the License.
-      You may obtain a copy of the License at
- 
-          http://www.apache.org/licenses/LICENSE-2.0
-
-      Unless required by applicable law or agreed to in writing, software
-      distributed under the License is distributed on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-      See the License for the specific language governing permissions and
-      limitations under the License.
-
-      The Initial Developer of the Original Code is Ericsson AB.
-    </legalnotice>
-    <title>ssh_daemon_channel</title>
-    <prepared></prepared>
-    <docno></docno>
-    <date></date>
-    <rev></rev>
-  </header>
-  <module>ssh_daemon_channel</module>
-  <modulesummary>-behaviour(ssh_daemon_channel).
-  </modulesummary>
-  <description>
-    <p>This behaviour should NOT be used for new programs but is kept for compatibility.
-    </p>
-    <p>It is replaced by <seealso marker="ssh_server_channel">ssh_server_channel</seealso>.</p>
-  </description>
-
-  <funcs>
-    <func>
-      <name>Module:CALLBACK(..)</name>
-      <fsummary>ssh_daemon_channel is replaced by ssh_server_channel</fsummary>
-      <desc>
-	<p>See <seealso marker="ssh_server_channel">ssh_server_channel</seealso> which replaces this module.
-	</p>
-      </desc>
-    </func>
-  </funcs>
-  
-</erlref>
diff --git a/lib/ssh/doc/src/ssh_protocol.xml b/lib/ssh/doc/src/ssh_protocol.xml
index 4548d7bbb6..53f0524b97 100644
--- a/lib/ssh/doc/src/ssh_protocol.xml
+++ b/lib/ssh/doc/src/ssh_protocol.xml
@@ -88,7 +88,7 @@
       SSH client will open a channel, send data/commands, receive
       data/"control information" and when it is done close the
       channel. The 
-      <seealso marker="ssh_channel">ssh_channel</seealso> / 
+      <seealso marker="ssh_client_channel">ssh_client_channel</seealso> / 
       <seealso marker="ssh_server_channel">ssh_server_channel</seealso> (Replaces ssh_daemon_channel)
       behaviours makes it easy to
       write your own SSH client/server processes that use flow
diff --git a/lib/ssh/doc/src/ssh_server_channel.xml b/lib/ssh/doc/src/ssh_server_channel.xml
index 19fc20fcda..af51ec470b 100644
--- a/lib/ssh/doc/src/ssh_server_channel.xml
+++ b/lib/ssh/doc/src/ssh_server_channel.xml
@@ -54,7 +54,7 @@
     </p>
 
     <note><p>When implementing a client subsystem handler, use
-    <seealso marker="ssh_channel">-behaviour(ssh_channel)</seealso> instead.
+    <seealso marker="ssh_client_channel">-behaviour(ssh_client_channel)</seealso> instead.
     </p>
     </note>
 
diff --git a/lib/ssh/doc/src/using_ssh.xml b/lib/ssh/doc/src/using_ssh.xml
index fef0784eb6..efd2a997f5 100644
--- a/lib/ssh/doc/src/using_ssh.xml
+++ b/lib/ssh/doc/src/using_ssh.xml
@@ -384,7 +384,7 @@ terminate(_Reason, _State) ->
    {ssh_msg, &lt;0.57.0>, {closed, 0}}
    7> {error, closed} = ssh_connection:send(ConnectionRef, ChannelId, "10", infinity).
  </code>
-<p>See also <seealso marker="ssh_channel"> ssh_channel(3)</seealso>.</p>
+<p>See also <seealso marker="ssh_client_channel">ssh_client_channel(3)</seealso> (replaces ssh_channel(3)).</p>
 
 </section>