Update version according to OSCI-856
[packages/precise/mcollective.git] / doc / classes / MCollective / UnixDaemon.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::UnixDaemon</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::UnixDaemon</td>
54         </tr>
55         <tr class="top-aligned-row">
56             <td><strong>In:</strong></td>
57             <td>
58                 <a href="../../files/lib/mcollective/unix_daemon_rb.html">
59                 lib/mcollective/unix_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                 Object
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="#M000423">daemonize</a>&nbsp;&nbsp;
90       <a href="#M000424">daemonize_runner</a>&nbsp;&nbsp;
91       </div>
92     </div>
93
94   </div>
95
96
97     <!-- if includes -->
98
99     <div id="section">
100
101
102
103
104
105       
106
107
108     <!-- if method_list -->
109     <div id="methods">
110       <h3 class="section-bar">Public Class methods</h3>
111
112       <div id="method-M000423" class="method-detail">
113         <a name="M000423"></a>
114
115         <div class="method-heading">
116           <a href="#M000423" class="method-signature">
117           <span class="method-name">daemonize</span><span class="method-args">() {|| ...}</span>
118           </a>
119         </div>
120       
121         <div class="method-description">
122           <p>
123 Daemonize the current process
124 </p>
125           <p><a class="source-toggle" href="#"
126             onclick="toggleCode('M000423-source');return false;">[Source]</a></p>
127           <div class="method-source-code" id="M000423-source">
128 <pre>
129     <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 4</span>
130  4:     <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">daemonize</span>
131  5:       <span class="ruby-identifier">fork</span> <span class="ruby-keyword kw">do</span>
132  6:         <span class="ruby-constant">Process</span>.<span class="ruby-identifier">setsid</span>
133  7:         <span class="ruby-identifier">exit</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fork</span>
134  8:         <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-value str">'/tmp'</span>)
135  9:         <span class="ruby-constant">STDIN</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-value str">'/dev/null'</span>)
136 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>)
137 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>)
138 12: 
139 13:         <span class="ruby-keyword kw">yield</span>
140 14:       <span class="ruby-keyword kw">end</span>
141 15:     <span class="ruby-keyword kw">end</span>
142 </pre>
143           </div>
144         </div>
145       </div>
146
147       <div id="method-M000424" class="method-detail">
148         <a name="M000424"></a>
149
150         <div class="method-heading">
151           <a href="#M000424" class="method-signature">
152           <span class="method-name">daemonize_runner</span><span class="method-args">(pid=nil)</span>
153           </a>
154         </div>
155       
156         <div class="method-description">
157           <p><a class="source-toggle" href="#"
158             onclick="toggleCode('M000424-source');return false;">[Source]</a></p>
159           <div class="method-source-code" id="M000424-source">
160 <pre>
161     <span class="ruby-comment cmt"># File lib/mcollective/unix_daemon.rb, line 17</span>
162 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>)
163 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>
164 19: 
165 20:       <span class="ruby-constant">UnixDaemon</span>.<span class="ruby-identifier">daemonize</span> <span class="ruby-keyword kw">do</span>
166 21:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
167 22:           <span class="ruby-keyword kw">begin</span>
168 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>) }
169 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>
170 25:           <span class="ruby-keyword kw">end</span>
171 26:         <span class="ruby-keyword kw">end</span>
172 27: 
173 28:         <span class="ruby-keyword kw">begin</span>
174 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>)
175 30:           <span class="ruby-identifier">runner</span>.<span class="ruby-identifier">run</span>
176 31:         <span class="ruby-keyword kw">ensure</span>
177 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>)
178 33:         <span class="ruby-keyword kw">end</span>
179 34:       <span class="ruby-keyword kw">end</span>
180 35:     <span class="ruby-keyword kw">end</span>
181 </pre>
182           </div>
183         </div>
184       </div>
185
186
187     </div>
188
189
190   </div>
191
192
193 <div id="validator-badges">
194   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
195 </div>
196
197 </body>
198 </html>