pidify 0.1.2-i686-linux → 0.2-i686-linux

data/doc/classes/Pidify.html

@@ -94,14 +94,11 @@ A more useful example:
 </p>
 <pre>
   require 'pidify'
-  require 'daemons'
   Signal.trap('INT') { Pidify.stop; exit }
   module Doer
     def self.start
       puts &quot;starting&quot;
-      raise &quot;Failed to start: already running (PID file exists).&quot; if Pidify.running?
-      Daemons.daemonize
-      Pidify.start
+      Pidify.start_as_daemon
       loop do
         puts &quot;hello world&quot;
         sleep 1
@@ -126,15 +123,19 @@ A more useful example:
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000007">delete_pid</a>&nbsp;&nbsp;
-      <a href="#M000005">pid</a>&nbsp;&nbsp;
+      <a href="#M000013">daemonize</a>&nbsp;&nbsp;
+      <a href="#M000008">delete_pid</a>&nbsp;&nbsp;
+      <a href="#M000006">pid</a>&nbsp;&nbsp;
       <a href="#M000001">pid_directory</a>&nbsp;&nbsp;
       <a href="#M000002">pid_directory=</a>&nbsp;&nbsp;
+      <a href="#M000011">pid_end</a>&nbsp;&nbsp;
+      <a href="#M000004">pid_exists?</a>&nbsp;&nbsp;
       <a href="#M000003">pid_file</a>&nbsp;&nbsp;
-      <a href="#M000004">running?</a>&nbsp;&nbsp;
-      <a href="#M000006">save_pid</a>&nbsp;&nbsp;
-      <a href="#M000008">start</a>&nbsp;&nbsp;
-      <a href="#M000009">stop</a>&nbsp;&nbsp;
+      <a href="#M000005">running?</a>&nbsp;&nbsp;
+      <a href="#M000007">save_pid</a>&nbsp;&nbsp;
+      <a href="#M000009">start</a>&nbsp;&nbsp;
+      <a href="#M000012">start_as_daemon</a>&nbsp;&nbsp;
+      <a href="#M000010">stop</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -156,32 +157,56 @@ A more useful example:
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000007" class="method-detail">
-        <a name="M000007"></a>
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
 
         <div class="method-heading">
-          <a href="Pidify.src/M000007.html" target="Code" class="method-signature"
-            onclick="popupCode('Pidify.src/M000007.html');return false;">
+          <a href="Pidify.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000013.html');return false;">
+          <span class="method-name">daemonize</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Daemonizes this process. Does not automatically use a PID file. If you want
+to use a PID file, you must call <a
+href="Pidify.html#M000009">Pidify.start</a> after the call to <a
+href="Pidify.html#M000013">daemonize</a> or use <a
+href="Pidify.html#M000012">Pidify.start_as_daemon</a>.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="Pidify.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000008.html');return false;">
           <span class="method-name">delete_pid</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Deletes the PID file. Calling stop calls this automatically, but will also
-try to send a kill signal to the running process, if it is different from
-this one. BEWARE that this tries to delete whatever file is returned by <a
-href="Pidify.html#M000003">pid_file</a> and does no error checking on it!
+Deletes the PID file. Calling <a href="Pidify.html#M000010">stop</a> calls
+this automatically, but will also try to send a kill signal to the running
+process, if it is different from this one. BEWARE that this tries to delete
+whatever file is returned by <a href="Pidify.html#M000003">pid_file</a> and
+does no error checking on it! Returns true if the delete was successful,
+false if there was an error, and nil if the <a
+href="Pidify.html#M000006">pid</a> file doesn&#8216;t exist.
 </p>
         </div>
       </div>
 
-      <div id="method-M000005" class="method-detail">
-        <a name="M000005"></a>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
 
         <div class="method-heading">
-          <a href="Pidify.src/M000005.html" target="Code" class="method-signature"
-            onclick="popupCode('Pidify.src/M000005.html');return false;">
+          <a href="Pidify.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000006.html');return false;">
           <span class="method-name">pid</span><span class="method-args">()</span>
           </a>
         </div>
