doc/classes/MCollective/WindowsDaemon.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Class: MCollective::WindowsDaemon</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Class</strong></td>
  53           <td class="class-name-in-header">MCollective::WindowsDaemon</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/mcollective/windows_daemon_rb.html">
  59                 lib/mcollective/windows_daemon.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         <tr class="top-aligned-row">
  66             <td><strong>Parent:</strong></td>
  67             <td>
  68                 Win32::Daemon
  69             </td>
  70         </tr>
  71         </table>
  72     </div>
  73   <!-- banner header -->
  74
  75   <div id="bodyContent">
  76
  77
  78
  79   <div id="contextContent">
  80
  81
  82
  83    </div>
  84
  85     <div id="method-list">
  86       <h3 class="section-bar">Methods</h3>
  87
  88       <div class="name-list">
  89       <a href="#M000373">daemonize_runner</a>&nbsp;&nbsp;
  90       <a href="#M000374">service_main</a>&nbsp;&nbsp;
  91       <a href="#M000375">service_stop</a>&nbsp;&nbsp;
  92       </div>
  93     </div>
  94
  95   </div>
  96
  97
  98     <!-- if includes -->
  99
 100     <div id="section">
 101
 102
 103
 104
 105
 106
 107
 108
 109     <!-- if method_list -->
 110     <div id="methods">
 111       <h3 class="section-bar">Public Class methods</h3>
 112
 113       <div id="method-M000373" class="method-detail">
 114         <a name="M000373"></a>
 115
 116         <div class="method-heading">
 117           <a href="#M000373" class="method-signature">
 118           <span class="method-name">daemonize_runner</span><span class="method-args">(pid=nil)</span>
 119           </a>
 120         </div>
 121
 122         <div class="method-description">
 123           <p><a class="source-toggle" href="#"
 124             onclick="toggleCode('M000373-source');return false;">[Source]</a></p>
 125           <div class="method-source-code" id="M000373-source">
 126 <pre>
 127     <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 5</span>
 128  5:     <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>)
 129  6:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Writing pid files are not supported on the Windows Platform&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
 130  7:       <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;The Windows Daemonizer should only be used on the Windows Platform&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
 131  8:
 132  9:       <span class="ruby-constant">WindowsDaemon</span>.<span class="ruby-identifier">mainloop</span>
 133 10:     <span class="ruby-keyword kw">end</span>
 134 </pre>
 135           </div>
 136         </div>
 137       </div>
 138
 139       <h3 class="section-bar">Public Instance methods</h3>
 140
 141       <div id="method-M000374" class="method-detail">
 142         <a name="M000374"></a>
 143
 144         <div class="method-heading">
 145           <a href="#M000374" class="method-signature">
 146           <span class="method-name">service_main</span><span class="method-args">()</span>
 147           </a>
 148         </div>
 149
 150         <div class="method-description">
 151           <p><a class="source-toggle" href="#"
 152             onclick="toggleCode('M000374-source');return false;">[Source]</a></p>
 153           <div class="method-source-code" id="M000374-source">
 154 <pre>
 155     <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 12</span>
 156 12:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">service_main</span>
 157 13:       <span class="ruby-constant">Log</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-value str">&quot;Starting Windows Service Daemon&quot;</span>)
 158 14:
 159 15:       <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">running?</span>
 160 16:         <span class="ruby-constant">Runner</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">nil</span>).<span class="ruby-identifier">run</span>
 161 17:       <span class="ruby-keyword kw">end</span>
 162 18:     <span class="ruby-keyword kw">end</span>
 163 </pre>
 164           </div>
 165         </div>
 166       </div>
 167
 168       <div id="method-M000375" class="method-detail">
 169         <a name="M000375"></a>
 170
 171         <div class="method-heading">
 172           <a href="#M000375" class="method-signature">
 173           <span class="method-name">service_stop</span><span class="method-args">()</span>
 174           </a>
 175         </div>
 176
 177         <div class="method-description">
 178           <p><a class="source-toggle" href="#"
 179             onclick="toggleCode('M000375-source');return false;">[Source]</a></p>
 180           <div class="method-source-code" id="M000375-source">
 181 <pre>
 182     <span class="ruby-comment cmt"># File lib/mcollective/windows_daemon.rb, line 20</span>
 183 20:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">service_stop</span>
 184 21:       <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-value str">&quot;Windows service stopping&quot;</span>)
 185 22:     <span class="ruby-keyword kw">end</span>
 186 </pre>
 187           </div>
 188         </div>
 189       </div>
 190
 191
 192     </div>
 193
 194
 195   </div>
 196
 197
 198 <div id="validator-badges">
 199   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 200 </div>
 201
 202 </body>
 203 </html>