aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssh/doc/src/ssh_channel.xml
blob: 342de97a1b62e94462f2b50487e656d9d797bf00 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<erlref>
  <header>
    <copyright>
      <year>2009</year>
      <year>2012</year>
      <holder>Ericsson AB, All Rights Reserved</holder>
    </copyright>
    <legalnotice>
      The contents of this file are subject to the Erlang Public License,
      Version 1.1, (the "License"); you may not use this file except in
      compliance with the License. You should have received a copy of the
      Erlang Public License along with this software. If not, it can be
      retrieved online at http://www.erlang.org/.

      Software distributed under the License is distributed on an "AS IS"
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      the License for the specific language governing rights and limitations
      under the License.

      The Initial Developer of the Original Code is Ericsson AB.
    </legalnotice>
    <title>ssh_channel</title>
  </header>
  <module>ssh_channel</module>
  <modulesummary>Generic Ssh Channel Behavior
  </modulesummary>
  <description>
    <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
    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
    that the channel process honors the principal of an OTP-process so
    that it can be part of a supervisor tree. This is a requirement of
    channel processes implementing a subsystem that will be added to
    the SSH applications supervisor tree.
    </p>

    <p>The functions init/1, terminate/2, handle_ssh_msg/2 and
    handle_msg/2 are the functions that are required
    to provide the implementation for a server side channel, such as
    an SSH subsystem channel that can be plugged into the Erlang ssh
    daemon see <seealso marker="ssh#daemon-3">ssh:daemon/[2,
    3]</seealso>.
    The handle_call/3, handle_cast/2, code_change/3 and enter_loop/1
    functions are only relevant when implementing a client side
    channel.</p>
  </description>

  <section>
    <title>DATA TYPES </title>

    <p>Type definitions that are used more than once in this module
    and/or abstractions to indicate the intended use of the data
    type:</p>
    
    <p><c>boolean() = true | false </c></p>
    <p><c>string() = list of ASCII characters</c></p>
    <p><c>timeout() =  infinity | integer() - in milliseconds.</c></p>
    <p><c>ssh_connection_ref() - opaque to the user returned by
    ssh:connect/3 or sent to an SSH channel process</c></p>
    <p><c>ssh_channel_id() = integer() </c></p>
    <p><c>ssh_data_type_code() = 1 ("stderr") | 0 ("normal") are
    currently valid values see <url href="http://www.ietf.org/rfc/rfc4254.txt">RFC 4254  </url> section 5.2.</c></p>
  </section>

  <funcs>
    <func>
      <name>call(ChannelRef, Msg) -></name>
      <name>call(ChannelRef, Msg, timeout()) -> Reply | {error, Reason}</name>
      <fsummary> Makes a synchronous call to a channel.</fsummary>
      <type>
	<v>ChannelRef = pid() </v>
	<d>As returned by start_link/4 </d>
	<v>Msg = term() </v>
	<v>Reply = term() </v>
	<v>Reason = closed | timeout </v>
      </type>
      <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 =
	"#CallbackModule:handle_call-3">CallbackModule:handle_call/3</seealso>
	to handle the message.  If the channel process does not exist
	<c>{error, closed}</c> is returned.
	</p>
      </desc>
    </func>
    
    <func>
      <name>cast(ChannelRef, Msg) -> ok </name>
      <fsummary>Sends an asynchronous message to the channel
	ChannelRef and returns ok.</fsummary>
      <type>
	<v>ChannelRef = pid() </v>
	<d>As returned by start_link/4 </d>
	<v>Msg = term() </v>
      </type>
      <desc>
	<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 = "#CallbackModule:handle_cast-3">CallbackModule:handle_cast/2</seealso>
	 to handle the message.
	</p>
      </desc>
    </func>

       <func>
      <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>
      </type>
      <desc>
	<p> Makes an existing process an <c>ssh_channel</c>
	process. Does not return, instead the calling process will
	enter the <c>ssh_channel</c> process receive loop and become an
	<c>ssh_channel process.</c> The process must have been started using
	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>
	</p>
      </desc>
    </func>
    
    <func>
      <name>init(Options) -> {ok, State} |  {ok, State, timeout()} | {stop, Reason} </name>
      <fsummary> Initiates a ssh_channel process.</fsummary>
      <type>
	<v> Options = [{Option, Value}]</v>
      </type>
      <desc>
	<p>
	  The following options must be present:
	</p>
	  <taglist>
	  <tag><c><![CDATA[{channel_cb, atom()}]]></c></tag>
	  <item>The module that implements the channel behaviour.</item>
	  
	  <tag><c><![CDATA[{init_args(), list()}]]></c></tag>
	  <item> The list of arguments to the callback module's
	  init function.</item>

	  <tag><c><![CDATA[{cm, connection_ref()}]]></c></tag>
	  <item> Reference to the ssh connection as returned by  <seealso
	  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>
	  
	  </taglist>

	  <note><p>This function is normally not called by the
	  user. The user only needs to call if for some reason the
	  channel process needs to be started with help of
	  <c>proc_lib</c> instead of calling
	  <c>ssh_channel:start/4</c> or
	  <c>ssh_channel:start_link/4</c> </p>
	  </note>
      </desc>
    </func>

    <func>
      <name>reply(Client, Reply) -> _</name>
      <fsummary>Send a reply to a client.</fsummary>
      <type>
        <v>Client - opaque to the user, see explanation below</v>
        <v>Reply = term()</v>
      </type>
      <desc>
        <p>This function can be used by a channel to explicitly send a
        reply to a client that called <c>call/[2,3]</c> when the reply
        cannot be defined in the return value of
	<seealso marker ="#CallbackModule:handle_call-3">CallbackModule:handle_call/3</seealso>.</p>
        <p><c>Client</c> must be the <c>From</c> argument provided to
          the callback function <c>handle_call/3</c>.
	  <c>Reply</c> is an arbitrary term,
	  which will be given back to the client as the return value of
          <seealso marker="#call-2">ssh_channel:call/[2,3].</seealso>></p>
      </desc>
    </func>
    
    <func>
      <name>start(SshConnection, ChannelId, ChannelCb, CbInitArgs) -> </name>
      <name>start_link(SshConnection, ChannelId, ChannelCb, CbInitArgs) ->
      {ok, ChannelRef} | {error, Reason}</name>
      <fsummary> Starts a processes that handles a SSH channel. </fsummary>
      <type>
	<v>SshConnection = ssh_connection_ref()</v>
	<v>ChannelId = ssh_channel_id() </v>
	<d> As returned by cannot be defined in the return value of
	<seealso marker ="ssh_connection#session_channel/2">ssh_connection:session_channel/[2,4]</seealso></d>
	<v>ChannelCb = atom()</v>
	<d> The name of the module implementing the service specific parts
	of the channel.</d>
	<v>CbInitArgs = [term()]</v>
	<d>Argument  list for the init function in the callback module. </d>
	<v>ChannelRef = pid()</v>
      </type>
      <desc>
	<p>Starts a processes that handles an SSH channel. It will be
	called internally by the SSH daemon or explicitly by the SSH
	client implementations. The behavior will set the
	<c>trap_exit</c> flag to true.
	</p>
      </desc>
    </func>
    
  </funcs>
  
  <section>
    <marker id="cb_timeouts"></marker>
    <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 timout occurs <seealso marker="#handle_msg">handle_msg/2</seealso>
    will be called as <c>handle_msg(timeout, State). </c></p>
  </section>

  <funcs>
    <func>
      <name>CallbackModule:code_change(OldVsn, State, Extra) -> {ok,
      NewState}</name>
      <fsummary> Converts process state when code is changed.</fsummary>
      <type>
	<v> Converts process state when code is changed.</v>
      </type>
      <desc>
	  <p>This function is called by a client side channel when it
	  should update its internal state during a release
	  upgrade/downgrade, i.e. when the instruction
	  <c>{update,Module,Change,...}</c> where
	  <c>Change={advanced,Extra}</c> is given in the <c>appup</c>
	  file. See <seealso marker="doc/design_principles:release_handling#instr">OTP
	  Design Principles</seealso> for more information.
	  </p>

	  <note><p>Soft upgrade according to the OTP release concept
	  is not straight forward for the server side, as subsystem
	  channel processes are spawned by the SSH application and
	  hence added to its supervisor tree. It could be possible to
	  upgrade the subsystem channels, when upgrading the user
	  application, if the callback functions can handle two
	  versions of the state, but this function can not be used in
	  the normal way.</p>
	  </note>
	  
        <p>In the case of an upgrade, <c>OldVsn</c> is <c>Vsn</c>, and
          in the case of a downgrade, <c>OldVsn</c> is
          <c>{down,Vsn}</c>. <c>Vsn</c> is defined by the <c>vsn</c>
          attribute(s) of the old version of the callback module
          <c>Module</c>. If no such attribute is defined, the version
          is the checksum of the BEAM file.</p>
        <p><c>State</c> is the internal state of the channel.</p>
        <p><c>Extra</c> is passed as-is from the <c>{advanced,Extra}</c>
          part of the update instruction.</p>
        <p>The function should return the updated internal state.</p>
      </desc>
    </func>
    
    <func>
      <name>CallbackModule:init(Args) -> {ok, State} | {ok, State, timeout()} |
      {stop, Reason}</name>
      <fsummary> Makes necessary initializations and returns the
      initial channel state if the initializations succeed.</fsummary>
      <type>
	<v> Args = term() </v>
	<d> Last argument to ssh_channel:start_link/4.</d>
	<v> State = term() </v>
	<v> Reason = term() </v>
      </type>
      <desc>
	<p> Makes necessary initializations and returns the initial channel
	state if the initializations succeed.
	</p>
	<p>For more detailed information on timeouts see the section 
	<seealso marker="#cb_timeouts">CALLBACK TIMEOUTS</seealso>. </p>
      </desc>
    </func>
   
    <func>
      <name>CallbackModule:handle_call(Msg, From, State) -> Result</name>
      <fsummary> Handles messages sent by calling
      <c>ssh_channel:call/[2,3]</c></fsummary>
      <type>
	<v>Msg = term()</v>
	<v>From = opaque to the user should be used as argument to
	ssh_channel:reply/2</v>
	<v>State = term()</v>
	<v>Result = {reply, Reply, NewState} | {reply, Reply, NewState, timeout()}
	| {noreply, NewState} | {noreply , NewState, timeout()}
	| {stop, Reason, Reply, NewState} | {stop, Reason, NewState} </v>
	<v>Reply = term() - will be the return value of ssh_channel:call/[2,3]</v>
	<v>NewState = term()</v>
	<v>Reason = term()</v>
      </type>
      <desc>
	<p>Handles messages sent by calling
	<seealso marker="#call-2">ssh_channel:call/[2,3]</seealso>
	</p>
	<p>For more detailed information on timeouts see the section 
	<seealso marker="#cb_timeouts">CALLBACK TIMEOUTS</seealso>. </p>
      </desc>
    </func>

    <func>
      <name>CallbackModule:handle_cast(Msg, State) -> Result</name>
      <fsummary> Handles messages sent by calling
      <c>ssh_channel:cact/2</c></fsummary>
      <type>
	<v>Msg = term()</v>
	<v>State = term()</v>
	<v>Result = {noreply, NewState} | {noreply, NewState, timeout()}
	| {stop, Reason, NewState}</v>
	<v>NewState = term() </v>
	<v>Reason = term()</v>
      </type>
      <desc>
	<p> Handles messages sent by calling
	<c>ssh_channel:cast/2</c>
	</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>
 
    <func>
      <name>CallbackModule:handle_msg(Msg, State) -> {ok, State} |
      {stop, ChannelId, State}</name>

      <fsummary> Handle other messages than ssh connection protocol,
      call or cast messages sent to the channel.</fsummary>
      <type>
	<v>Msg = timeout | term()</v>
	<v>State = term() </v>
      </type>
      <desc>
	<p>Handle other messages than ssh connection protocol, call or
	cast messages sent to the channel. 
	</p>

	<p> Possible erlang 'EXIT'-messages should be handled by this
	function and all channels should handle the following message.</p>
	
	<taglist>
	  <tag><c><![CDATA[{ssh_channel_up, ssh_channel_id(), 
	  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
	  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
	  useful for your particular scenario just ignore it by
	  immediately returning {ok, State}.
	  </item>
	</taglist>
      </desc>
    </func>

    <func>
      <name>CallbackModule:handle_ssh_msg(Msg, State) -> {ok, State} | {stop,
      ssh_channel_id(), State}</name>
      <fsummary> Handles ssh connection protocol messages. </fsummary>
      <type>
	<v>Msg = <seealso marker="ssh_connection"> ssh_connection:event() </seealso> </v>
	<v>State = term()</v>
      </type>
      <desc>
	<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>
	
	<taglist>
	  <tag><c><![CDATA[{closed, ssh_channel_id()}]]></c></tag>
	  <item> The channel behavior will send a close message to the
	  other side if such a message has not already been sent and
	  then terminate the channel with reason normal.</item>
	</taglist>
      </desc>
    </func>

    <func>
      <name>CallbackModule:terminate(Reason, State) -> _</name>
      <fsummary> </fsummary>
      <type>
	<v>Reason = term()</v>
	<v>State = term()</v>
      </type>
      <desc>
	<p>This function is called by a channel process when it is
	about to terminate. Before this function is called <seealso
	marker="ssh_connection#close-2"> ssh_connection:close/2
	</seealso> will be called if it has not been called earlier.
	This function should do any necessary cleaning
	up. When it returns, the channel process terminates with
	reason <c>Reason</c>. The return value is ignored.
	</p>
      </desc>
    </func>
    
  </funcs>
  
</erlref>