@@ -189,7 +214,8 @@ href="Pidify.html#M000003">pid_file</a> and does no error checking on it!
         <div class="method-description">
           <p>
 Returns the PID stored in the <a href="Pidify.html#M000003">pid_file</a>
-(not necessarily the PID of this script).
+(not necessarily the PID of this script). Returns nil if no PID exists or
+if there is a problem with the read.
 </p>
         </div>
       </div>
@@ -224,15 +250,53 @@ Returns the Pathname of the PID storage directory (defaults to /var/run).
         <div class="method-description">
           <p>
 Sets the PID storage directory (defaults to /var/run). Be VERY CAREFUL
-using this, as <a href="Pidify.html#M000007">delete_pid</a> will try to
+using this, as <a href="Pidify.html#M000008">delete_pid</a> will try to
 delete whatever file it thinks is the <a
 href="Pidify.html#M000003">pid_file</a> for this script in the <a
-href="Pidify.html#M000001">pid_directory</a>. It&#8217;s probably a good
+href="Pidify.html#M000001">pid_directory</a>. It&#8216;s probably a good
 idea not to change this at all.
 </p>
         </div>
       </div>
 
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+
+        <div class="method-heading">
+          <a href="Pidify.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000011.html');return false;">
+          <span class="method-name">pid_end</span><span class="method-args">(signals=%w(SIGTERM SIGQUIT SIGKILL), secs_between_signal=4)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Sends each kill signal to the saved PID, pausing for secs_between_signal
+after each to check if it the process remains running. Stops when the
+process has ended or when all signals have been tried. Returns true if the
+process was killed or false otherwise.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="Pidify.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000004.html');return false;">
+          <span class="method-name">pid_exists?</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns true if the <a href="Pidify.html#M000003">pid_file</a> exists for
+this script.
+</p>
+        </div>
+      </div>
+
       <div id="method-M000003" class="method-detail">
         <a name="M000003"></a>
 
@@ -250,29 +314,30 @@ Returns the PID filename as a Pathname.
         </div>
       </div>
 
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
 
         <div class="method-heading">
-          <a href="Pidify.src/M000004.html" target="Code" class="method-signature"
-            onclick="popupCode('Pidify.src/M000004.html');return false;">
+          <a href="Pidify.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000005.html');return false;">
           <span class="method-name">running?</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Returns true if the PID file exists for this script.
+Returns true if the process using <a href="Pidify.html#M000006">pid</a> is
+running.
 </p>
         </div>
       </div>
 
-      <div id="method-M000006" class="method-detail">
-        <a name="M000006"></a>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
 
         <div class="method-heading">
-          <a href="Pidify.src/M000006.html" target="Code" class="method-signature"
-            onclick="popupCode('Pidify.src/M000006.html');return false;">
+          <a href="Pidify.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000007.html');return false;">
           <span class="method-name">save_pid</span><span class="method-args">()</span>
           </a>
         </div>
@@ -280,17 +345,20 @@ Returns true if the PID file exists for this script.
         <div class="method-description">
           <p>
 Saves the PID of this script into the <a
-href="Pidify.html#M000003">pid_file</a>. Automatically called by start.
+href="Pidify.html#M000003">pid_file</a>. Automatically called by <a
+href="Pidify.html#M000009">start</a>. Returns nil if the <a
+href="Pidify.html#M000006">pid</a> file already exists. Returns true if
+successful, false if there was a write problem.
 </p>
         </div>
       </div>
 
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
 
         <div class="method-heading">
-          <a href="Pidify.src/M000008.html" target="Code" class="method-signature"
-            onclick="popupCode('Pidify.src/M000008.html');return false;">
+          <a href="Pidify.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000009.html');return false;">
           <span class="method-name">start</span><span class="method-args">()</span>
           </a>
         </div>
@@ -299,26 +367,48 @@ href="Pidify.html#M000003">pid_file</a>. Automatically called by start.
           <p>
 Saves the PID of this script into the <a
 href="Pidify.html#M000003">pid_file</a> by calling <a
-href="Pidify.html#M000006">save_pid</a>. Raises an exception if running?
-returns false.
+href="Pidify.html#M000007">save_pid</a>. Raises an exception if <a
+href="Pidify.html#M000004">pid_exists?</a> returns false. Returns true if
+successful.
 </p>
         </div>
       </div>
 
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
 
         <div class="method-heading">
