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 html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: Net::SSH::Service::Shell::Shell</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Net::SSH::Service::Shell::Shell</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../../../files/lib/net/ssh/service/shell/shell_rb.html">
lib/net/ssh/service/shell/shell.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
A service class for interacting with a user’s shell on a remote
machine. The shell may be interacted with either with or without a pty.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000273">method_missing</a>
<a href="#M000265">new</a>
<a href="#M000266">open?</a>
<a href="#M000271">send_data</a>
<a href="#M000272">send_extended_data</a>
<a href="#M000269">stderr</a>
<a href="#M000270">stderr?</a>
<a href="#M000267">stdout</a>
<a href="#M000268">stdout?</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000265" class="method-detail">
<a name="M000265"></a>
<div class="method-heading">
<a href="#M000265" class="method-signature">
<span class="method-name">new</span><span class="method-args">( connection, log, pty_opts )</span>
</a>
</div>
<div class="method-description">
<p>
Create a new shell over the given connection. The <tt>pty_opts</tt>
parameter must be either a Hash of the allowed values for the <a
href="../../Connection/Channel.html#M000193">Net::SSH::Connection::Channel#request_pty</a>
method, or a boolean value (indicating whether a pty should be allocated or
not). This will block until the shell is open and ready to receive input.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000265-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000265-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 34</span>
34: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">connection</span>, <span class="ruby-identifier">log</span>, <span class="ruby-identifier">pty_opts</span> )
35: <span class="ruby-ivar">@connection</span> = <span class="ruby-identifier">connection</span>
36: <span class="ruby-ivar">@log</span> = <span class="ruby-identifier">log</span>
37:
38: <span class="ruby-ivar">@pty_opts</span> = <span class="ruby-identifier">pty_opts</span>
39:
40: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
41: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
42:
43: <span class="ruby-ivar">@state</span> = <span class="ruby-identifier">:opening</span>
44: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">open_channel</span>( <span class="ruby-value str">"session"</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">method</span>( <span class="ruby-identifier">:on_confirm</span> ) )
45:
46: <span class="ruby-ivar">@connection</span>.<span class="ruby-identifier">loop</span> { <span class="ruby-ivar">@state</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">:open</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@state</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">:closed</span> }
47: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"could not open shell"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@state</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">:open</span>
48: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000273" class="method-detail">
<a name="M000273"></a>
<div class="method-heading">
<a href="#M000273" class="method-signature">
<span class="method-name">method_missing</span><span class="method-args">( sym, *args )</span>
</a>
</div>
<div class="method-description">
<p>
Reinterprets method invocations as requests to send data to the shell. The
method name and the arguments are concatenated together with spaces and a
newline appended. The resulting string is sent to the shell via <a
href="Shell.html#M000271">send_data</a>.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000273-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000273-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 110</span>
110: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>( <span class="ruby-identifier">sym</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
111: <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">sym</span>.<span class="ruby-identifier">to_s</span>
112: <span class="ruby-identifier">cmd</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" "</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">join</span>( <span class="ruby-value str">" "</span> ) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
113: <span class="ruby-identifier">send_data</span> <span class="ruby-identifier">cmd</span> <span class="ruby-operator">+</span> <span class="ruby-value str">"\n"</span>
114: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000266" class="method-detail">
<a name="M000266"></a>
<div class="method-heading">
<a href="#M000266" class="method-signature">
<span class="method-name">open?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns <tt>true</tt> if the shell is open.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000266-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000266-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 51</span>
51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open?</span>
52: <span class="ruby-ivar">@state</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:open</span>
53: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000271" class="method-detail">
<a name="M000271"></a>
<div class="method-heading">
<a href="#M000271" class="method-signature">
<span class="method-name">send_data</span><span class="method-args">( data )</span>
</a>
</div>
<div class="method-description">
<p>
Sends the given data to the shell on the shell’s stdin stream.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000271-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000271-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 94</span>
94: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_data</span>( <span class="ruby-identifier">data</span> )
95: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"channel not open"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@state</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:open</span>
96: <span class="ruby-ivar">@channel</span>.<span class="ruby-identifier">send_data</span> <span class="ruby-identifier">data</span>
97: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000272" class="method-detail">
<a name="M000272"></a>
<div class="method-heading">
<a href="#M000272" class="method-signature">
<span class="method-name">send_extended_data</span><span class="method-args">( type, data )</span>
</a>
</div>
<div class="method-description">
<p>
Sends the given data to the shell on the stream indicated by the
<tt>type</tt> parameter.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000272-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000272-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 101</span>
101: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_extended_data</span>( <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span> )
102: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"channel not open"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@state</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:open</span>
103: <span class="ruby-ivar">@channel</span>.<span class="ruby-identifier">send_extended_data</span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span>
104: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000269" class="method-detail">
<a name="M000269"></a>
<div class="method-heading">
<a href="#M000269" class="method-signature">
<span class="method-name">stderr</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Return the stderr output (if any) that the shell has generated since the
last time this method was invoked.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000269-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000269-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 76</span>
76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stderr</span>
77: <span class="ruby-identifier">string</span>, <span class="ruby-ivar">@stderr</span> = <span class="ruby-ivar">@stderr</span>, <span class="ruby-value str">""</span>
78: <span class="ruby-identifier">string</span>
79: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000270" class="method-detail">
<a name="M000270"></a>
<div class="method-heading">
<a href="#M000270" class="method-signature">
<span class="method-name">stderr?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns <tt>true</tt> if there is any data from the shell on stderr,
consuming input on the connection in a non-blocking manner to make sure
that any available data is considered.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000270-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000270-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 84</span>
84: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stderr?</span>
85: <span class="ruby-identifier">exists</span> = <span class="ruby-ivar">@stderr</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
86: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">exists</span>
87: <span class="ruby-identifier">consume_connection</span>
88: <span class="ruby-identifier">exists</span> = <span class="ruby-ivar">@stderr</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
89: <span class="ruby-keyword kw">end</span>
90: <span class="ruby-identifier">exists</span>
91: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000267" class="method-detail">
<a name="M000267"></a>
<div class="method-heading">
<a href="#M000267" class="method-signature">
<span class="method-name">stdout</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Return the stdout output (if any) that the shell has generated since the
last time this method was invoked.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000267-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000267-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 57</span>
57: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stdout</span>
58: <span class="ruby-identifier">string</span>, <span class="ruby-ivar">@stdout</span> = <span class="ruby-ivar">@stdout</span>, <span class="ruby-value str">""</span>
59: <span class="ruby-identifier">string</span>
60: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000268" class="method-detail">
<a name="M000268"></a>
<div class="method-heading">
<a href="#M000268" class="method-signature">
<span class="method-name">stdout?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns <tt>true</tt> if there is any data from the shell on stdout,
consuming input on the connection in a non-blocking manner to make sure
that any available data is considered.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000268-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000268-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 65</span>
65: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stdout?</span>
66: <span class="ruby-identifier">exists</span> = <span class="ruby-ivar">@stdout</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
67: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">exists</span>
68: <span class="ruby-identifier">consume_connection</span>
69: <span class="ruby-identifier">exists</span> = <span class="ruby-ivar">@stdout</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
70: <span class="ruby-keyword kw">end</span>
71: <span class="ruby-identifier">exists</span>
72: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
