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
|
<?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>
<head>
<title>Class: Net::SSH::Service::Shell::Shell</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" href="../../../../.././rdoc-style.css" type="text/css" media="screen" />
<script language="JavaScript" type="text/javascript">
// <![CDATA[
function toggleSource( id )
{
var elem
var link
if( document.getElementById )
{
elem = document.getElementById( id )
link = document.getElementById( "l_" + id )
}
else if ( document.all )
{
elem = eval( "document.all." + id )
link = eval( "document.all.l_" + id )
}
else
return false;
if( elem.style.display == "block" )
{
elem.style.display = "none"
link.innerHTML = "show source"
}
else
{
elem.style.display = "block"
link.innerHTML = "hide source"
}
}
function openCode( url )
{
window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
}
// ]]>
</script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
<td class="file-title"><span class="file-title-prefix">Class</span><br />Net::SSH::Service::Shell::Shell</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../../files/lib/net/ssh/service/shell/shell_rb.html">lib/net/ssh/service/shell/shell.rb</a>
</td>
</tr>
<tr>
<td>Parent:</td>
<td>
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div class="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 class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000284">method_missing</a></li>
<li><a href="#M000276">new</a></li>
<li><a href="#M000277">open?</a></li>
<li><a href="#M000282">send_data</a></li>
<li><a href="#M000283">send_extended_data</a></li>
<li><a href="#M000280">stderr</a></li>
<li><a href="#M000281">stderr?</a></li>
<li><a href="#M000278">stdout</a></li>
<li><a href="#M000279">stdout?</a></li>
</ul>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000276"></a><b>new</b>( connection, log, pty_opts )
</div>
<div class="description">
<p>
Create a <a href="Shell.html#M000276">new</a> shell over the given
connection. The <tt>pty_opts</tt> parameter must be either a Hash of the
allowed values for the Net::SSH::Connection::Channel#request_pty 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>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000276_source')" id="l_M000276_source">show source</a> ]</p>
<div id="M000276_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 37</span>
37: <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> )
38: <span class="ruby-ivar">@connection</span> = <span class="ruby-identifier">connection</span>
39: <span class="ruby-ivar">@log</span> = <span class="ruby-identifier">log</span>
40:
41: <span class="ruby-ivar">@pty_opts</span> = <span class="ruby-identifier">pty_opts</span>
42:
43: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
44: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
45:
46: <span class="ruby-ivar">@state</span> = <span class="ruby-identifier">:opening</span>
47: <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> ) )
48:
49: <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> }
50: <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>
51: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="sectiontitle">Public Instance methods</div>
<div class="method">
<div class="title">
<a name="M000284"></a><b>method_missing</b>( sym, *args )
</div>
<div class="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#M000282">send_data</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000284_source')" id="l_M000284_source">show source</a> ]</p>
<div id="M000284_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 113</span>
113: <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> )
114: <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">sym</span>.<span class="ruby-identifier">to_s</span>
115: <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>
116: <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>
117: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000277"></a><b>open?</b>()
</div>
<div class="description">
<p>
Returns <tt>true</tt> if the shell is open.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000277_source')" id="l_M000277_source">show source</a> ]</p>
<div id="M000277_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 54</span>
54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open?</span>
55: <span class="ruby-ivar">@state</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:open</span>
56: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000282"></a><b>send_data</b>( data )
</div>
<div class="description">
<p>
Sends the given data to the shell on the shell‘s stdin stream.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000282_source')" id="l_M000282_source">show source</a> ]</p>
<div id="M000282_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 97</span>
97: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_data</span>( <span class="ruby-identifier">data</span> )
98: <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>
99: <span class="ruby-ivar">@channel</span>.<span class="ruby-identifier">send_data</span> <span class="ruby-identifier">data</span>
100: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000283"></a><b>send_extended_data</b>( type, data )
</div>
<div class="description">
<p>
Sends the given data to the shell on the stream indicated by the
<tt>type</tt> parameter.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000283_source')" id="l_M000283_source">show source</a> ]</p>
<div id="M000283_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 104</span>
104: <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> )
105: <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>
106: <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>
107: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000280"></a><b>stderr</b>()
</div>
<div class="description">
<p>
Return the <a href="Shell.html#M000280">stderr</a> output (if any) that the
shell has generated since the last time this method was invoked.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000280_source')" id="l_M000280_source">show source</a> ]</p>
<div id="M000280_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 79</span>
79: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stderr</span>
80: <span class="ruby-identifier">string</span>, <span class="ruby-ivar">@stderr</span> = <span class="ruby-ivar">@stderr</span>, <span class="ruby-value str">""</span>
81: <span class="ruby-identifier">string</span>
82: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000281"></a><b>stderr?</b>()
</div>
<div class="description">
<p>
Returns <tt>true</tt> if there is any data from the shell on <a
href="Shell.html#M000280">stderr</a>, consuming input on the connection in
a non-blocking manner to make sure that any available data is considered.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000281_source')" id="l_M000281_source">show source</a> ]</p>
<div id="M000281_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 87</span>
87: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stderr?</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">unless</span> <span class="ruby-identifier">exists</span>
90: <span class="ruby-identifier">consume_connection</span>
91: <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>
92: <span class="ruby-keyword kw">end</span>
93: <span class="ruby-identifier">exists</span>
94: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000278"></a><b>stdout</b>()
</div>
<div class="description">
<p>
Return the <a href="Shell.html#M000278">stdout</a> output (if any) that the
shell has generated since the last time this method was invoked.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000278_source')" id="l_M000278_source">show source</a> ]</p>
<div id="M000278_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 60</span>
60: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stdout</span>
61: <span class="ruby-identifier">string</span>, <span class="ruby-ivar">@stdout</span> = <span class="ruby-ivar">@stdout</span>, <span class="ruby-value str">""</span>
62: <span class="ruby-identifier">string</span>
63: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000279"></a><b>stdout?</b>()
</div>
<div class="description">
<p>
Returns <tt>true</tt> if there is any data from the shell on <a
href="Shell.html#M000278">stdout</a>, consuming input on the connection in
a non-blocking manner to make sure that any available data is considered.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000279_source')" id="l_M000279_source">show source</a> ]</p>
<div id="M000279_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/shell.rb, line 68</span>
68: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stdout?</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">unless</span> <span class="ruby-identifier">exists</span>
71: <span class="ruby-identifier">consume_connection</span>
72: <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>
73: <span class="ruby-keyword kw">end</span>
74: <span class="ruby-identifier">exists</span>
75: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