-          <a href="Pidify.src/M000009.html" target="Code" class="method-signature"
-            onclick="popupCode('Pidify.src/M000009.html');return false;">
-          <span class="method-name">stop</span><span class="method-args">(signal='SIGINT')</span>
+          <a href="Pidify.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000012.html');return false;">
+          <span class="method-name">start_as_daemon</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Like <a href="Pidify.html#M000009">Pidify.start</a>, but first calls <a
+href="Pidify.html#M000013">Pidify.daemonize</a>. Will fail and raise an
+exception if Pidify.running? returns true.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+
+        <div class="method-heading">
+          <a href="Pidify.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('Pidify.src/M000010.html');return false;">
+          <span class="method-name">stop</span><span class="method-args">(signals=%w(SIGTERM SIGQUIT SIGKILL), secs_between_signal=4)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
 Deletes the saved PID file and, if the PID belongs to a process different
-from this script, sends a kill signal to the saved PID.
+from this script, sends kill signals to the saved PID using <a
+href="Pidify.html#M000011">pid_end</a>. Returns true if the process was
+killed or false otherwise.
 </p>
         </div>
       </div>

data/doc/classes/Pidify.src/M000001.html

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 71</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 77</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pid_directory</span>
       <span class="ruby-ivar">@pid_directory</span>
     <span class="ruby-keyword kw">end</span></pre>

data/doc/classes/Pidify.src/M000002.html

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 79</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 85</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pid_directory=</span>(<span class="ruby-identifier">dir</span>)
       <span class="ruby-ivar">@pid_directory</span> = <span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">dir</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Pathname</span>
       <span class="ruby-ivar">@pid_directory</span> = <span class="ruby-identifier">dir</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Pathname</span>

data/doc/classes/Pidify.src/M000003.html

@@ -10,9 +10,9 @@
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 85</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 91</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pid_file</span>
-      <span class="ruby-ivar">@pid_directory</span> <span class="ruby-operator">+</span> (<span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">$0</span>).<span class="ruby-identifier">basename</span>.<span class="ruby-identifier">to_s</span><span class="ruby-operator">+</span><span class="ruby-value str">'.pid'</span>)
+      <span class="ruby-ivar">@pid_directory</span> <span class="ruby-operator">+</span> (<span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@file_name</span>).<span class="ruby-identifier">basename</span>.<span class="ruby-identifier">to_s</span><span class="ruby-operator">+</span><span class="ruby-value str">'.pid'</span>)
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Pidify.src/M000004.html

@@ -5,13 +5,13 @@
 
 <html>
 <head>
-  <title>running? (Pidify)</title>
+  <title>pid_exists? (Pidify)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 90</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">running?</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 96</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pid_exists?</span>
       <span class="ruby-keyword kw">return</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">pid_file</span>)
     <span class="ruby-keyword kw">end</span></pre>
 </body>

data/doc/classes/Pidify.src/M000005.html

@@ -5,16 +5,20 @@
 
 <html>
 <head>
-  <title>pid (Pidify)</title>
+  <title>running? (Pidify)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 96</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pid</span>
-      <span class="ruby-identifier">dpid</span> = <span class="ruby-keyword kw">nil</span> 
-      <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">pid_file</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dpid</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">gets</span>.<span class="ruby-identifier">chomp</span> }
-      <span class="ruby-identifier">dpid</span>.<span class="ruby-identifier">to_i</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 101</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">running?</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pid_exists?</span>
+      <span class="ruby-keyword kw">begin</span>
+        <span class="ruby-constant">Process</span><span class="ruby-operator">::</span><span class="ruby-identifier">kill</span> <span class="ruby-value">0</span>, <span class="ruby-identifier">pid</span>
+        <span class="ruby-keyword kw">true</span>
+      <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
+        <span class="ruby-keyword kw">false</span>
+      <span class="ruby-keyword kw">end</span> 
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Pidify.src/M000006.html

@@ -5,14 +5,22 @@
 
 <html>
 <head>
