doc/MCollective/UnixDaemon.html

   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">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Class: MCollective::UnixDaemon</title>
   9
  10         <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
  11
  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>
  20
  21 </head>
  22 <body class="class">
  23
  24         <div id="metadata">
  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">
  29                                         <ul>
  30
  31                                                 <li><a href="../lib/mcollective/unix_daemon_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/unix_daemon.rb">lib/mcollective/unix_daemon.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45                         <div id="parent-class-section" class="section">
  46                                 <h3 class="section-header">Parent</h3>
  47
  48                                 <p class="link"><a href="../Object.html">Object</a></p>
  49
  50                         </div>
  51
  52
  53                         <!-- Namespace Contents -->
  54
  55
  56                         <!-- Method Quickref -->
  57
  58                         <div id="method-list-section" class="section">
  59                                 <h3 class="section-header">Methods</h3>
  60                                 <ul class="link-list">
  61
  62                                         <li><a href="#M000346">::daemonize</a></li>
  63
  64                                         <li><a href="#M000347">::daemonize_runner</a></li>
  65
  66                                 </ul>
  67                         </div>
  68
  69
  70                         <!-- Included Modules -->
  71
  72                 </div>
  73
  74                 <div id="project-metadata">
  75
  76
  77                         <div id="fileindex-section" class="section project-section">
  78                                 <h3 class="section-header">Files</h3>
  79                                 <ul>
  80
  81                                         <li class="file"><a href="../COPYING.html">COPYING</a></li>
  82
  83                                         <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
  84
  85                                         <li class="file"><a href="../README.html">README</a></li>
  86
  87                                         <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
  88
  89                                         <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  90
  91                                         <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
  92
  93                                         <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  94
  95                                         <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  96
  97                                         <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
  98
  99                                         <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
 100
 101                                         <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 102
 103                                         <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 104
 105                                         <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 106
 107                                         <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 108
 109                                         <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 110
 111                                         <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 112
 113                                         <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 114
 115                                         <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 116
 117                                         <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 118
 119                                         <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
 120
 121                                 </ul>
 122                         </div>
 123
 124
 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">
 131                                 <fieldset>
 132                                         <legend>Quicksearch</legend>
 133                                         <input type="text" name="quicksearch" value=""
 134                                                 class="quicksearch-field" />
 135                                 </fieldset>
 136                                 </form>
 137
 138                                 <ul class="link-list">
 139
 140                                         <li><a href="../MCollective.html">MCollective</a></li>
 141
 142                                         <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
 143
 144                                         <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
 145
 146                                         <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 147
 148                                         <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 149
 150                                         <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 151
 152                                         <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 153
 154                                         <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 155
 156                                         <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 157
 158                                         <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
 159
 160                                         <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
 161
 162                                         <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
 163
 164                                         <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
 165
 166                                         <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
 167
 168                                         <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
 169
 170                                         <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
 171
 172                                         <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 173
 174                                         <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
 175
 176                                         <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 177
 178                                         <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 179
 180                                         <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 181
 182                                         <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 183
 184                                         <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 185
 186                                         <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 187
 188                                         <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
 189
 190                                         <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 191
 192                                         <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 193
 194                                         <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
 195
 196                                         <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
 197
 198                                         <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 199
 200                                         <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
 201
 202                                         <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 203
 204                                         <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 205
 206                                         <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 207
 208                                         <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 209
 210                                         <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
 211
 212                                         <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
 213
 214                                         <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 215
 216                                         <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 217
 218                                         <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 219
 220                                         <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 221
 222                                         <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
 223
 224                                         <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 225
 226                                         <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 227
 228                                         <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
 229
 230                                         <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 231
 232                                         <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 233
 234                                         <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 235
 236                                         <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 237
 238                                         <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 239
 240                                         <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 241
 242                                         <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 243
 244                                         <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 245
 246                                         <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 247
 248                                         <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
 249
 250                                         <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 251
 252                                         <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 253
 254                                         <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 255
 256                                         <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 257
 258                                         <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 259
 260                                         <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 261
 262                                         <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 263
 264                                         <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 265
 266                                         <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 267
 268                                         <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 269
 270                                         <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 271
 272                                         <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
 273
 274                                         <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
 275
 276                                         <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 277
 278                                         <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
 279
 280                                         <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 281
 282                                         <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
 283
 284                                         <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
 285
 286                                         <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 287
 288                                         <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 289
 290                                         <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
 291
 292                                         <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
 293
 294                                         <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 295
 296                                         <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 297
 298                                         <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 299
 300                                         <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
 301
 302                                         <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
 303
 304                                         <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 305
 306                                         <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 307
 308                                         <li><a href="../Array.html">Array</a></li>
 309
 310                                         <li><a href="../Dir.html">Dir</a></li>
 311
 312                                         <li><a href="../Object.html">Object</a></li>
 313
 314                                         <li><a href="../String.html">String</a></li>
 315
 316                                         <li><a href="../Symbol.html">Symbol</a></li>
 317
 318                                 </ul>
 319                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 320                         </div>
 321
 322
 323                 </div>
 324         </div>
 325
 326         <div id="documentation">
 327                 <h1 class="class">MCollective::UnixDaemon</h1>
 328
 329                 <div id="description">
 330
 331                 </div>
 332
 333                 <!-- Constants -->
 334
 335
 336                 <!-- Attributes -->
 337
 338
 339                 <!-- Methods -->
 340
 341                 <div id="public-class-method-details" class="method-section section">
 342                         <h3 class="section-header">Public Class Methods</h3>
 343
 344
 345                         <div id="daemonize-method" class="method-detail ">
 346                                 <a name="M000346"></a>
 347
 348                                 <div class="method-heading">
 349
 350                                         <span class="method-name">daemonize</span><span
 351                                                 class="method-args">()</span>
 352                                         <span class="method-click-advice">click to toggle source</span>
 353
 354                                 </div>
 355
 356                                 <div class="method-description">
 357
 358                                         <p>
 359 Daemonize the current process
 360 </p>
 361
 362
 363
 364                                         <div class="method-source-code"
 365                                                 id="daemonize-source">
 366 <pre>
 367     <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 4</span>
 368  4:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize</span>
 369  5:       <span class="ruby-identifier">fork</span> <span class="ruby-keyword kw">do</span>
 370  6:         <span class="ruby-constant">Process</span>.<span class="ruby-identifier">setsid</span>
 371  7:         <span class="ruby-identifier">exit</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fork</span>
 372  8:         <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-value str">'/tmp'</span>)
 373  9:         <span class="ruby-constant">STDIN</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>)
 374 10:         <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>, <span class="ruby-value str">'a'</span>)
 375 11:         <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>, <span class="ruby-value str">'a'</span>)
 376 12:
 377 13:         <span class="ruby-keyword kw">yield</span>
 378 14:       <span class="ruby-keyword kw">end</span>
 379 15:     <span class="ruby-keyword kw">end</span></pre>
 380                                         </div>
 381
 382                                 </div>
 383
 384
 385                         </div>
 386
 387
 388                         <div id="daemonize-runner-method" class="method-detail ">
 389                                 <a name="M000347"></a>
 390
 391                                 <div class="method-heading">
 392
 393                                         <span class="method-name">daemonize_runner</span><span
 394                                                 class="method-args">(pid=nil)</span>
 395                                         <span class="method-click-advice">click to toggle source</span>
 396
 397                                 </div>
 398
 399                                 <div class="method-description">
 400
 401                                         <p class="missing-docs">(Not documented)</p>
 402
 403
 404
 405                                         <div class="method-source-code"
 406                                                 id="daemonize-runner-source">
 407 <pre>
 408     <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 17</span>
 409 17:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize_runner</span>(<span class="ruby-identifier">pid</span>=<span class="ruby-keyword kw">nil</span>)
 410 18:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;The Unix Daemonizer can not be used on the Windows Platform&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
 411 19:
 412 20:       <span class="ruby-constant">UnixDaemon</span>.<span class="ruby-identifier">daemonize</span> <span class="ruby-keyword kw">do</span>
 413 21:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
 414 22:           <span class="ruby-keyword kw">begin</span>
 415 23:             <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">pid</span>, <span class="ruby-value str">'w'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-constant">Process</span>.<span class="ruby-identifier">pid</span>) }
 416 24:           <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
 417 25:           <span class="ruby-keyword kw">end</span>
 418 26:         <span class="ruby-keyword kw">end</span>
 419 27:
 420 28:         <span class="ruby-keyword kw">begin</span>
 421 29:           <span class="ruby-identifier">runner</span> = <span class="ruby-constant">Runner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">nil</span>)
 422 30:           <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">run</span>
 423 31:         <span class="ruby-keyword kw">ensure</span>
 424 32:           <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-identifier">pid</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">pid</span>)
 425 33:         <span class="ruby-keyword kw">end</span>
 426 34:       <span class="ruby-keyword kw">end</span>
 427 35:     <span class="ruby-keyword kw">end</span></pre>
 428                                         </div>
 429
 430                                 </div>
 431
 432
 433                         </div>
 434
 435
 436                 </div>
 437
 438
 439         </div>
 440
 441
 442         <div id="rdoc-debugging-section-dump" class="debugging-section">
 443
 444                 <p>Disabled; run with --debug to generate this.</p>
 445
 446         </div>
 447
 448         <div id="validator-badges">
 449                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 450                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 451                         Rdoc Generator</a> 1.1.6</small>.</p>
 452         </div>
 453
 454 </body>
 455 </html>
 456