RubyGems - passenger - Versions diffs - 3.0.2 → 3.0.3 - Mend

passenger 3.0.2 → 3.0.3

Potentially problematic release.

This version of passenger might be problematic. Click here for more details.

Files changed (220) hide show

data/doc/rdoc/classes/PhusionPassenger/AbstractServer.html ADDED

@@ -0,0 +1,654 @@
+<?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>Class: PhusionPassenger::AbstractServer</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" />
+    <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+        function toggleSource( id )
+        {
+          var elem
+          var link
+          if( document.getElementById )
+          {
+            elem = document.getElementById( id )
+            link = document.getElementById( "l_" + id )
+          }
+          else if ( document.all )
+          {
+            elem = eval( "document.all." + id )
+            link = eval( "document.all.l_" + id )
+          }
+          else
+            return false;
+          if( elem.style.display == "block" )
+          {
+            elem.style.display = "none"
+            link.innerHTML = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
+        }
+      // ]]>
+    </script>
+  </head>
+  <body>
+  <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
+  <td class="file-title"><span class="file-title-prefix">Class</span><br />PhusionPassenger::AbstractServer</td>
+  <td align="right">
+    <table cellspacing="0" cellpadding="2">
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+<a href="../../files/lib/phusion_passenger/abstract_server_rb.html">lib/phusion_passenger/abstract_server.rb</a>
+        </td>
+      </tr>
+    <tr>
+      <td>Parent:</td>
+      <td>
+Object
+     </td>
+   </tr>
+         </table>
+        </td>
+        </tr>
+      </table>
+ <!-- banner header -->
+  <div id="bodyContent">
+      <div id="content">
+  <div class="description"><p>
+An abstract base class for a server that has the following properties:
+</p>
+<ul>
+<li>The server listens on a password protected Unix socket.
+</li>
+<li>The server is multithreaded and handles one client per thread.
+</li>
+<li>The server is owned by one or more processes. If all processes close their
+reference to the server, then the server will quit.
+</li>
+<li>The server&#8216;s main loop may be run in a child process (and so is
+asynchronous from the parent process).
+</li>
+<li>One can communicate with the server through discrete <a
+href="MessageChannel.html">MessageChannel</a> messages, as opposed to byte
+streams.
+</li>
+<li>The server can pass file descriptors (<a href="../IO.html">IO</a> objects)
+back to the client.
+</li>
+</ul>
+<p>
+The server will also reset all signal handlers. That is, it will respond to
+all signals in the default manner. The only exception is SIGHUP, which is
+ignored. One may define additional signal handlers using <a
+href="AbstractServer.html#M000344">define_signal_handler</a>().
+</p>
+<p>
+Before an <a href="AbstractServer.html">AbstractServer</a> can be used, it
+must first be started by calling <a
+href="AbstractServer.html#M000334">start</a>(). When it is no longer
+needed, <a href="AbstractServer.html#M000336">stop</a>() should be called.
+</p>
+<p>
+Here&#8216;s an example on using <a
+href="AbstractServer.html">AbstractServer</a>:
+</p>
+<pre>
+ class MyServer &lt; PhusionPassenger::AbstractServer
+    def initialize
+       super()
+       define_message_handler(:hello, :handle_hello)
+    end
+    def hello(first_name, last_name)
+       connect do |channel|
+          channel.write('hello', first_name, last_name)
+          reply, pointless_number = channel.read
+          puts &quot;The server said: #{reply}&quot;
+          puts &quot;In addition, it sent this pointless number: #{pointless_number}&quot;
+       end
+    end
+ private
+    def handle_hello(channel, first_name, last_name)
+       channel.write(&quot;Hello #{first_name} #{last_name}, how are you?&quot;, 1234)
+    end
+ end
+ server = MyServer.new
+ server.start
+ server.hello(&quot;Joe&quot;, &quot;Dalton&quot;)
+ server.stop
+</pre>
+</div>
+  <div class="sectiontitle">Methods</div>
+  <ul>
+  <li><a href="#M000340">before_fork</a></li>
+  <li><a href="#M000339">connect</a></li>
+  <li><a href="#M000343">define_message_handler</a></li>
+  <li><a href="#M000344">define_signal_handler</a></li>
+  <li><a href="#M000345">fileno_of</a></li>
+  <li><a href="#M000342">finalize_server</a></li>
+  <li><a href="#M000341">initialize_server</a></li>
+  <li><a href="#M000333">new</a></li>
+  <li><a href="#M000338">server_pid</a></li>
+  <li><a href="#M000334">start</a></li>
+  <li><a href="#M000335">start_synchronously</a></li>
+  <li><a href="#M000337">started?</a></li>
+  <li><a href="#M000336">stop</a></li>
+  </ul>
+<div class="sectiontitle">Included Modules</div>
+<ul>
+  <li><a href="Utils.html">Utils</a></li>
+</ul>
+  <div class="sectiontitle">Classes and Modules</div>
+  Class <a href="AbstractServer/InvalidPassword.html" class="link">PhusionPassenger::AbstractServer::InvalidPassword</a><br />
+Class <a href="AbstractServer/ServerAlreadyStarted.html" class="link">PhusionPassenger::AbstractServer::ServerAlreadyStarted</a><br />
+Class <a href="AbstractServer/ServerError.html" class="link">PhusionPassenger::AbstractServer::ServerError</a><br />
+Class <a href="AbstractServer/ServerNotStarted.html" class="link">PhusionPassenger::AbstractServer::ServerNotStarted</a><br />
+Class <a href="AbstractServer/UnknownMessage.html" class="link">PhusionPassenger::AbstractServer::UnknownMessage</a><br />
+  <div class="sectiontitle">Attributes</div>
+  <table border='0' cellpadding='5'>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[RW]
+    </td>
+    <td class='attr-name'>ignore_password_errors</td>
+    <td class='attr-desc'></td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[RW]
+    </td>
+    <td class='attr-name'>max_idle_time</td>
+    <td class='attr-desc'>
+The maximum time that this <a href="AbstractServer.html">AbstractServer</a>
+may be idle. Used by <a
+href="AbstractServerCollection.html">AbstractServerCollection</a> to
+determine when this object should be cleaned up. nil or 0 indicate that
+this object should never be idle cleaned.
+</td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[RW]
+    </td>
+    <td class='attr-name'>next_cleaning_time</td>
+    <td class='attr-desc'>
+Used by <a
+href="AbstractServerCollection.html">AbstractServerCollection</a> to
+remember when this <a href="AbstractServer.html">AbstractServer</a> should
+be idle cleaned.
+</td>
+  </tr>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>password</td>
+    <td class='attr-desc'></td>
+  </tr>
+  </table>
+<div class="sectiontitle">Public Class methods</div>
+<div class="method">
+  <div class="title">
+    <a name="M000333"></a><b>new</b>(socket_filename = nil, password = nil)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000333_source')" id="l_M000333_source">show source</a> ]</p>
+  <div id="M000333_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 116</span>
+116:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">socket_filename</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">password</span> = <span class="ruby-keyword kw">nil</span>)
+117:                 <span class="ruby-ivar">@socket_filename</span> = <span class="ruby-identifier">socket_filename</span>
+118:                 <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
+119:                 <span class="ruby-ivar">@socket_filename</span> <span class="ruby-operator">||=</span> <span class="ruby-node">&quot;#{passenger_tmpdir}/spawn-server/socket.#{Process.pid}.#{object_id}&quot;</span>
+120:                 <span class="ruby-ivar">@password</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">generate_random_id</span>(<span class="ruby-identifier">:base64</span>)
+121:
+122:                 <span class="ruby-ivar">@message_handlers</span> = {}
+123:                 <span class="ruby-ivar">@signal_handlers</span> = {}
+124:                 <span class="ruby-ivar">@orig_signal_handlers</span> = {}
+125:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="sectiontitle">Public Instance methods</div>
+<div class="method">
+  <div class="title">
+    <a name="M000339"></a><b>connect</b>() {|channel| ...}
+  </div>
+  <div class="description">
+  <p>
+Connects to the server and yields a channel for communication. The first
+message&#8216;s name must match a handler name. The connection can only be
+used for a single handler cycle; after the handler is done, the connection
+will be closed.
+</p>
+<pre>
+  server.connect do |channel|
+     channel.write(&quot;a message&quot;)
+     ...
+  end
+</pre>
+<p>
+Raises: SystemCallError, IOError, SocketError
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000339_source')" id="l_M000339_source">show source</a> ]</p>
+  <div id="M000339_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 267</span>
+267:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">connect</span>
+268:                 <span class="ruby-identifier">channel</span> = <span class="ruby-constant">MessageChannel</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">UNIXSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@socket_filename</span>))
+269:                 <span class="ruby-keyword kw">begin</span>
+270:                         <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">write_scalar</span>(<span class="ruby-ivar">@password</span>)
+271:                         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">channel</span>
+272:                 <span class="ruby-keyword kw">ensure</span>
+273:                         <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">close</span>
+274:                 <span class="ruby-keyword kw">end</span>
+275:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000338"></a><b>server_pid</b>()
+  </div>
+  <div class="description">
+  <p>
+Return the PID of the started server. This is only valid if <a
+href="AbstractServer.html#M000334">#start</a> has been called.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000338_source')" id="l_M000338_source">show source</a> ]</p>
+  <div id="M000338_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 252</span>
+252:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">server_pid</span>
+253:                 <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@pid</span>
+254:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000334"></a><b>start</b>()
+  </div>
+  <div class="description">
+  <p>
+Start the server. This method does not block since the server runs
+asynchronously from the current process.
+</p>
+<p>
+You may only call this method if the server is not already started.
+Otherwise, a <a
+href="AbstractServer/ServerAlreadyStarted.html">ServerAlreadyStarted</a>
+will be raised.
+</p>
+<p>
+Derived classes may raise additional exceptions.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000334_source')" id="l_M000334_source">show source</a> ]</p>
+  <div id="M000334_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 134</span>
+134:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
+135:                 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">started?</span>
+136:                         <span class="ruby-identifier">raise</span> <span class="ruby-constant">ServerAlreadyStarted</span>, <span class="ruby-value str">&quot;Server is already started&quot;</span>
+137:                 <span class="ruby-keyword kw">end</span>
+138:
+139:                 <span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span> = <span class="ruby-constant">UNIXSocket</span>.<span class="ruby-identifier">pair</span>
+140:                 <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-ivar">@socket_filename</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
+141:                 <span class="ruby-identifier">server_socket</span> = <span class="ruby-constant">UNIXServer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@socket_filename</span>)
+142:                 <span class="ruby-constant">File</span>.<span class="ruby-identifier">chmod</span>(<span class="ruby-value">0700</span>, <span class="ruby-ivar">@socket_filename</span>)
+143:
+144:                 <span class="ruby-identifier">before_fork</span>
+145:                 <span class="ruby-ivar">@pid</span> = <span class="ruby-identifier">fork</span>
+146:                 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@pid</span>.<span class="ruby-identifier">nil?</span>
+147:                         <span class="ruby-identifier">has_exception</span> = <span class="ruby-keyword kw">false</span>
+148:                         <span class="ruby-keyword kw">begin</span>
+149:                                 <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">sync</span> = <span class="ruby-keyword kw">true</span>
+150:                                 <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">sync</span> = <span class="ruby-keyword kw">true</span>
+151:                                 <span class="ruby-identifier">a</span>.<span class="ruby-identifier">close</span>
+152:
+153:                                 <span class="ruby-comment cmt"># During Passenger's early days, we used to close file descriptors based</span>
+154:                                 <span class="ruby-comment cmt"># on a white list of file descriptors. That proved to be way too fragile:</span>
+155:                                 <span class="ruby-comment cmt"># too many file descriptors are being left open even though they shouldn't</span>
+156:                                 <span class="ruby-comment cmt"># be. So now we close file descriptors based on a black list.</span>
+157:                                 <span class="ruby-comment cmt">#</span>
+158:                                 <span class="ruby-comment cmt"># Note that STDIN, STDOUT and STDERR may be temporarily set to</span>
+159:                                 <span class="ruby-comment cmt"># different file descriptors than 0, 1 and 2, e.g. in unit tests.</span>
+160:                                 <span class="ruby-comment cmt"># We don't want to close these either.</span>
+161:                                 <span class="ruby-identifier">file_descriptors_to_leave_open</span> = [<span class="ruby-value">0</span>, <span class="ruby-value">1</span>, <span class="ruby-value">2</span>,
+162:                                         <span class="ruby-identifier">b</span>.<span class="ruby-identifier">fileno</span>, <span class="ruby-identifier">server_socket</span>.<span class="ruby-identifier">fileno</span>,
+163:                                         <span class="ruby-identifier">fileno_of</span>(<span class="ruby-constant">STDIN</span>), <span class="ruby-identifier">fileno_of</span>(<span class="ruby-constant">STDOUT</span>), <span class="ruby-identifier">fileno_of</span>(<span class="ruby-constant">STDERR</span>)
+164:                                 ].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">uniq</span>
+165:                                 <span class="ruby-constant">NativeSupport</span>.<span class="ruby-identifier">close_all_file_descriptors</span>(<span class="ruby-identifier">file_descriptors_to_leave_open</span>)
+166:                                 <span class="ruby-comment cmt"># In addition to closing the file descriptors, one must also close</span>
+167:                                 <span class="ruby-comment cmt"># the associated IO objects. This is to prevent IO.close from</span>
+168:                                 <span class="ruby-comment cmt"># double-closing already closed file descriptors.</span>
+169:                                 <span class="ruby-identifier">close_all_io_objects_for_fds</span>(<span class="ruby-identifier">file_descriptors_to_leave_open</span>)
+170:
+171:                                 <span class="ruby-comment cmt"># At this point, RubyGems might have open file handles for which</span>
+172:                                 <span class="ruby-comment cmt"># the associated file descriptors have just been closed. This can</span>
+173:                                 <span class="ruby-comment cmt"># result in mysterious 'EBADFD' errors. So we force RubyGems to</span>
+174:                                 <span class="ruby-comment cmt"># clear all open file handles.</span>
+175:                                 <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">clear_paths</span>
+176:
+177:                                 <span class="ruby-comment cmt"># Reseed pseudo-random number generator for security reasons.</span>
+178:                                 <span class="ruby-identifier">srand</span>
+179:
+180:                                 <span class="ruby-identifier">start_synchronously</span>(<span class="ruby-ivar">@socket_filename</span>, <span class="ruby-ivar">@password</span>, <span class="ruby-identifier">server_socket</span>, <span class="ruby-identifier">b</span>)
+181:                         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Interrupt</span>
+182:                                 <span class="ruby-comment cmt"># Do nothing.</span>
+183:                                 <span class="ruby-identifier">has_exception</span> = <span class="ruby-keyword kw">true</span>
+184:                         <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>
+185:                                 <span class="ruby-identifier">has_exception</span> = <span class="ruby-keyword kw">true</span>
+186:                                 <span class="ruby-identifier">print_exception</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">e</span>)
+187:                         <span class="ruby-keyword kw">ensure</span>
+188:                                 <span class="ruby-identifier">exit!</span>(<span class="ruby-identifier">has_exception</span> <span class="ruby-value">? </span><span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>)
+189:                         <span class="ruby-keyword kw">end</span>
+190:                 <span class="ruby-keyword kw">end</span>
+191:                 <span class="ruby-identifier">server_socket</span>.<span class="ruby-identifier">close</span>
+192:                 <span class="ruby-identifier">b</span>.<span class="ruby-identifier">close</span>
+193:                 <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-identifier">a</span>
+194:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000335"></a><b>start_synchronously</b>(socket_filename, password, server_socket, owner_socket)
+  </div>
+  <div class="description">
+  <p>
+Start the server, but in the current process instead of in a child process.
+This method blocks until the server&#8216;s main loop has ended.
+</p>
+<p>
+All hooks will be called, except <a
+href="AbstractServer.html#M000340">before_fork</a>().
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000335_source')" id="l_M000335_source">show source</a> ]</p>
+  <div id="M000335_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 200</span>
+200:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_synchronously</span>(<span class="ruby-identifier">socket_filename</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">server_socket</span>, <span class="ruby-identifier">owner_socket</span>)
+201:                 <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-identifier">owner_socket</span>
+202:                 <span class="ruby-keyword kw">begin</span>
+203:                         <span class="ruby-identifier">reset_signal_handlers</span>
+204:                         <span class="ruby-identifier">initialize_server</span>
+205:                         <span class="ruby-keyword kw">begin</span>
+206:                                 <span class="ruby-identifier">server_main_loop</span>(<span class="ruby-identifier">password</span>, <span class="ruby-identifier">server_socket</span>)
+207:                         <span class="ruby-keyword kw">ensure</span>
+208:                                 <span class="ruby-identifier">finalize_server</span>
+209:                         <span class="ruby-keyword kw">end</span>
+210:                 <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Interrupt</span>
+211:                         <span class="ruby-comment cmt"># Do nothing</span>
+212:                 <span class="ruby-keyword kw">ensure</span>
+213:                         <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-keyword kw">nil</span>
+214:                         <span class="ruby-identifier">revert_signal_handlers</span>
+215:                         <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-identifier">socket_filename</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
+216:                         <span class="ruby-identifier">server_socket</span>.<span class="ruby-identifier">close</span>
+217:                 <span class="ruby-keyword kw">end</span>
+218:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000337"></a><b>started?</b>()
+  </div>
+  <div class="description">
+  <p>
+Return whether the server has been started.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000337_source')" id="l_M000337_source">show source</a> ]</p>
+  <div id="M000337_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 247</span>
+247:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">started?</span>
+248:                 <span class="ruby-keyword kw">return</span> <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-ivar">@owner_socket</span>
+249:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000336"></a><b>stop</b>()
+  </div>
+  <div class="description">
+  <p>
+Stop the server. The server will quit as soon as possible. This method
+waits until the server has been stopped.
+</p>
+<p>
+When calling this method, the server must already be started. If not, a <a
+href="AbstractServer/ServerNotStarted.html">ServerNotStarted</a> will be
+raised.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000336_source')" id="l_M000336_source">show source</a> ]</p>
+  <div id="M000336_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 225</span>
+225:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stop</span>
+226:                 <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">started?</span>
+227:                         <span class="ruby-identifier">raise</span> <span class="ruby-constant">ServerNotStarted</span>, <span class="ruby-value str">&quot;Server is not started&quot;</span>
+228:                 <span class="ruby-keyword kw">end</span>
+229:
+230:                 <span class="ruby-keyword kw">begin</span>
+231:                         <span class="ruby-ivar">@owner_socket</span>.<span class="ruby-identifier">write</span>(<span class="ruby-value str">&quot;x&quot;</span>)
+232:                 <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
+233:                 <span class="ruby-keyword kw">end</span>
+234:                 <span class="ruby-ivar">@owner_socket</span>.<span class="ruby-identifier">close</span>
+235:                 <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-keyword kw">nil</span>
+236:                 <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-ivar">@socket_filename</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
+237:
+238:                 <span class="ruby-comment cmt"># Wait at most 4 seconds for server to exit. If it doesn't do that,</span>
+239:                 <span class="ruby-comment cmt"># we kill it forcefully with SIGKILL.</span>
+240:                 <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-constant">Process</span>.<span class="ruby-identifier">timed_waitpid</span>(<span class="ruby-ivar">@pid</span>, <span class="ruby-value">4</span>)
+241:                         <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'SIGKILL'</span>, <span class="ruby-ivar">@pid</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
+242:                         <span class="ruby-constant">Process</span>.<span class="ruby-identifier">timed_waitpid</span>(<span class="ruby-ivar">@pid</span>, <span class="ruby-value">1</span>)
+243:                 <span class="ruby-keyword kw">end</span>
+244:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="sectiontitle">Protected Instance methods</div>
+<div class="method">
+  <div class="title">
+    <a name="M000340"></a><b>before_fork</b>()
+  </div>
+  <div class="description">
+  <p>
+A hook which is called when the server is being started, just before
+forking a <a href="AbstractServer.html#M000333">new</a> process. The
+default implementation does nothing, this method is supposed to be
+overrided by child classes.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000340_source')" id="l_M000340_source">show source</a> ]</p>
+  <div id="M000340_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 280</span>
+280:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">before_fork</span>
+281:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000343"></a><b>define_message_handler</b>(message_name, handler)
+  </div>
+  <div class="description">
+  <p>
+Define a handler for a message. <em>message_name</em> is the name of the
+message to handle, and <em>handler</em> is the name of a method to be
+called (this may either be a String or a Symbol).
+</p>
+<p>
+A message is just a list of strings, and so <em>handler</em> will be called
+with the message as its arguments, excluding the first element. See also
+the example in the class description.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000343_source')" id="l_M000343_source">show source</a> ]</p>
+  <div id="M000343_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 300</span>
+300:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">define_message_handler</span>(<span class="ruby-identifier">message_name</span>, <span class="ruby-identifier">handler</span>)
+301:                 <span class="ruby-ivar">@message_handlers</span>[<span class="ruby-identifier">message_name</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">handler</span>
+302:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000344"></a><b>define_signal_handler</b>(signal, handler)
+  </div>
+  <div class="description">
+  <p>
+Define a handler for a signal.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000344_source')" id="l_M000344_source">show source</a> ]</p>
+  <div id="M000344_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 305</span>
+305:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">define_signal_handler</span>(<span class="ruby-identifier">signal</span>, <span class="ruby-identifier">handler</span>)
+306:                 <span class="ruby-ivar">@signal_handlers</span>[<span class="ruby-identifier">signal</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">handler</span>
+307:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000345"></a><b>fileno_of</b>(io)
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000345_source')" id="l_M000345_source">show source</a> ]</p>
+  <div id="M000345_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 309</span>
+309:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fileno_of</span>(<span class="ruby-identifier">io</span>)
+310:                 <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">io</span>.<span class="ruby-identifier">fileno</span>
+311:         <span class="ruby-keyword kw">rescue</span>
+312:                 <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
+313:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000342"></a><b>finalize_server</b>()
+  </div>
+  <div class="description">
+  <p>
+A hook which is called when the server is being stopped. This is called in
+the child process, after the main loop has been left. The default
+implementation does nothing, this method is supposed to be overrided by
+child classes.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000342_source')" id="l_M000342_source">show source</a> ]</p>
+  <div id="M000342_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 292</span>
+292:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">finalize_server</span>
+293:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000341"></a><b>initialize_server</b>()
+  </div>
+  <div class="description">
+  <p>
+A hook which is called when the server is being started. This is called in
+the child process, before the main loop is entered. The default
+implementation does nothing, this method is supposed to be overrided by
+child classes.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000341_source')" id="l_M000341_source">show source</a> ]</p>
+  <div id="M000341_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 286</span>
+286:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_server</span>
+287:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+</div>
+  </div>
+    </body>
+</html>