-  <title>save_pid (Pidify)</title>
+  <title>pid (Pidify)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 103</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save_pid</span>
-      <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">pid_file</span>, <span class="ruby-value str">'w'</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">$$</span> }
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 114</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pid</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pid_exists?</span>
+      <span class="ruby-identifier">dpid</span> = <span class="ruby-keyword kw">nil</span>
+      <span class="ruby-keyword kw">begin</span>
+        <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">pid_file</span>, <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">RDONLY</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dpid</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">gets</span>.<span class="ruby-identifier">chomp</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">flock</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_SH</span><span class="ruby-operator">|</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_NB</span>); <span class="ruby-identifier">file</span>.<span class="ruby-identifier">flock</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_UN</span>) }
+      <span class="ruby-keyword kw">rescue</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">dpid</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">dpid</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">dpid</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
+      <span class="ruby-keyword kw">nil</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Pidify.src/M000007.html

@@ -5,14 +5,20 @@
 
 <html>
 <head>
-  <title>delete_pid (Pidify)</title>
+  <title>save_pid (Pidify)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 111</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_pid</span>
-      <span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">pid_file</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">exists?</span> <span class="ruby-identifier">pid_file</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 129</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save_pid</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid_exists?</span>
+      <span class="ruby-keyword kw">begin</span>
+        <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">pid_file</span>, <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">CREAT</span><span class="ruby-operator">|</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">EXCL</span><span class="ruby-operator">|</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">WRONLY</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">$$</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">flock</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_EX</span>); <span class="ruby-identifier">file</span>.<span class="ruby-identifier">flock</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_UN</span>) }
+        <span class="ruby-keyword kw">true</span>
+      <span class="ruby-keyword kw">rescue</span>
+        <span class="ruby-keyword kw">false</span>
+      <span class="ruby-keyword kw">end</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Pidify.src/M000008.html

@@ -5,15 +5,21 @@
 
 <html>
 <head>
-  <title>start (Pidify)</title>
+  <title>delete_pid (Pidify)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 117</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
-      <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Failed to start: already running (PID file exists).&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">running?</span>
-      <span class="ruby-identifier">save_pid</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 145</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_pid</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pid_exists?</span>
+      <span class="ruby-keyword kw">begin</span>
+        <span class="ruby-comment cmt"># FIXME: lock first?</span>
+        <span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">pid_file</span>)
+        <span class="ruby-keyword kw">true</span>
+      <span class="ruby-keyword kw">rescue</span>
+        <span class="ruby-keyword kw">false</span>
+      <span class="ruby-keyword kw">end</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Pidify.src/M000009.html

@@ -5,27 +5,15 @@
 
 <html>
 <head>
