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
|
<?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::SyncShell</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::SyncShell</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../../files/lib/net/ssh/service/shell/sync_rb.html">lib/net/ssh/service/shell/sync.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 version of <a href="../Shell.html">Shell::Shell</a> that acts
synchronously, allowing clients to execute a command via a shell, wait for
it to finish, and then inspect both the stdout and stderr from the command,
as well as the exit status.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000293">method_missing</a></li>
<li><a href="#M000288">new</a></li>
<li><a href="#M000289">open?</a></li>
<li><a href="#M000290">send_command</a></li>
<li><a href="#M000291">send_data</a></li>
<li><a href="#M000292">send_extended_data</a></li>
</ul>
<div class="sectiontitle">Constants</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class="attr-name">CommandOutput</td>
<td>=</td>
<td class="attr-value">Struct.new( :stdout, :stderr, :status )</td>
</tr>
<tr valign='top'>
<td> </td>
<td colspan="2" class="attr-desc">
A struct representing the result of executing a command.
</td>
</tr>
<tr valign='top'>
<td class="attr-name">CONFIRMATION</td>
<td>=</td>
<td class="attr-value">"2357foobarbazzabraboof7532"</td>
</tr>
<tr valign='top'>
<td> </td>
<td colspan="2" class="attr-desc">
The unique confirmation string that is used to recognize the end of a
command‘s execution.
</td>
</tr>
</table>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000288"></a><b>new</b>( shell, log, pty_opts )
</div>
<div class="description">
<p>
Create a <a href="SyncShell.html#M000288">new</a> <a
href="SyncShell.html">SyncShell</a> that uses the given <tt>shell</tt>
factory to obtain a shell to wrap. The other parameters are used
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000288_source')" id="l_M000288_source">show source</a> ]</p>
<div id="M000288_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/sync.rb, line 39</span>
39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">shell</span>, <span class="ruby-identifier">log</span>, <span class="ruby-identifier">pty_opts</span> )
40: <span class="ruby-ivar">@log</span> = <span class="ruby-identifier">log</span>
41: <span class="ruby-ivar">@shell</span> = <span class="ruby-identifier">shell</span>.<span class="ruby-identifier">call</span>( <span class="ruby-identifier">pty_opts</span> )
42: <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="M000293"></a><b>method_missing</b>( sym, *args )
</div>
<div class="description">
<p>
Reinterprets missing methods as requests to execute commands. The
parameters to the method are concatenated together with spaces and sent to
the shell via <a href="SyncShell.html#M000290">send_command</a>.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000293_source')" id="l_M000293_source">show source</a> ]</p>
<div id="M000293_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/sync.rb, line 103</span>
103: <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> )
104: <span class="ruby-identifier">cmd</span> = <span class="ruby-identifier">sym</span>.<span class="ruby-identifier">to_s</span>
105: <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>
106: <span class="ruby-identifier">send_command</span> <span class="ruby-identifier">cmd</span>
107: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000289"></a><b>open?</b>()
</div>
<div class="description">
<p>
Delegates to Shell::Shell.open?
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000289_source')" id="l_M000289_source">show source</a> ]</p>
<div id="M000289_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/sync.rb, line 45</span>
45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open?</span>
46: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">open?</span>
47: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000290"></a><b>send_command</b>( cmd, stdin=nil )
</div>
<div class="description">
<p>
Attempts to invoke the given command, which must not be terminated with a
newline. If <tt>stdin</tt> is not nil, it will be sent to the shell
immediately after sending the request to execute the command. It is
expected that this will be used by the program that was just executed
somehow, but this is not (cannot) be enforced.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000290_source')" id="l_M000290_source">show source</a> ]</p>
<div id="M000290_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/sync.rb, line 54</span>
54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_command</span>( <span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">stdin</span>=<span class="ruby-keyword kw">nil</span> )
55: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"executing #{cmd.inspect}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug?</span>
56: <span class="ruby-identifier">send_data</span> <span class="ruby-node">"#{cmd}; printf '%s %d' #{CONFIRMATION} $?\n"</span>
57: <span class="ruby-identifier">send_data</span> <span class="ruby-identifier">stdin</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">stdin</span>
58:
59: <span class="ruby-identifier">out</span> = <span class="ruby-value str">""</span>
60: <span class="ruby-identifier">err</span> = <span class="ruby-value str">""</span>
61:
62: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"waiting for #{cmd.inspect}"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug?</span>
63: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
64: <span class="ruby-identifier">sleep</span> <span class="ruby-value">0</span><span class="ruby-value">.01</span>
65: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">stdout</span> <span class="ruby-keyword kw">while</span> <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">open?</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">stdout?</span>
66: <span class="ruby-identifier">err</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">stderr</span> <span class="ruby-keyword kw">while</span> <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">open?</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">stderr?</span>
67:
68: <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">open?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">out</span>.<span class="ruby-identifier">index</span>( <span class="ruby-constant">CONFIRMATION</span> <span class="ruby-operator">+</span> <span class="ruby-value str">" "</span> )
69: <span class="ruby-keyword kw">end</span>
70:
71: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug?</span>
72: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"#{cmd.inspect} finished"</span>
73: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">" stdout --> #{out.inspect}"</span>
74: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">" stderr --> #{err.inspect}"</span>
75: <span class="ruby-keyword kw">end</span>
76:
77: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">open?</span>
78: <span class="ruby-identifier">match</span> = <span class="ruby-identifier">out</span>.<span class="ruby-identifier">match</span>( <span class="ruby-node">/#{CONFIRMATION} /o</span> )
79: <span class="ruby-identifier">out</span> = <span class="ruby-identifier">match</span>.<span class="ruby-identifier">pre_match</span>
80: <span class="ruby-identifier">status</span> = <span class="ruby-identifier">match</span>.<span class="ruby-identifier">post_match</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">to_i</span>
81: <span class="ruby-keyword kw">else</span>
82: <span class="ruby-identifier">status</span> = <span class="ruby-value">0</span>
83: <span class="ruby-keyword kw">end</span>
84:
85: <span class="ruby-constant">CommandOutput</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">out</span>, ( <span class="ruby-identifier">err</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">err</span> ), <span class="ruby-identifier">status</span> )
86: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000291"></a><b>send_data</b>( data )
</div>
<div class="description">
<p>
Sends the given string directly to the shell, without waiting for any
response.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000291_source')" id="l_M000291_source">show source</a> ]</p>
<div id="M000291_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/sync.rb, line 90</span>
90: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">send_data</span>( <span class="ruby-identifier">data</span> )
91: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">send_data</span> <span class="ruby-identifier">data</span>
92: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000292"></a><b>send_extended_data</b>( type, data )
</div>
<div class="description">
<p>
Dends the given string directly to the shell as the given type of data,
without waiting for any response.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000292_source')" id="l_M000292_source">show source</a> ]</p>
<div id="M000292_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/shell/sync.rb, line 96</span>
96: <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> )
97: <span class="ruby-ivar">@shell</span>.<span class="ruby-identifier">send_extended_data</span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span>
98: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
