net-ssh-simple 1.6.0 → 1.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +0 -1
- data/README.rdoc +9 -9
- data/coverage/.last_run.json +5 -0
- data/coverage/.resultset.json +771 -0
- data/coverage/assets/0.7.1/application.css +1110 -0
- data/coverage/assets/0.7.1/application.js +626 -0
- data/coverage/assets/0.7.1/fancybox/blank.gif +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_close.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_loading.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_nav_left.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_nav_right.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_e.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_n.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_ne.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_nw.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_s.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_se.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_sw.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_shadow_w.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_title_left.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_title_main.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_title_over.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancy_title_right.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancybox-x.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancybox-y.png +0 -0
- data/coverage/assets/0.7.1/fancybox/fancybox.png +0 -0
- data/coverage/assets/0.7.1/favicon_green.png +0 -0
- data/coverage/assets/0.7.1/favicon_red.png +0 -0
- data/coverage/assets/0.7.1/favicon_yellow.png +0 -0
- data/coverage/assets/0.7.1/loading.gif +0 -0
- data/coverage/assets/0.7.1/magnify.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-icons_222222_256x240.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-icons_454545_256x240.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-icons_888888_256x240.png +0 -0
- data/coverage/assets/0.7.1/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
- data/coverage/index.html +4672 -0
- data/doc/Net.html +117 -0
- data/doc/Net/SSH.html +117 -0
- data/doc/Net/SSH/Simple.html +2984 -0
- data/doc/Net/SSH/Simple/Error.html +432 -0
- data/doc/Net/SSH/Simple/Result.html +1640 -0
- data/doc/_index.html +162 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +328 -0
- data/doc/file.README.html +258 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +258 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +348 -0
- data/doc/methods_list.html +212 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/net/ssh/simple.rb +6 -0
- data/lib/net/ssh/simple/version.rb +1 -1
- data/net-ssh-simple.gemspec +1 -1
- metadata +125 -22
|
@@ -0,0 +1,432 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Exception: Net::SSH::Simple::Error
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.3
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '../../../';
|
|
20
|
+
framesUrl = "../../../frames.html#!" + escape(window.location.href);
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="../../../_index.html">Index (E)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../../../Net.html" title="Net (module)">Net</a></span></span> » <span class='title'><span class='object_link'><a href="../../SSH.html" title="Net::SSH (module)">SSH</a></span></span> » <span class='title'><span class='object_link'><a href="../Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Error</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../../../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../../../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../../../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Exception: Net::SSH::Simple::Error
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">RuntimeError</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">RuntimeError</li>
|
|
82
|
+
|
|
83
|
+
<li class="next">Net::SSH::Simple::Error</li>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
87
|
+
|
|
88
|
+
</dd>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<dt class="r2 last">Defined in:</dt>
|
|
99
|
+
<dd class="r2 last">lib/net/ssh/simple.rb</dd>
|
|
100
|
+
|
|
101
|
+
</dl>
|
|
102
|
+
<div class="clear"></div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>Error that occured during a Net::SSH::Simple operation.</p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
120
|
+
<ul class="summary">
|
|
121
|
+
|
|
122
|
+
<li class="public ">
|
|
123
|
+
<span class="summary_signature">
|
|
124
|
+
|
|
125
|
+
<a href="#result-instance_method" title="#result (instance method)">- (Object) <strong>result</strong> </a>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</span>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
<span class="note title readonly">readonly</span>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<span class="summary_desc"><div class='inline'>
|
|
145
|
+
<p><span class='object_link'><a href="Result.html" title="Net::SSH::Simple::Result (class)">Result</a></span> of the interrupted operation.</p>
|
|
146
|
+
</div></span>
|
|
147
|
+
|
|
148
|
+
</li>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
<li class="public ">
|
|
152
|
+
<span class="summary_signature">
|
|
153
|
+
|
|
154
|
+
<a href="#wrapped-instance_method" title="#wrapped (instance method)">- (Object) <strong>wrapped</strong> </a>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
</span>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<span class="note title readonly">readonly</span>
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<span class="summary_desc"><div class='inline'>
|
|
174
|
+
<p>Reference to the underlying Exception.</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<h2>
|
|
187
|
+
Instance Method Summary
|
|
188
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
189
|
+
</h2>
|
|
190
|
+
|
|
191
|
+
<ul class="summary">
|
|
192
|
+
|
|
193
|
+
<li class="public ">
|
|
194
|
+
<span class="summary_signature">
|
|
195
|
+
|
|
196
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Error) <strong>initialize</strong>(msg, e = $!) </a>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<span class="note title constructor">constructor</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span class="summary_desc"><div class='inline'>
|
|
213
|
+
<p>A new instance of Error.</p>
|
|
214
|
+
</div></span>
|
|
215
|
+
|
|
216
|
+
</li>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<li class="public ">
|
|
220
|
+
<span class="summary_signature">
|
|
221
|
+
|
|
222
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
</span>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
237
|
+
|
|
238
|
+
</li>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
</ul>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<div id="constructor_details" class="method_details_list">
|
|
246
|
+
<h2>Constructor Details</h2>
|
|
247
|
+
|
|
248
|
+
<div class="method_details first">
|
|
249
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
250
|
+
|
|
251
|
+
- (<tt><span class='object_link'><a href="" title="Net::SSH::Simple::Error (class)">Error</a></span></tt>) <strong>initialize</strong>(msg, e = $!)
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</h3><div class="docstring">
|
|
258
|
+
<div class="discussion">
|
|
259
|
+
|
|
260
|
+
<p>A new instance of Error</p>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
</div>
|
|
264
|
+
</div>
|
|
265
|
+
<div class="tags">
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
</div><table class="source_code">
|
|
269
|
+
<tr>
|
|
270
|
+
<td>
|
|
271
|
+
<pre class="lines">
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
707
|
|
275
|
+
708
|
|
276
|
+
709
|
|
277
|
+
710
|
|
278
|
+
711</pre>
|
|
279
|
+
</td>
|
|
280
|
+
<td>
|
|
281
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 707</span>
|
|
282
|
+
|
|
283
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span><span class='op'>=</span><span class='gvar'>$!</span><span class='rparen'>)</span>
|
|
284
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
|
|
285
|
+
<span class='ivar'>@wrapped</span> <span class='op'>=</span> <span class='id identifier rubyid_e'>e</span>
|
|
286
|
+
<span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_msg'>msg</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
|
|
287
|
+
<span class='kw'>end</span></pre>
|
|
288
|
+
</td>
|
|
289
|
+
</tr>
|
|
290
|
+
</table>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
<div id="instance_attr_details" class="attr_details">
|
|
296
|
+
<h2>Instance Attribute Details</h2>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<span id=""></span>
|
|
300
|
+
<div class="method_details first">
|
|
301
|
+
<h3 class="signature first" id="result-instance_method">
|
|
302
|
+
|
|
303
|
+
- (<tt>Object</tt>) <strong>result</strong> <span class="extras">(readonly)</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
</h3><div class="docstring">
|
|
310
|
+
<div class="discussion">
|
|
311
|
+
|
|
312
|
+
<p><span class='object_link'><a href="Result.html" title="Net::SSH::Simple::Result (class)">Result</a></span> of the interrupted operation.</p>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
</div>
|
|
316
|
+
</div>
|
|
317
|
+
<div class="tags">
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
</div><table class="source_code">
|
|
321
|
+
<tr>
|
|
322
|
+
<td>
|
|
323
|
+
<pre class="lines">
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
705
|
|
327
|
+
706
|
|
328
|
+
707</pre>
|
|
329
|
+
</td>
|
|
330
|
+
<td>
|
|
331
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 705</span>
|
|
332
|
+
|
|
333
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
|
|
334
|
+
<span class='ivar'>@result</span>
|
|
335
|
+
<span class='kw'>end</span></pre>
|
|
336
|
+
</td>
|
|
337
|
+
</tr>
|
|
338
|
+
</table>
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span id=""></span>
|
|
343
|
+
<div class="method_details ">
|
|
344
|
+
<h3 class="signature " id="wrapped-instance_method">
|
|
345
|
+
|
|
346
|
+
- (<tt>Object</tt>) <strong>wrapped</strong> <span class="extras">(readonly)</span>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
</h3><div class="docstring">
|
|
353
|
+
<div class="discussion">
|
|
354
|
+
|
|
355
|
+
<p>Reference to the underlying Exception</p>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</div>
|
|
359
|
+
</div>
|
|
360
|
+
<div class="tags">
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</div><table class="source_code">
|
|
364
|
+
<tr>
|
|
365
|
+
<td>
|
|
366
|
+
<pre class="lines">
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
702
|
|
370
|
+
703
|
|
371
|
+
704</pre>
|
|
372
|
+
</td>
|
|
373
|
+
<td>
|
|
374
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 702</span>
|
|
375
|
+
|
|
376
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_wrapped'>wrapped</span>
|
|
377
|
+
<span class='ivar'>@wrapped</span>
|
|
378
|
+
<span class='kw'>end</span></pre>
|
|
379
|
+
</td>
|
|
380
|
+
</tr>
|
|
381
|
+
</table>
|
|
382
|
+
</div>
|
|
383
|
+
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
<div id="instance_method_details" class="method_details_list">
|
|
388
|
+
<h2>Instance Method Details</h2>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
<div class="method_details first">
|
|
392
|
+
<h3 class="signature first" id="to_s-instance_method">
|
|
393
|
+
|
|
394
|
+
- (<tt>Object</tt>) <strong>to_s</strong>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
</h3><table class="source_code">
|
|
401
|
+
<tr>
|
|
402
|
+
<td>
|
|
403
|
+
<pre class="lines">
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
713
|
|
407
|
+
714
|
|
408
|
+
715</pre>
|
|
409
|
+
</td>
|
|
410
|
+
<td>
|
|
411
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 713</span>
|
|
412
|
+
|
|
413
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
|
414
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@wrapped</span><span class='rbrace'>}</span><span class='tstring_content'> @ </span><span class='embexpr_beg'>#{</span><span class='ivar'>@result</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
|
415
|
+
<span class='kw'>end</span></pre>
|
|
416
|
+
</td>
|
|
417
|
+
</tr>
|
|
418
|
+
</table>
|
|
419
|
+
</div>
|
|
420
|
+
|
|
421
|
+
</div>
|
|
422
|
+
|
|
423
|
+
</div>
|
|
424
|
+
|
|
425
|
+
<div id="footer">
|
|
426
|
+
Generated on Sat Jan 26 17:16:24 2013 by
|
|
427
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
428
|
+
0.8.3 (ruby-1.9.3).
|
|
429
|
+
</div>
|
|
430
|
+
|
|
431
|
+
</body>
|
|
432
|
+
</html>
|
|
@@ -0,0 +1,1640 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Net::SSH::Simple::Result
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.3
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '../../../';
|
|
20
|
+
framesUrl = "../../../frames.html#!" + escape(window.location.href);
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="../../../_index.html">Index (R)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../../../Net.html" title="Net (module)">Net</a></span></span> » <span class='title'><span class='object_link'><a href="../../SSH.html" title="Net::SSH (module)">SSH</a></span></span> » <span class='title'><span class='object_link'><a href="../Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Result</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../../../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../../../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../../../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: Net::SSH::Simple::Result
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Hashie::Dash</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Hashie::Dash</li>
|
|
82
|
+
|
|
83
|
+
<li class="next">Net::SSH::Simple::Result</li>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
87
|
+
|
|
88
|
+
</dd>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<dt class="r2 last">Defined in:</dt>
|
|
99
|
+
<dd class="r2 last">lib/net/ssh/simple.rb</dd>
|
|
100
|
+
|
|
101
|
+
</dl>
|
|
102
|
+
<div class="clear"></div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>Result of a Net::SSH::Simple operation.</p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
120
|
+
<ul class="summary">
|
|
121
|
+
|
|
122
|
+
<li class="public ">
|
|
123
|
+
<span class="summary_signature">
|
|
124
|
+
|
|
125
|
+
<a href="#cmd-instance_method" title="#cmd (instance method)">- (String) <strong>cmd</strong> </a>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</span>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<span class="summary_desc"><div class='inline'>
|
|
143
|
+
<p>Shell command (SSH only).</p>
|
|
144
|
+
</div></span>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
<li class="public ">
|
|
150
|
+
<span class="summary_signature">
|
|
151
|
+
|
|
152
|
+
<a href="#exception-instance_method" title="#exception (instance method)">- (Exception) <strong>exception</strong> </a>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
</span>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'>
|
|
170
|
+
<p>Exception that occurred during this operation (if any).</p>
|
|
171
|
+
</div></span>
|
|
172
|
+
|
|
173
|
+
</li>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<li class="public ">
|
|
177
|
+
<span class="summary_signature">
|
|
178
|
+
|
|
179
|
+
<a href="#exit_code-instance_method" title="#exit_code (instance method)">- (String) <strong>exit_code</strong> </a>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<span class="summary_desc"><div class='inline'>
|
|
197
|
+
<p>UNIX exit code (SSH only).</p>
|
|
198
|
+
</div></span>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<li class="public ">
|
|
204
|
+
<span class="summary_signature">
|
|
205
|
+
|
|
206
|
+
<a href="#exit_signal-instance_method" title="#exit_signal (instance method)">- (String) <strong>exit_signal</strong> </a>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
</span>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
<span class="summary_desc"><div class='inline'>
|
|
224
|
+
<p>Only present if the remote command terminated due to a signal (SSH only).</p>
|
|
225
|
+
</div></span>
|
|
226
|
+
|
|
227
|
+
</li>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<li class="public ">
|
|
231
|
+
<span class="summary_signature">
|
|
232
|
+
|
|
233
|
+
<a href="#finish_at-instance_method" title="#finish_at (instance method)">- (Time) <strong>finish_at</strong> </a>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</span>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<span class="summary_desc"><div class='inline'>
|
|
251
|
+
<p>Timestamp of operation finish.</p>
|
|
252
|
+
</div></span>
|
|
253
|
+
|
|
254
|
+
</li>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<li class="public ">
|
|
258
|
+
<span class="summary_signature">
|
|
259
|
+
|
|
260
|
+
<a href="#host-instance_method" title="#host (instance method)">- (String) <strong>host</strong> </a>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
</span>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<span class="summary_desc"><div class='inline'>
|
|
278
|
+
<p>Hostname/IP address.</p>
|
|
279
|
+
</div></span>
|
|
280
|
+
|
|
281
|
+
</li>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<li class="public ">
|
|
285
|
+
<span class="summary_signature">
|
|
286
|
+
|
|
287
|
+
<a href="#last_event_at-instance_method" title="#last_event_at (instance method)">- (Time) <strong>last_event_at</strong> </a>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<span class="summary_desc"><div class='inline'>
|
|
305
|
+
<p>Timestamp of last activity.</p>
|
|
306
|
+
</div></span>
|
|
307
|
+
|
|
308
|
+
</li>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<li class="public ">
|
|
312
|
+
<span class="summary_signature">
|
|
313
|
+
|
|
314
|
+
<a href="#last_keepalive_at-instance_method" title="#last_keepalive_at (instance method)">- (Time) <strong>last_keepalive_at</strong> </a>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
</span>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
<span class="summary_desc"><div class='inline'>
|
|
332
|
+
<p>Timestamp of last keepalive (if any).</p>
|
|
333
|
+
</div></span>
|
|
334
|
+
|
|
335
|
+
</li>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<li class="public ">
|
|
339
|
+
<span class="summary_signature">
|
|
340
|
+
|
|
341
|
+
<a href="#op-instance_method" title="#op (instance method)">- (Symbol) <strong>op</strong> </a>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
</span>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<span class="summary_desc"><div class='inline'>
|
|
359
|
+
<p>:ssh or :scp.</p>
|
|
360
|
+
</div></span>
|
|
361
|
+
|
|
362
|
+
</li>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
<li class="public ">
|
|
366
|
+
<span class="summary_signature">
|
|
367
|
+
|
|
368
|
+
<a href="#opts-instance_method" title="#opts (instance method)">- (Hash) <strong>opts</strong> </a>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
</span>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<span class="summary_desc"><div class='inline'>
|
|
386
|
+
<p>The options that the operation was parametrized with.</p>
|
|
387
|
+
</div></span>
|
|
388
|
+
|
|
389
|
+
</li>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<li class="public ">
|
|
393
|
+
<span class="summary_signature">
|
|
394
|
+
|
|
395
|
+
<a href="#sent-instance_method" title="#sent (instance method)">- (Integer) <strong>sent</strong> </a>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</span>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<span class="summary_desc"><div class='inline'>
|
|
413
|
+
<p>Number of bytes transferred (SCP only).</p>
|
|
414
|
+
</div></span>
|
|
415
|
+
|
|
416
|
+
</li>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
<li class="public ">
|
|
420
|
+
<span class="summary_signature">
|
|
421
|
+
|
|
422
|
+
<a href="#start_at-instance_method" title="#start_at (instance method)">- (Time) <strong>start_at</strong> </a>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
</span>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
<span class="summary_desc"><div class='inline'>
|
|
440
|
+
<p>Timestamp of operation start.</p>
|
|
441
|
+
</div></span>
|
|
442
|
+
|
|
443
|
+
</li>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
<li class="public ">
|
|
447
|
+
<span class="summary_signature">
|
|
448
|
+
|
|
449
|
+
<a href="#stderr-instance_method" title="#stderr (instance method)">- (String) <strong>stderr</strong> </a>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
</span>
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
|
467
|
+
<p>Output captured on stderr (SSH only).</p>
|
|
468
|
+
</div></span>
|
|
469
|
+
|
|
470
|
+
</li>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
<li class="public ">
|
|
474
|
+
<span class="summary_signature">
|
|
475
|
+
|
|
476
|
+
<a href="#stdout-instance_method" title="#stdout (instance method)">- (String) <strong>stdout</strong> </a>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
<span class="summary_desc"><div class='inline'>
|
|
494
|
+
<p>Output captured on stdout (SSH only).</p>
|
|
495
|
+
</div></span>
|
|
496
|
+
|
|
497
|
+
</li>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<li class="public ">
|
|
501
|
+
<span class="summary_signature">
|
|
502
|
+
|
|
503
|
+
<a href="#success-instance_method" title="#success (instance method)">- (boolean) <strong>success</strong> </a>
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
</span>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
<span class="summary_desc"><div class='inline'>
|
|
521
|
+
<p>Indicates whether the transport-connection was successful.</p>
|
|
522
|
+
</div></span>
|
|
523
|
+
|
|
524
|
+
</li>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<li class="public ">
|
|
528
|
+
<span class="summary_signature">
|
|
529
|
+
|
|
530
|
+
<a href="#timed_out-instance_method" title="#timed_out (instance method)">- (Boolean) <strong>timed_out</strong> </a>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<span class="summary_desc"><div class='inline'>
|
|
548
|
+
<p>True if the operation timed out.</p>
|
|
549
|
+
</div></span>
|
|
550
|
+
|
|
551
|
+
</li>
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<li class="public ">
|
|
555
|
+
<span class="summary_signature">
|
|
556
|
+
|
|
557
|
+
<a href="#total-instance_method" title="#total (instance method)">- (Integer) <strong>total</strong> </a>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
</span>
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
<span class="summary_desc"><div class='inline'>
|
|
575
|
+
<p>Size of requested file (in bytes, SCP only).</p>
|
|
576
|
+
</div></span>
|
|
577
|
+
|
|
578
|
+
</li>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</ul>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<div id="instance_attr_details" class="attr_details">
|
|
589
|
+
<h2>Instance Attribute Details</h2>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<span id="cmd=-instance_method"></span>
|
|
593
|
+
<div class="method_details first">
|
|
594
|
+
<h3 class="signature first" id="cmd-instance_method">
|
|
595
|
+
|
|
596
|
+
- (<tt>String</tt>) <strong>cmd</strong>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
</h3><div class="docstring">
|
|
603
|
+
<div class="discussion">
|
|
604
|
+
|
|
605
|
+
<p>Shell command (SSH only)</p>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
</div>
|
|
609
|
+
</div>
|
|
610
|
+
<div class="tags">
|
|
611
|
+
|
|
612
|
+
<p class="tag_title">Returns:</p>
|
|
613
|
+
<ul class="return">
|
|
614
|
+
|
|
615
|
+
<li>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
—
|
|
623
|
+
<div class='inline'>
|
|
624
|
+
<p>the current value of cmd</p>
|
|
625
|
+
</div>
|
|
626
|
+
|
|
627
|
+
</li>
|
|
628
|
+
|
|
629
|
+
</ul>
|
|
630
|
+
|
|
631
|
+
</div><table class="source_code">
|
|
632
|
+
<tr>
|
|
633
|
+
<td>
|
|
634
|
+
<pre class="lines">
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
740
|
|
638
|
+
741
|
|
639
|
+
742</pre>
|
|
640
|
+
</td>
|
|
641
|
+
<td>
|
|
642
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
643
|
+
|
|
644
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_cmd'>cmd</span>
|
|
645
|
+
<span class='ivar'>@cmd</span>
|
|
646
|
+
<span class='kw'>end</span></pre>
|
|
647
|
+
</td>
|
|
648
|
+
</tr>
|
|
649
|
+
</table>
|
|
650
|
+
</div>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
<span id="exception=-instance_method"></span>
|
|
654
|
+
<div class="method_details ">
|
|
655
|
+
<h3 class="signature " id="exception-instance_method">
|
|
656
|
+
|
|
657
|
+
- (<tt>Exception</tt>) <strong>exception</strong>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
</h3><div class="docstring">
|
|
664
|
+
<div class="discussion">
|
|
665
|
+
|
|
666
|
+
<p>Exception that occurred during this operation (if any)</p>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
</div>
|
|
670
|
+
</div>
|
|
671
|
+
<div class="tags">
|
|
672
|
+
|
|
673
|
+
<p class="tag_title">Returns:</p>
|
|
674
|
+
<ul class="return">
|
|
675
|
+
|
|
676
|
+
<li>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
<span class='type'>(<tt>Exception</tt>)</span>
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
—
|
|
684
|
+
<div class='inline'>
|
|
685
|
+
<p>the current value of exception</p>
|
|
686
|
+
</div>
|
|
687
|
+
|
|
688
|
+
</li>
|
|
689
|
+
|
|
690
|
+
</ul>
|
|
691
|
+
|
|
692
|
+
</div><table class="source_code">
|
|
693
|
+
<tr>
|
|
694
|
+
<td>
|
|
695
|
+
<pre class="lines">
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
740
|
|
699
|
+
741
|
|
700
|
+
742</pre>
|
|
701
|
+
</td>
|
|
702
|
+
<td>
|
|
703
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
704
|
+
|
|
705
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_exception'>exception</span>
|
|
706
|
+
<span class='ivar'>@exception</span>
|
|
707
|
+
<span class='kw'>end</span></pre>
|
|
708
|
+
</td>
|
|
709
|
+
</tr>
|
|
710
|
+
</table>
|
|
711
|
+
</div>
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
<span id="exit_code=-instance_method"></span>
|
|
715
|
+
<div class="method_details ">
|
|
716
|
+
<h3 class="signature " id="exit_code-instance_method">
|
|
717
|
+
|
|
718
|
+
- (<tt>String</tt>) <strong>exit_code</strong>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
</h3><div class="docstring">
|
|
725
|
+
<div class="discussion">
|
|
726
|
+
|
|
727
|
+
<p>UNIX exit code (SSH only)</p>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
</div>
|
|
731
|
+
</div>
|
|
732
|
+
<div class="tags">
|
|
733
|
+
|
|
734
|
+
<p class="tag_title">Returns:</p>
|
|
735
|
+
<ul class="return">
|
|
736
|
+
|
|
737
|
+
<li>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
—
|
|
745
|
+
<div class='inline'>
|
|
746
|
+
<p>the current value of exit_code</p>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
</li>
|
|
750
|
+
|
|
751
|
+
</ul>
|
|
752
|
+
|
|
753
|
+
</div><table class="source_code">
|
|
754
|
+
<tr>
|
|
755
|
+
<td>
|
|
756
|
+
<pre class="lines">
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
740
|
|
760
|
+
741
|
|
761
|
+
742</pre>
|
|
762
|
+
</td>
|
|
763
|
+
<td>
|
|
764
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
765
|
+
|
|
766
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_exit_code'>exit_code</span>
|
|
767
|
+
<span class='ivar'>@exit_code</span>
|
|
768
|
+
<span class='kw'>end</span></pre>
|
|
769
|
+
</td>
|
|
770
|
+
</tr>
|
|
771
|
+
</table>
|
|
772
|
+
</div>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
<span id="exit_signal=-instance_method"></span>
|
|
776
|
+
<div class="method_details ">
|
|
777
|
+
<h3 class="signature " id="exit_signal-instance_method">
|
|
778
|
+
|
|
779
|
+
- (<tt>String</tt>) <strong>exit_signal</strong>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
</h3><div class="docstring">
|
|
786
|
+
<div class="discussion">
|
|
787
|
+
|
|
788
|
+
<p>Only present if the remote command terminated due to a signal (SSH only)</p>
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
</div>
|
|
792
|
+
</div>
|
|
793
|
+
<div class="tags">
|
|
794
|
+
|
|
795
|
+
<p class="tag_title">Returns:</p>
|
|
796
|
+
<ul class="return">
|
|
797
|
+
|
|
798
|
+
<li>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
—
|
|
806
|
+
<div class='inline'>
|
|
807
|
+
<p>the current value of exit_signal</p>
|
|
808
|
+
</div>
|
|
809
|
+
|
|
810
|
+
</li>
|
|
811
|
+
|
|
812
|
+
</ul>
|
|
813
|
+
|
|
814
|
+
</div><table class="source_code">
|
|
815
|
+
<tr>
|
|
816
|
+
<td>
|
|
817
|
+
<pre class="lines">
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
740
|
|
821
|
+
741
|
|
822
|
+
742</pre>
|
|
823
|
+
</td>
|
|
824
|
+
<td>
|
|
825
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
826
|
+
|
|
827
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_exit_signal'>exit_signal</span>
|
|
828
|
+
<span class='ivar'>@exit_signal</span>
|
|
829
|
+
<span class='kw'>end</span></pre>
|
|
830
|
+
</td>
|
|
831
|
+
</tr>
|
|
832
|
+
</table>
|
|
833
|
+
</div>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
<span id="finish_at=-instance_method"></span>
|
|
837
|
+
<div class="method_details ">
|
|
838
|
+
<h3 class="signature " id="finish_at-instance_method">
|
|
839
|
+
|
|
840
|
+
- (<tt>Time</tt>) <strong>finish_at</strong>
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
</h3><div class="docstring">
|
|
847
|
+
<div class="discussion">
|
|
848
|
+
|
|
849
|
+
<p>Timestamp of operation finish</p>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
</div>
|
|
853
|
+
</div>
|
|
854
|
+
<div class="tags">
|
|
855
|
+
|
|
856
|
+
<p class="tag_title">Returns:</p>
|
|
857
|
+
<ul class="return">
|
|
858
|
+
|
|
859
|
+
<li>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
<span class='type'>(<tt>Time</tt>)</span>
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
—
|
|
867
|
+
<div class='inline'>
|
|
868
|
+
<p>the current value of finish_at</p>
|
|
869
|
+
</div>
|
|
870
|
+
|
|
871
|
+
</li>
|
|
872
|
+
|
|
873
|
+
</ul>
|
|
874
|
+
|
|
875
|
+
</div><table class="source_code">
|
|
876
|
+
<tr>
|
|
877
|
+
<td>
|
|
878
|
+
<pre class="lines">
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
740
|
|
882
|
+
741
|
|
883
|
+
742</pre>
|
|
884
|
+
</td>
|
|
885
|
+
<td>
|
|
886
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
887
|
+
|
|
888
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_finish_at'>finish_at</span>
|
|
889
|
+
<span class='ivar'>@finish_at</span>
|
|
890
|
+
<span class='kw'>end</span></pre>
|
|
891
|
+
</td>
|
|
892
|
+
</tr>
|
|
893
|
+
</table>
|
|
894
|
+
</div>
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
<span id="host=-instance_method"></span>
|
|
898
|
+
<div class="method_details ">
|
|
899
|
+
<h3 class="signature " id="host-instance_method">
|
|
900
|
+
|
|
901
|
+
- (<tt>String</tt>) <strong>host</strong>
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
</h3><div class="docstring">
|
|
908
|
+
<div class="discussion">
|
|
909
|
+
|
|
910
|
+
<p>Hostname/IP address</p>
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
</div>
|
|
914
|
+
</div>
|
|
915
|
+
<div class="tags">
|
|
916
|
+
|
|
917
|
+
<p class="tag_title">Returns:</p>
|
|
918
|
+
<ul class="return">
|
|
919
|
+
|
|
920
|
+
<li>
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
—
|
|
928
|
+
<div class='inline'>
|
|
929
|
+
<p>the current value of host</p>
|
|
930
|
+
</div>
|
|
931
|
+
|
|
932
|
+
</li>
|
|
933
|
+
|
|
934
|
+
</ul>
|
|
935
|
+
|
|
936
|
+
</div><table class="source_code">
|
|
937
|
+
<tr>
|
|
938
|
+
<td>
|
|
939
|
+
<pre class="lines">
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
740
|
|
943
|
+
741
|
|
944
|
+
742</pre>
|
|
945
|
+
</td>
|
|
946
|
+
<td>
|
|
947
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
948
|
+
|
|
949
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_host'>host</span>
|
|
950
|
+
<span class='ivar'>@host</span>
|
|
951
|
+
<span class='kw'>end</span></pre>
|
|
952
|
+
</td>
|
|
953
|
+
</tr>
|
|
954
|
+
</table>
|
|
955
|
+
</div>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
<span id="last_event_at=-instance_method"></span>
|
|
959
|
+
<div class="method_details ">
|
|
960
|
+
<h3 class="signature " id="last_event_at-instance_method">
|
|
961
|
+
|
|
962
|
+
- (<tt>Time</tt>) <strong>last_event_at</strong>
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
</h3><div class="docstring">
|
|
969
|
+
<div class="discussion">
|
|
970
|
+
|
|
971
|
+
<p>Timestamp of last activity</p>
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
</div>
|
|
975
|
+
</div>
|
|
976
|
+
<div class="tags">
|
|
977
|
+
|
|
978
|
+
<p class="tag_title">Returns:</p>
|
|
979
|
+
<ul class="return">
|
|
980
|
+
|
|
981
|
+
<li>
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
<span class='type'>(<tt>Time</tt>)</span>
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
—
|
|
989
|
+
<div class='inline'>
|
|
990
|
+
<p>the current value of last_event_at</p>
|
|
991
|
+
</div>
|
|
992
|
+
|
|
993
|
+
</li>
|
|
994
|
+
|
|
995
|
+
</ul>
|
|
996
|
+
|
|
997
|
+
</div><table class="source_code">
|
|
998
|
+
<tr>
|
|
999
|
+
<td>
|
|
1000
|
+
<pre class="lines">
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
740
|
|
1004
|
+
741
|
|
1005
|
+
742</pre>
|
|
1006
|
+
</td>
|
|
1007
|
+
<td>
|
|
1008
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1009
|
+
|
|
1010
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_last_event_at'>last_event_at</span>
|
|
1011
|
+
<span class='ivar'>@last_event_at</span>
|
|
1012
|
+
<span class='kw'>end</span></pre>
|
|
1013
|
+
</td>
|
|
1014
|
+
</tr>
|
|
1015
|
+
</table>
|
|
1016
|
+
</div>
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
<span id="last_keepalive_at=-instance_method"></span>
|
|
1020
|
+
<div class="method_details ">
|
|
1021
|
+
<h3 class="signature " id="last_keepalive_at-instance_method">
|
|
1022
|
+
|
|
1023
|
+
- (<tt>Time</tt>) <strong>last_keepalive_at</strong>
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
</h3><div class="docstring">
|
|
1030
|
+
<div class="discussion">
|
|
1031
|
+
|
|
1032
|
+
<p>Timestamp of last keepalive (if any)</p>
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
</div>
|
|
1036
|
+
</div>
|
|
1037
|
+
<div class="tags">
|
|
1038
|
+
|
|
1039
|
+
<p class="tag_title">Returns:</p>
|
|
1040
|
+
<ul class="return">
|
|
1041
|
+
|
|
1042
|
+
<li>
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
<span class='type'>(<tt>Time</tt>)</span>
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
—
|
|
1050
|
+
<div class='inline'>
|
|
1051
|
+
<p>the current value of last_keepalive_at</p>
|
|
1052
|
+
</div>
|
|
1053
|
+
|
|
1054
|
+
</li>
|
|
1055
|
+
|
|
1056
|
+
</ul>
|
|
1057
|
+
|
|
1058
|
+
</div><table class="source_code">
|
|
1059
|
+
<tr>
|
|
1060
|
+
<td>
|
|
1061
|
+
<pre class="lines">
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
740
|
|
1065
|
+
741
|
|
1066
|
+
742</pre>
|
|
1067
|
+
</td>
|
|
1068
|
+
<td>
|
|
1069
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1070
|
+
|
|
1071
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_last_keepalive_at'>last_keepalive_at</span>
|
|
1072
|
+
<span class='ivar'>@last_keepalive_at</span>
|
|
1073
|
+
<span class='kw'>end</span></pre>
|
|
1074
|
+
</td>
|
|
1075
|
+
</tr>
|
|
1076
|
+
</table>
|
|
1077
|
+
</div>
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
<span id="op=-instance_method"></span>
|
|
1081
|
+
<div class="method_details ">
|
|
1082
|
+
<h3 class="signature " id="op-instance_method">
|
|
1083
|
+
|
|
1084
|
+
- (<tt>Symbol</tt>) <strong>op</strong>
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
</h3><div class="docstring">
|
|
1091
|
+
<div class="discussion">
|
|
1092
|
+
|
|
1093
|
+
<p>:ssh or :scp</p>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
</div>
|
|
1097
|
+
</div>
|
|
1098
|
+
<div class="tags">
|
|
1099
|
+
|
|
1100
|
+
<p class="tag_title">Returns:</p>
|
|
1101
|
+
<ul class="return">
|
|
1102
|
+
|
|
1103
|
+
<li>
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
—
|
|
1111
|
+
<div class='inline'>
|
|
1112
|
+
<p>the current value of op</p>
|
|
1113
|
+
</div>
|
|
1114
|
+
|
|
1115
|
+
</li>
|
|
1116
|
+
|
|
1117
|
+
</ul>
|
|
1118
|
+
|
|
1119
|
+
</div><table class="source_code">
|
|
1120
|
+
<tr>
|
|
1121
|
+
<td>
|
|
1122
|
+
<pre class="lines">
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
740
|
|
1126
|
+
741
|
|
1127
|
+
742</pre>
|
|
1128
|
+
</td>
|
|
1129
|
+
<td>
|
|
1130
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1131
|
+
|
|
1132
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_op'>op</span>
|
|
1133
|
+
<span class='ivar'>@op</span>
|
|
1134
|
+
<span class='kw'>end</span></pre>
|
|
1135
|
+
</td>
|
|
1136
|
+
</tr>
|
|
1137
|
+
</table>
|
|
1138
|
+
</div>
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
<span id="opts=-instance_method"></span>
|
|
1142
|
+
<div class="method_details ">
|
|
1143
|
+
<h3 class="signature " id="opts-instance_method">
|
|
1144
|
+
|
|
1145
|
+
- (<tt>Hash</tt>) <strong>opts</strong>
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
</h3><div class="docstring">
|
|
1152
|
+
<div class="discussion">
|
|
1153
|
+
|
|
1154
|
+
<p>The options that the operation was parametrized with</p>
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
</div>
|
|
1158
|
+
</div>
|
|
1159
|
+
<div class="tags">
|
|
1160
|
+
|
|
1161
|
+
<p class="tag_title">Returns:</p>
|
|
1162
|
+
<ul class="return">
|
|
1163
|
+
|
|
1164
|
+
<li>
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
—
|
|
1172
|
+
<div class='inline'>
|
|
1173
|
+
<p>the current value of opts</p>
|
|
1174
|
+
</div>
|
|
1175
|
+
|
|
1176
|
+
</li>
|
|
1177
|
+
|
|
1178
|
+
</ul>
|
|
1179
|
+
|
|
1180
|
+
</div><table class="source_code">
|
|
1181
|
+
<tr>
|
|
1182
|
+
<td>
|
|
1183
|
+
<pre class="lines">
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
740
|
|
1187
|
+
741
|
|
1188
|
+
742</pre>
|
|
1189
|
+
</td>
|
|
1190
|
+
<td>
|
|
1191
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1192
|
+
|
|
1193
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_opts'>opts</span>
|
|
1194
|
+
<span class='ivar'>@opts</span>
|
|
1195
|
+
<span class='kw'>end</span></pre>
|
|
1196
|
+
</td>
|
|
1197
|
+
</tr>
|
|
1198
|
+
</table>
|
|
1199
|
+
</div>
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
<span id="sent=-instance_method"></span>
|
|
1203
|
+
<div class="method_details ">
|
|
1204
|
+
<h3 class="signature " id="sent-instance_method">
|
|
1205
|
+
|
|
1206
|
+
- (<tt>Integer</tt>) <strong>sent</strong>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
</h3><div class="docstring">
|
|
1213
|
+
<div class="discussion">
|
|
1214
|
+
|
|
1215
|
+
<p>Number of bytes transferred (SCP only)</p>
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
</div>
|
|
1219
|
+
</div>
|
|
1220
|
+
<div class="tags">
|
|
1221
|
+
|
|
1222
|
+
<p class="tag_title">Returns:</p>
|
|
1223
|
+
<ul class="return">
|
|
1224
|
+
|
|
1225
|
+
<li>
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
—
|
|
1233
|
+
<div class='inline'>
|
|
1234
|
+
<p>the current value of sent</p>
|
|
1235
|
+
</div>
|
|
1236
|
+
|
|
1237
|
+
</li>
|
|
1238
|
+
|
|
1239
|
+
</ul>
|
|
1240
|
+
|
|
1241
|
+
</div><table class="source_code">
|
|
1242
|
+
<tr>
|
|
1243
|
+
<td>
|
|
1244
|
+
<pre class="lines">
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
740
|
|
1248
|
+
741
|
|
1249
|
+
742</pre>
|
|
1250
|
+
</td>
|
|
1251
|
+
<td>
|
|
1252
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1253
|
+
|
|
1254
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sent'>sent</span>
|
|
1255
|
+
<span class='ivar'>@sent</span>
|
|
1256
|
+
<span class='kw'>end</span></pre>
|
|
1257
|
+
</td>
|
|
1258
|
+
</tr>
|
|
1259
|
+
</table>
|
|
1260
|
+
</div>
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
<span id="start_at=-instance_method"></span>
|
|
1264
|
+
<div class="method_details ">
|
|
1265
|
+
<h3 class="signature " id="start_at-instance_method">
|
|
1266
|
+
|
|
1267
|
+
- (<tt>Time</tt>) <strong>start_at</strong>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
</h3><div class="docstring">
|
|
1274
|
+
<div class="discussion">
|
|
1275
|
+
|
|
1276
|
+
<p>Timestamp of operation start</p>
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
</div>
|
|
1280
|
+
</div>
|
|
1281
|
+
<div class="tags">
|
|
1282
|
+
|
|
1283
|
+
<p class="tag_title">Returns:</p>
|
|
1284
|
+
<ul class="return">
|
|
1285
|
+
|
|
1286
|
+
<li>
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
<span class='type'>(<tt>Time</tt>)</span>
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
—
|
|
1294
|
+
<div class='inline'>
|
|
1295
|
+
<p>the current value of start_at</p>
|
|
1296
|
+
</div>
|
|
1297
|
+
|
|
1298
|
+
</li>
|
|
1299
|
+
|
|
1300
|
+
</ul>
|
|
1301
|
+
|
|
1302
|
+
</div><table class="source_code">
|
|
1303
|
+
<tr>
|
|
1304
|
+
<td>
|
|
1305
|
+
<pre class="lines">
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
740
|
|
1309
|
+
741
|
|
1310
|
+
742</pre>
|
|
1311
|
+
</td>
|
|
1312
|
+
<td>
|
|
1313
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1314
|
+
|
|
1315
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_start_at'>start_at</span>
|
|
1316
|
+
<span class='ivar'>@start_at</span>
|
|
1317
|
+
<span class='kw'>end</span></pre>
|
|
1318
|
+
</td>
|
|
1319
|
+
</tr>
|
|
1320
|
+
</table>
|
|
1321
|
+
</div>
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
<span id="stderr=-instance_method"></span>
|
|
1325
|
+
<div class="method_details ">
|
|
1326
|
+
<h3 class="signature " id="stderr-instance_method">
|
|
1327
|
+
|
|
1328
|
+
- (<tt>String</tt>) <strong>stderr</strong>
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
</h3><div class="docstring">
|
|
1335
|
+
<div class="discussion">
|
|
1336
|
+
|
|
1337
|
+
<p>Output captured on stderr (SSH only)</p>
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
</div>
|
|
1341
|
+
</div>
|
|
1342
|
+
<div class="tags">
|
|
1343
|
+
|
|
1344
|
+
<p class="tag_title">Returns:</p>
|
|
1345
|
+
<ul class="return">
|
|
1346
|
+
|
|
1347
|
+
<li>
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
—
|
|
1355
|
+
<div class='inline'>
|
|
1356
|
+
<p>the current value of stderr</p>
|
|
1357
|
+
</div>
|
|
1358
|
+
|
|
1359
|
+
</li>
|
|
1360
|
+
|
|
1361
|
+
</ul>
|
|
1362
|
+
|
|
1363
|
+
</div><table class="source_code">
|
|
1364
|
+
<tr>
|
|
1365
|
+
<td>
|
|
1366
|
+
<pre class="lines">
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
740
|
|
1370
|
+
741
|
|
1371
|
+
742</pre>
|
|
1372
|
+
</td>
|
|
1373
|
+
<td>
|
|
1374
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1375
|
+
|
|
1376
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stderr'>stderr</span>
|
|
1377
|
+
<span class='ivar'>@stderr</span>
|
|
1378
|
+
<span class='kw'>end</span></pre>
|
|
1379
|
+
</td>
|
|
1380
|
+
</tr>
|
|
1381
|
+
</table>
|
|
1382
|
+
</div>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
<span id="stdout=-instance_method"></span>
|
|
1386
|
+
<div class="method_details ">
|
|
1387
|
+
<h3 class="signature " id="stdout-instance_method">
|
|
1388
|
+
|
|
1389
|
+
- (<tt>String</tt>) <strong>stdout</strong>
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
</h3><div class="docstring">
|
|
1396
|
+
<div class="discussion">
|
|
1397
|
+
|
|
1398
|
+
<p>Output captured on stdout (SSH only)</p>
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
</div>
|
|
1402
|
+
</div>
|
|
1403
|
+
<div class="tags">
|
|
1404
|
+
|
|
1405
|
+
<p class="tag_title">Returns:</p>
|
|
1406
|
+
<ul class="return">
|
|
1407
|
+
|
|
1408
|
+
<li>
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
—
|
|
1416
|
+
<div class='inline'>
|
|
1417
|
+
<p>the current value of stdout</p>
|
|
1418
|
+
</div>
|
|
1419
|
+
|
|
1420
|
+
</li>
|
|
1421
|
+
|
|
1422
|
+
</ul>
|
|
1423
|
+
|
|
1424
|
+
</div><table class="source_code">
|
|
1425
|
+
<tr>
|
|
1426
|
+
<td>
|
|
1427
|
+
<pre class="lines">
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
740
|
|
1431
|
+
741
|
|
1432
|
+
742</pre>
|
|
1433
|
+
</td>
|
|
1434
|
+
<td>
|
|
1435
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1436
|
+
|
|
1437
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stdout'>stdout</span>
|
|
1438
|
+
<span class='ivar'>@stdout</span>
|
|
1439
|
+
<span class='kw'>end</span></pre>
|
|
1440
|
+
</td>
|
|
1441
|
+
</tr>
|
|
1442
|
+
</table>
|
|
1443
|
+
</div>
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
<span id="success=-instance_method"></span>
|
|
1447
|
+
<div class="method_details ">
|
|
1448
|
+
<h3 class="signature " id="success-instance_method">
|
|
1449
|
+
|
|
1450
|
+
- (<tt>boolean</tt>) <strong>success</strong>
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
</h3><div class="docstring">
|
|
1457
|
+
<div class="discussion">
|
|
1458
|
+
|
|
1459
|
+
<p>Indicates whether the transport-connection was successful</p>
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
</div>
|
|
1463
|
+
</div>
|
|
1464
|
+
<div class="tags">
|
|
1465
|
+
|
|
1466
|
+
<p class="tag_title">Returns:</p>
|
|
1467
|
+
<ul class="return">
|
|
1468
|
+
|
|
1469
|
+
<li>
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
—
|
|
1477
|
+
<div class='inline'>
|
|
1478
|
+
<p>the current value of success</p>
|
|
1479
|
+
</div>
|
|
1480
|
+
|
|
1481
|
+
</li>
|
|
1482
|
+
|
|
1483
|
+
</ul>
|
|
1484
|
+
|
|
1485
|
+
</div><table class="source_code">
|
|
1486
|
+
<tr>
|
|
1487
|
+
<td>
|
|
1488
|
+
<pre class="lines">
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
740
|
|
1492
|
+
741
|
|
1493
|
+
742</pre>
|
|
1494
|
+
</td>
|
|
1495
|
+
<td>
|
|
1496
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1497
|
+
|
|
1498
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_success'>success</span>
|
|
1499
|
+
<span class='ivar'>@success</span>
|
|
1500
|
+
<span class='kw'>end</span></pre>
|
|
1501
|
+
</td>
|
|
1502
|
+
</tr>
|
|
1503
|
+
</table>
|
|
1504
|
+
</div>
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
<span id="timed_out=-instance_method"></span>
|
|
1508
|
+
<div class="method_details ">
|
|
1509
|
+
<h3 class="signature " id="timed_out-instance_method">
|
|
1510
|
+
|
|
1511
|
+
- (<tt>Boolean</tt>) <strong>timed_out</strong>
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
</h3><div class="docstring">
|
|
1518
|
+
<div class="discussion">
|
|
1519
|
+
|
|
1520
|
+
<p>True if the operation timed out</p>
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
</div>
|
|
1524
|
+
</div>
|
|
1525
|
+
<div class="tags">
|
|
1526
|
+
|
|
1527
|
+
<p class="tag_title">Returns:</p>
|
|
1528
|
+
<ul class="return">
|
|
1529
|
+
|
|
1530
|
+
<li>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
—
|
|
1538
|
+
<div class='inline'>
|
|
1539
|
+
<p>the current value of timed_out</p>
|
|
1540
|
+
</div>
|
|
1541
|
+
|
|
1542
|
+
</li>
|
|
1543
|
+
|
|
1544
|
+
</ul>
|
|
1545
|
+
|
|
1546
|
+
</div><table class="source_code">
|
|
1547
|
+
<tr>
|
|
1548
|
+
<td>
|
|
1549
|
+
<pre class="lines">
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
740
|
|
1553
|
+
741
|
|
1554
|
+
742</pre>
|
|
1555
|
+
</td>
|
|
1556
|
+
<td>
|
|
1557
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1558
|
+
|
|
1559
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_timed_out'>timed_out</span>
|
|
1560
|
+
<span class='ivar'>@timed_out</span>
|
|
1561
|
+
<span class='kw'>end</span></pre>
|
|
1562
|
+
</td>
|
|
1563
|
+
</tr>
|
|
1564
|
+
</table>
|
|
1565
|
+
</div>
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
<span id="total=-instance_method"></span>
|
|
1569
|
+
<div class="method_details ">
|
|
1570
|
+
<h3 class="signature " id="total-instance_method">
|
|
1571
|
+
|
|
1572
|
+
- (<tt>Integer</tt>) <strong>total</strong>
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
</h3><div class="docstring">
|
|
1579
|
+
<div class="discussion">
|
|
1580
|
+
|
|
1581
|
+
<p>Size of requested file (in bytes, SCP only)</p>
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
</div>
|
|
1585
|
+
</div>
|
|
1586
|
+
<div class="tags">
|
|
1587
|
+
|
|
1588
|
+
<p class="tag_title">Returns:</p>
|
|
1589
|
+
<ul class="return">
|
|
1590
|
+
|
|
1591
|
+
<li>
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
—
|
|
1599
|
+
<div class='inline'>
|
|
1600
|
+
<p>the current value of total</p>
|
|
1601
|
+
</div>
|
|
1602
|
+
|
|
1603
|
+
</li>
|
|
1604
|
+
|
|
1605
|
+
</ul>
|
|
1606
|
+
|
|
1607
|
+
</div><table class="source_code">
|
|
1608
|
+
<tr>
|
|
1609
|
+
<td>
|
|
1610
|
+
<pre class="lines">
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
740
|
|
1614
|
+
741
|
|
1615
|
+
742</pre>
|
|
1616
|
+
</td>
|
|
1617
|
+
<td>
|
|
1618
|
+
<pre class="code"><span class="info file"># File 'lib/net/ssh/simple.rb', line 740</span>
|
|
1619
|
+
|
|
1620
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_total'>total</span>
|
|
1621
|
+
<span class='ivar'>@total</span>
|
|
1622
|
+
<span class='kw'>end</span></pre>
|
|
1623
|
+
</td>
|
|
1624
|
+
</tr>
|
|
1625
|
+
</table>
|
|
1626
|
+
</div>
|
|
1627
|
+
|
|
1628
|
+
</div>
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
</div>
|
|
1632
|
+
|
|
1633
|
+
<div id="footer">
|
|
1634
|
+
Generated on Sat Jan 26 17:16:25 2013 by
|
|
1635
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1636
|
+
0.8.3 (ruby-1.9.3).
|
|
1637
|
+
</div>
|
|
1638
|
+
|
|
1639
|
+
</body>
|
|
1640
|
+
</html>
|