-  <title>stop (Pidify)</title>
+  <title>start (Pidify)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File pidify.rb, line 124</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stop</span>(<span class="ruby-identifier">signal</span>=<span class="ruby-value str">'SIGINT'</span>)
-      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">running?</span>
-        <span class="ruby-keyword kw">begin</span> 
-          <span class="ruby-identifier">pid</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pid</span>
-          <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span>
-            <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-identifier">signal</span>, <span class="ruby-identifier">pid</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">$$</span>
-            <span class="ruby-identifier">delete_pid</span>
-          <span class="ruby-keyword kw">else</span>
-            <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Failed to stop: no PID found.&quot;</span>
-          <span class="ruby-keyword kw">end</span>
-        <span class="ruby-keyword kw">rescue</span>
-          <span class="ruby-identifier">delete_pid</span>
-          <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Failed to stop: process already stopped; deleted PID file.&quot;</span>
-        <span class="ruby-keyword kw">end</span>
-      <span class="ruby-keyword kw">end</span>
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 159</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
+      <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Failed to start: already running (PID file exists).&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid_exists?</span>
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">save_pid</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/classes/Pidify.src/M000010.html

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>stop (Pidify)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 167</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stop</span>(<span class="ruby-identifier">signals</span>=<span class="ruby-node">%w(SIGTERM SIGQUIT SIGKILL)</span>, <span class="ruby-identifier">secs_between_signal</span>=<span class="ruby-value">4</span>)
+      <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">pid_exists?</span>
+      <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">running?</span>
+        <span class="ruby-identifier">delete_pid</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">pid</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pid</span>
+      <span class="ruby-identifier">killed</span> = <span class="ruby-keyword kw">true</span>
+      <span class="ruby-identifier">killed</span> = <span class="ruby-identifier">pid_end</span>(<span class="ruby-identifier">signals</span>, <span class="ruby-identifier">secs_between_signal</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">pid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">$$</span>
+      <span class="ruby-identifier">delete_pid</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">killed</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">true</span>
+      <span class="ruby-identifier">killed</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Pidify.src/M000011.html

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>pid_end (Pidify)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 184</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pid_end</span>(<span class="ruby-identifier">signals</span>=<span class="ruby-node">%w(SIGTERM SIGQUIT SIGKILL)</span>, <span class="ruby-identifier">secs_between_signal</span>=<span class="ruby-value">4</span>)
+      <span class="ruby-identifier">pid</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">pid</span>
+      <span class="ruby-identifier">signals</span> = [ <span class="ruby-identifier">signals</span> ].<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">sig</span><span class="ruby-operator">|</span> <span class="ruby-identifier">sig</span>.<span class="ruby-identifier">to_s</span>}
+      <span class="ruby-identifier">existed</span> = <span class="ruby-keyword kw">false</span>
+      <span class="ruby-identifier">signals</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sig</span><span class="ruby-operator">|</span>
+        <span class="ruby-keyword kw">begin</span>
+          <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-identifier">sig</span>, <span class="ruby-identifier">pid</span>)
+          <span class="ruby-identifier">existed</span> = <span class="ruby-keyword kw">true</span>
+        <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
+          <span class="ruby-keyword kw">return</span> (<span class="ruby-identifier">existed</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>)
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">running?</span>
+        <span class="ruby-identifier">sleep</span> <span class="ruby-identifier">secs_between_signal</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">running?</span>
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">running?</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Pidify.src/M000012.html

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>start_as_daemon (Pidify)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 204</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_as_daemon</span>
+      <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Failed to start: already running.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">running?</span>
+      <span class="ruby-identifier">daemonize</span>
+      <span class="ruby-identifier">start</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Pidify.src/M000013.html

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>daemonize (Pidify)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File pidify.rb, line 213</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">daemonize</span>
+      <span class="ruby-identifier">fork</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">exit</span>
+      <span class="ruby-constant">Process</span>.<span class="ruby-identifier">setsid</span>
+      <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-value str">'/'</span>
+      <span class="ruby-constant">File</span>.<span class="ruby-identifier">umask</span> <span class="ruby-value">0000</span>
+      <span class="ruby-constant">STDIN</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-value str">&quot;/dev/null&quot;</span>
+      <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-value str">&quot;/dev/null&quot;</span>, <span class="ruby-value str">&quot;a&quot;</span>
+      <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-constant">STDOUT</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/created.rid

@@ -1 +1 @@
-Mon Jan 09 11:53:33 EST 2006
+Tue Nov 07 11:49:54 -0500 2006

data/doc/files/pidify_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Jan 09 11:53:26 EST 2006</td>
+      <td>Tue Nov 07 11:42:34 -0500 2006</td>
     </tr>
     </table>
   </div>
@@ -86,6 +86,15 @@ PID files it creates and maintains.
 See <a href="../classes/Pidify.html">Pidify</a> for more information and
 examples.
 </p>
+<h2>Website</h2>
+<p>
+Documentation: <a
+href="http://pidify.rubyforge.org">pidify.rubyforge.org</a>/
+</p>
+<p>
+Rubyforge page and Download: <a
+href="http://rubyforge.org/projects/pidify">rubyforge.org/projects/pidify</a>/
+</p>
 <h2>Requirements</h2>
 <ul>
 <li>Ruby 1.8

data/doc/fr_method_index.html

@@ -20,15 +20,19 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/Pidify.html#M000007">delete_pid (Pidify)</a><br />
-    <a href="classes/Pidify.html#M000005">pid (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000013">daemonize (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000008">delete_pid (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000006">pid (Pidify)</a><br />
     <a href="classes/Pidify.html#M000001">pid_directory (Pidify)</a><br />
     <a href="classes/Pidify.html#M000002">pid_directory= (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000011">pid_end (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000004">pid_exists? (Pidify)</a><br />
     <a href="classes/Pidify.html#M000003">pid_file (Pidify)</a><br />
-    <a href="classes/Pidify.html#M000004">running? (Pidify)</a><br />
-    <a href="classes/Pidify.html#M000006">save_pid (Pidify)</a><br />
-    <a href="classes/Pidify.html#M000008">start (Pidify)</a><br />
-    <a href="classes/Pidify.html#M000009">stop (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000005">running? (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000007">save_pid (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000009">start (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000012">start_as_daemon (Pidify)</a><br />
+    <a href="classes/Pidify.html#M000010">stop (Pidify)</a><br />
   </div>
 </div>
 </body>

data/lib/pidify.rb

@@ -12,6 +12,14 @@
 # files it creates and maintains. 
 #
 # See Pidify for more information and examples.
+#
+# == Website
+#
+# Documentation:
+# http://pidify.rubyforge.org/
+#
+# Rubyforge page and Download:
+# http://rubyforge.org/projects/pidify/
 # 
 # == Requirements
 #
@@ -40,14 +48,11 @@
 #
 # A more useful example:
 #   require 'pidify'
-#   require 'daemons'
 #   Signal.trap('INT') { Pidify.stop; exit }
 #   module Doer
 #     def self.start
 #       puts "starting"
-#       raise "Failed to start: already running." if Pidify.running?
-#       Daemons.daemonize
-#       Pidify.start
+#       Pidify.start_as_daemon
 #       loop do
 #         puts "hello world"
 #         sleep 1
@@ -193,5 +198,26 @@ module Pidify
       end
       not running?
     end 
+
+    # Like Pidify.start, but first calls Pidify.daemonize.  Will fail and raise
+    # an exception if Pidify.running? returns true.
+    def start_as_daemon
+      raise "Failed to start: already running." if running?
+      daemonize
+      start
+    end
+
+    # Daemonizes this process.  Does not automatically use a PID file.  If you
+    # want to use a PID file, you must call Pidify.start after the call to
+    # daemonize or use Pidify.start_as_daemon.
+    def daemonize
+      fork and exit
+      Process.setsid
+      Dir.chdir '/'
+      File.umask 0000
+      STDIN.reopen "/dev/null"
+      STDOUT.reopen "/dev/null", "a"
+      STDERR.reopen STDOUT
+    end
   end
 end

metadata

@@ -3,13 +3,13 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: pidify
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2006-11-06 00:00:00 -05:00
-summary: This allows a script to check if there is currently another running instance of itself, and give it the ability to kill that instance based on PID.
+  version: "0.2"
+date: 2006-11-07 00:00:00 -05:00
+summary: This allows a script to check if there is currently another running instance of itself (like a daemon), and give it the ability to kill that instance based on PID.
 require_paths: 
 - lib
 email: payton@foolord.com
-homepage: http://foolord.com/
+homepage: http://pidify.rubyforge.org/
 rubyforge_project: 
 description: 
 autorequire: 
@@ -33,13 +33,14 @@ files:
 - doc/classes
 - doc/fr_file_index.html
 - doc/fr_method_index.html
-- doc/rdoc-style.css
 - doc/created.rid
-- doc/index.html
 - doc/fr_class_index.html
+- doc/index.html
+- doc/rdoc-style.css
 - doc/files/pidify_rb.html
 - doc/classes/Pidify.src
 - doc/classes/Pidify.html
+- doc/classes/Pidify.src/M000010.html
 - doc/classes/Pidify.src/M000001.html
 - doc/classes/Pidify.src/M000002.html
 - doc/classes/Pidify.src/M000003.html
@@ -49,6 +50,9 @@ files:
 - doc/classes/Pidify.src/M000007.html
 - doc/classes/Pidify.src/M000008.html
 - doc/classes/Pidify.src/M000009.html
+- doc/classes/Pidify.src/M000011.html
+- doc/classes/Pidify.src/M000012.html
+- doc/classes/Pidify.src/M000013.html
 test_files: []
 
 rdoc_options: []