1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8 <title>Class: MCollective::Shell</title>
10 <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
12 <script src="../js/jquery.js" type="text/javascript"
13 charset="utf-8"></script>
14 <script src="../js/thickbox-compressed.js" type="text/javascript"
15 charset="utf-8"></script>
16 <script src="../js/quicksearch.js" type="text/javascript"
17 charset="utf-8"></script>
18 <script src="../js/darkfish.js" type="text/javascript"
19 charset="utf-8"></script>
25 <div id="file-metadata">
26 <div id="file-list-section" class="section">
27 <h3 class="section-header">In Files</h3>
28 <div class="section-body">
31 <li><a href="../lib/mcollective/shell_rb.html?TB_iframe=true&height=550&width=785"
32 class="thickbox" title="lib/mcollective/shell.rb">lib/mcollective/shell.rb</a></li>
41 <div id="class-metadata">
45 <div id="parent-class-section" class="section">
46 <h3 class="section-header">Parent</h3>
48 <p class="link"><a href="../Object.html">Object</a></p>
53 <!-- Namespace Contents -->
56 <!-- Method Quickref -->
58 <div id="method-list-section" class="section">
59 <h3 class="section-header">Methods</h3>
60 <ul class="link-list">
62 <li><a href="#M000358">::new</a></li>
64 <li><a href="#M000365">#runcommand</a></li>
70 <!-- Included Modules -->
74 <div id="project-metadata">
77 <div id="fileindex-section" class="section project-section">
78 <h3 class="section-header">Files</h3>
81 <li class="file"><a href="../COPYING.html">COPYING</a></li>
83 <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
85 <li class="file"><a href="../README.html">README</a></li>
87 <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
89 <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
91 <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
93 <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
95 <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
97 <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
99 <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
101 <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
103 <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
105 <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
107 <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
109 <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
111 <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
113 <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
115 <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
117 <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
119 <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
125 <div id="classindex-section" class="section project-section">
126 <h3 class="section-header">Class Index
127 <span class="search-toggle"><img src="../images/find.png"
128 height="16" width="16" alt="[+]"
129 title="show/hide quicksearch" /></span></h3>
130 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
132 <legend>Quicksearch</legend>
133 <input type="text" name="quicksearch" value=""
134 class="quicksearch-field" />
138 <ul class="link-list">
140 <li><a href="../MCollective.html">MCollective</a></li>
142 <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
144 <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
146 <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
148 <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
150 <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
152 <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
154 <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
156 <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
158 <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
160 <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
162 <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
164 <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
166 <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
168 <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
170 <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
172 <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
174 <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
176 <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
178 <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
180 <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
182 <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
184 <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
186 <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
188 <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
190 <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
192 <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
194 <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
196 <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
198 <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
200 <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
202 <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
204 <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
206 <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
208 <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
210 <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
212 <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
214 <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
216 <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
218 <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
220 <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
222 <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
224 <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
226 <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
228 <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
230 <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
232 <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
234 <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
236 <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
238 <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
240 <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
242 <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
244 <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
246 <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
248 <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
250 <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
252 <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
254 <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
256 <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
258 <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
260 <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
262 <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
264 <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
266 <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
268 <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
270 <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
272 <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
274 <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
276 <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
278 <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
280 <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
282 <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
284 <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
286 <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
288 <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
290 <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
292 <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
294 <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
296 <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
298 <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
300 <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
302 <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
304 <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
306 <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
308 <li><a href="../Array.html">Array</a></li>
310 <li><a href="../Dir.html">Dir</a></li>
312 <li><a href="../Object.html">Object</a></li>
314 <li><a href="../String.html">String</a></li>
316 <li><a href="../Symbol.html">Symbol</a></li>
319 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
326 <div id="documentation">
327 <h1 class="class">MCollective::Shell</h1>
329 <div id="description">
331 Wrapper around systemu that handles executing of system commands in a way
332 that makes stdout, stderr and status available. Supports timeouts and sets
333 a default sane environment.
336 s = Shell.new("date", opts)
340 puts s.status.exitstatus
343 Options hash can have:
346 cwd - the working directory the command will be run from
347 stdin - a string that will be sent to stdin of the program
348 stdout - a variable that will receive stdout, must support <<
349 stderr - a variable that will receive stdin, must support <<
350 environment - the shell environment, defaults to include LC_ALL=C
351 set to nil to clear the environment even of LC_ALL
352 timeout - a timeout in seconds after which the subprocess is killed,
353 the special value :on_thread_exit kills the subprocess
354 when the invoking thread (typically the agent) has ended
364 <div id="attribute-method-details" class="method-section section">
365 <h3 class="section-header">Attributes</h3>
368 <div id="environment-attribute-method" class="method-detail">
369 <a name="environment"></a>
371 <div class="method-heading attribute-method-heading">
372 <span class="method-name">environment</span><span
373 class="attribute-access-type">[R]</span>
376 <div class="method-description">
378 <p class="missing-docs">(Not documented)</p>
383 <div id="command-attribute-method" class="method-detail">
384 <a name="command"></a>
386 <div class="method-heading attribute-method-heading">
387 <span class="method-name">command</span><span
388 class="attribute-access-type">[R]</span>
391 <div class="method-description">
393 <p class="missing-docs">(Not documented)</p>
398 <div id="status-attribute-method" class="method-detail">
399 <a name="status"></a>
401 <div class="method-heading attribute-method-heading">
402 <span class="method-name">status</span><span
403 class="attribute-access-type">[R]</span>
406 <div class="method-description">
408 <p class="missing-docs">(Not documented)</p>
413 <div id="stdout-attribute-method" class="method-detail">
414 <a name="stdout"></a>
416 <div class="method-heading attribute-method-heading">
417 <span class="method-name">stdout</span><span
418 class="attribute-access-type">[R]</span>
421 <div class="method-description">
423 <p class="missing-docs">(Not documented)</p>
428 <div id="stderr-attribute-method" class="method-detail">
429 <a name="stderr"></a>
431 <div class="method-heading attribute-method-heading">
432 <span class="method-name">stderr</span><span
433 class="attribute-access-type">[R]</span>
436 <div class="method-description">
438 <p class="missing-docs">(Not documented)</p>
443 <div id="stdin-attribute-method" class="method-detail">
446 <div class="method-heading attribute-method-heading">
447 <span class="method-name">stdin</span><span
448 class="attribute-access-type">[R]</span>
451 <div class="method-description">
453 <p class="missing-docs">(Not documented)</p>
458 <div id="cwd-attribute-method" class="method-detail">
461 <div class="method-heading attribute-method-heading">
462 <span class="method-name">cwd</span><span
463 class="attribute-access-type">[R]</span>
466 <div class="method-description">
468 <p class="missing-docs">(Not documented)</p>
473 <div id="timeout-attribute-method" class="method-detail">
474 <a name="timeout"></a>
476 <div class="method-heading attribute-method-heading">
477 <span class="method-name">timeout</span><span
478 class="attribute-access-type">[R]</span>
481 <div class="method-description">
483 <p class="missing-docs">(Not documented)</p>
493 <div id="public-class-method-details" class="method-section section">
494 <h3 class="section-header">Public Class Methods</h3>
497 <div id="new-method" class="method-detail ">
498 <a name="M000358"></a>
500 <div class="method-heading">
502 <span class="method-name">new</span><span
503 class="method-args">(command, options={})</span>
504 <span class="method-click-advice">click to toggle source</span>
508 <div class="method-description">
510 <p class="missing-docs">(Not documented)</p>
514 <div class="method-source-code"
517 <span class="ruby-comment cmt"># File lib/mcollective/shell.rb, line 27</span>
518 27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">options</span>={})
519 28: <span class="ruby-ivar">@environment</span> = {<span class="ruby-value str">"LC_ALL"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"C"</span>}
520 29: <span class="ruby-ivar">@command</span> = <span class="ruby-identifier">command</span>
521 30: <span class="ruby-ivar">@status</span> = <span class="ruby-keyword kw">nil</span>
522 31: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
523 32: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
524 33: <span class="ruby-ivar">@stdin</span> = <span class="ruby-keyword kw">nil</span>
525 34: <span class="ruby-ivar">@cwd</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
526 35: <span class="ruby-ivar">@timeout</span> = <span class="ruby-keyword kw">nil</span>
528 37: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opt</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
529 38: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">opt</span>.<span class="ruby-identifier">to_s</span>
530 39: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdout"</span>
531 40: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdout should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
532 41: <span class="ruby-ivar">@stdout</span> = <span class="ruby-identifier">val</span>
534 43: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stderr"</span>
535 44: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stderr should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
536 45: <span class="ruby-ivar">@stderr</span> = <span class="ruby-identifier">val</span>
538 47: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdin"</span>
539 48: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdin should be a String"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
540 49: <span class="ruby-ivar">@stdin</span> = <span class="ruby-identifier">val</span>
542 51: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"cwd"</span>
543 52: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Directory #{val} does not exist"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">val</span>)
544 53: <span class="ruby-ivar">@cwd</span> = <span class="ruby-identifier">val</span>
546 55: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"environment"</span>
547 56: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">nil?</span>
548 57: <span class="ruby-ivar">@environment</span> = {}
549 58: <span class="ruby-keyword kw">else</span>
550 59: <span class="ruby-ivar">@environment</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">dup</span>)
551 60: <span class="ruby-keyword kw">end</span>
552 61: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"timeout"</span>
553 62: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"timeout should be a positive integer or the symbol :on_thread_exit symbol"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">eql?</span>(<span class="ruby-identifier">:on_thread_exit</span>) <span class="ruby-operator">||</span> ( <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Fixnum</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">val</span><span class="ruby-operator">></span><span class="ruby-value">0</span> )
554 63: <span class="ruby-ivar">@timeout</span> = <span class="ruby-identifier">val</span>
555 64: <span class="ruby-keyword kw">end</span>
556 65: <span class="ruby-keyword kw">end</span>
557 66: <span class="ruby-keyword kw">end</span></pre>
568 <div id="public-instance-method-details" class="method-section section">
569 <h3 class="section-header">Public Instance Methods</h3>
572 <div id="runcommand-method" class="method-detail ">
573 <a name="M000365"></a>
575 <div class="method-heading">
577 <span class="method-name">runcommand</span><span
578 class="method-args">()</span>
579 <span class="method-click-advice">click to toggle source</span>
583 <div class="method-description">
586 Actually does the systemu call passing in the correct environment, stdout
592 <div class="method-source-code"
593 id="runcommand-source">
595 <span class="ruby-comment cmt"># File lib/mcollective/shell.rb, line 69</span>
596 69: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">runcommand</span>
597 70: <span class="ruby-identifier">opts</span> = {<span class="ruby-value str">"env"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@environment</span>,
598 71: <span class="ruby-value str">"stdout"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stdout</span>,
599 72: <span class="ruby-value str">"stderr"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stderr</span>,
600 73: <span class="ruby-value str">"cwd"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@cwd</span>}
602 75: <span class="ruby-identifier">opts</span>[<span class="ruby-value str">"stdin"</span>] = <span class="ruby-ivar">@stdin</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@stdin</span>
605 78: <span class="ruby-identifier">thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>
606 79: <span class="ruby-comment cmt"># Start a double fork and exec with systemu which implies a guard thread.</span>
607 80: <span class="ruby-comment cmt"># If a valid timeout is configured the guard thread will terminate the</span>
608 81: <span class="ruby-comment cmt"># executing process and reap the pid.</span>
609 82: <span class="ruby-comment cmt"># If no timeout is specified the process will run to completion with the</span>
610 83: <span class="ruby-comment cmt"># guard thread reaping the pid on completion.</span>
611 84: <span class="ruby-ivar">@status</span> = <span class="ruby-identifier">systemu</span>(<span class="ruby-ivar">@command</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cid</span><span class="ruby-operator">|</span>
612 85: <span class="ruby-keyword kw">begin</span>
613 86: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">timeout</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Fixnum</span>)
614 87: <span class="ruby-comment cmt"># wait for the specified timeout</span>
615 88: <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">timeout</span>
616 89: <span class="ruby-keyword kw">else</span>
617 90: <span class="ruby-comment cmt"># sleep while the agent thread is still alive</span>
618 91: <span class="ruby-keyword kw">while</span>(<span class="ruby-identifier">thread</span>.<span class="ruby-identifier">alive?</span>)
619 92: <span class="ruby-identifier">sleep</span> <span class="ruby-value">0</span><span class="ruby-value">.1</span>
620 93: <span class="ruby-keyword kw">end</span>
621 94: <span class="ruby-keyword kw">end</span>
623 96: <span class="ruby-comment cmt"># if the process is still running</span>
624 97: <span class="ruby-keyword kw">if</span> (<span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">cid</span>))
625 98: <span class="ruby-comment cmt"># and a timeout was specified</span>
626 99: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">timeout</span>
627 100: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
628 101: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'KILL'</span>, <span class="ruby-identifier">cid</span>)
629 102: <span class="ruby-keyword kw">else</span>
630 103: <span class="ruby-comment cmt"># Kill the process</span>
631 104: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'TERM'</span>, <span class="ruby-identifier">cid</span>)
632 105: <span class="ruby-identifier">sleep</span> <span class="ruby-value">2</span>
633 106: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'KILL'</span>, <span class="ruby-identifier">cid</span>) <span class="ruby-keyword kw">if</span> (<span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">cid</span>))
634 107: <span class="ruby-keyword kw">end</span>
635 108: <span class="ruby-keyword kw">end</span>
636 109: <span class="ruby-comment cmt"># only wait if the parent thread is dead</span>
637 110: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">waitpid</span>(<span class="ruby-identifier">cid</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">thread</span>.<span class="ruby-identifier">alive?</span>
638 111: <span class="ruby-keyword kw">end</span>
639 112: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SystemExit</span>
640 113: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
641 114: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ECHILD</span>
642 115: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">"Could not reap process '#{cid}'."</span>)
643 116: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
644 117: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"Unexpected exception received while waiting for child process: #{e.class}: #{e}"</span>)
645 118: <span class="ruby-keyword kw">end</span>
646 119: <span class="ruby-keyword kw">end</span>
647 120: <span class="ruby-ivar">@status</span>.<span class="ruby-identifier">thread</span>.<span class="ruby-identifier">kill</span>
648 121: <span class="ruby-ivar">@status</span>
649 122: <span class="ruby-keyword kw">end</span></pre>
664 <div id="rdoc-debugging-section-dump" class="debugging-section">
666 <p>Disabled; run with --debug to generate this.</p>
670 <div id="validator-badges">
671 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
672 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
673 Rdoc Generator</a> 1.1.6</small>.</p>