RubyGems - passenger - Versions diffs - 3.0.0.pre1 → 3.0.0.pre2 - Mend

passenger 3.0.0.pre1 → 3.0.0.pre2

Potentially problematic release.

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

Files changed (189) hide show

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

@@ -0,0 +1,619 @@
+<?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::AbstractServerCollection</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::AbstractServerCollection</td>
+  <td align="right">
+    <table cellspacing="0" cellpadding="2">
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+<a href="../../files/lib/phusion_passenger/abstract_server_collection_rb.html">lib/phusion_passenger/abstract_server_collection.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>
+This class maintains a collection of <a
+href="AbstractServer.html">AbstractServer</a> objects. One can add <a
+href="AbstractServerCollection.html#M000314">new</a> <a
+href="AbstractServer.html">AbstractServer</a> objects, or look up existing
+ones via a key. <a
+href="AbstractServerCollection.html">AbstractServerCollection</a> also
+automatically takes care of cleaning up AbstractServers that have been idle
+for too long.
+</p>
+<p>
+This class exists because both <a href="SpawnManager.html">SpawnManager</a>
+and <a
+href="ClassicRails/FrameworkSpawner.html">ClassicRails::FrameworkSpawner</a>
+need this kind of functionality. <a
+href="SpawnManager.html">SpawnManager</a> maintains a collection of <a
+href="ClassicRails/FrameworkSpawner.html">ClassicRails::FrameworkSpawner</a>
+and <a
+href="ClassicRails/ApplicationSpawner.html">ClassicRails::ApplicationSpawner</a>
+objects, while <a
+href="ClassicRails/FrameworkSpawner.html">ClassicRails::FrameworkSpawner</a>
+maintains a collection of <a
+href="ClassicRails/ApplicationSpawner.html">ClassicRails::ApplicationSpawner</a>
+objects.
+</p>
+<p>
+This class is thread-safe as long as the specified thread-safety rules are
+followed.
+</p>
+</div>
+  <div class="sectiontitle">Methods</div>
+  <ul>
+  <li><a href="#M000321">check_idle_servers!</a></li>
+  <li><a href="#M000325">cleanup</a></li>
+  <li><a href="#M000324">clear</a></li>
+  <li><a href="#M000319">delete</a></li>
+  <li><a href="#M000322">each</a></li>
+  <li><a href="#M000323">each_pair</a></li>
+  <li><a href="#M000318">empty?</a></li>
+  <li><a href="#M000317">has_key?</a></li>
+  <li><a href="#M000316">lookup_or_add</a></li>
+  <li><a href="#M000314">new</a></li>
+  <li><a href="#M000320">register_activity</a></li>
+  <li><a href="#M000315">synchronize</a></li>
+  </ul>
+<div class="sectiontitle">Included Modules</div>
+<ul>
+  <li><a href="Utils.html">Utils</a></li>
+</ul>
+  <div class="sectiontitle">Attributes</div>
+  <table border='0' cellpadding='5'>
+  <tr valign='top'>
+    <td class='attr-rw'>
+[R]
+    </td>
+    <td class='attr-name'>next_cleaning_time</td>
+    <td class='attr-desc'></td>
+  </tr>
+  </table>
+<div class="sectiontitle">Public Class methods</div>
+<div class="method">
+  <div class="title">
+    <a name="M000314"></a><b>new</b>()
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000314_source')" id="l_M000314_source">show source</a> ]</p>
+  <div id="M000314_source" class="dyn-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 44</span>
+44:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
+45:                 <span class="ruby-ivar">@collection</span> = {}
+46:                 <span class="ruby-ivar">@lock</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
+47:                 <span class="ruby-ivar">@cleanup_lock</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
+48:                 <span class="ruby-ivar">@cond</span> = <span class="ruby-constant">ConditionVariable</span>.<span class="ruby-identifier">new</span>
+49:                 <span class="ruby-ivar">@done</span> = <span class="ruby-keyword kw">false</span>
+50:
+51:                 <span class="ruby-comment cmt"># The next time the cleaner thread should check for idle servers.</span>
+52:                 <span class="ruby-comment cmt"># The value may be nil, in which case the value will be calculated</span>
+53:                 <span class="ruby-comment cmt"># at the end of the #synchronized block.</span>
+54:                 <span class="ruby-comment cmt">#</span>
+55:                 <span class="ruby-comment cmt"># Invariant:</span>
+56:                 <span class="ruby-comment cmt">#    if value is not nil:</span>
+57:                 <span class="ruby-comment cmt">#       There exists an s in @collection with s.next_cleaning_time == value.</span>
+58:                 <span class="ruby-comment cmt">#       for all s in @collection:</span>
+59:                 <span class="ruby-comment cmt">#          if eligable_for_cleanup?(s):</span>
+60:                 <span class="ruby-comment cmt">#             s.next_cleaning_time &lt;= value</span>
+61:                 <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">60</span> <span class="ruby-operator">*</span> <span class="ruby-value">60</span>
+62:                 <span class="ruby-ivar">@next_cleaning_time_changed</span> = <span class="ruby-keyword kw">false</span>
+63:
+64:                 <span class="ruby-ivar">@cleaner_thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span>
+65:                         <span class="ruby-keyword kw">begin</span>
+66:                                 <span class="ruby-ivar">@lock</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+67:                                         <span class="ruby-identifier">cleaner_thread_main</span>
+68:                                 <span class="ruby-keyword kw">end</span>
+69:                         <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>
+70:                                 <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>)
+71:                         <span class="ruby-keyword kw">end</span>
+72:                 <span class="ruby-keyword kw">end</span>
+73:         <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="M000321"></a><b>check_idle_servers!</b>()
+  </div>
+  <div class="description">
+  <p>
+Tell the cleaner thread to check the collection as soon as possible,
+instead of sleeping until the next scheduled cleaning time.
+</p>
+<p>
+Precondition: this method must NOT be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000321_source')" id="l_M000321_source">show source</a> ]</p>
+  <div id="M000321_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 208</span>
+208:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_idle_servers!</span>
+209:                 <span class="ruby-identifier">must_not_be_in_synchronize_block</span>
+210:                 <span class="ruby-ivar">@lock</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+211:                         <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-value">60</span> <span class="ruby-operator">*</span> <span class="ruby-value">60</span>
+212:                         <span class="ruby-ivar">@cond</span>.<span class="ruby-identifier">signal</span>
+213:                 <span class="ruby-keyword kw">end</span>
+214:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000325"></a><b>cleanup</b>()
+  </div>
+  <div class="description">
+  <p>
+Cleanup all resources used by this <a
+href="AbstractServerCollection.html">AbstractServerCollection</a>. All
+AbstractServers from the collection will be deleted. Each <a
+href="AbstractServer.html">AbstractServer</a> will be stopped, if
+necessary. The background thread which removes idle AbstractServers will be
+stopped.
+</p>
+<p>
+After calling this method, this <a
+href="AbstractServerCollection.html">AbstractServerCollection</a> object
+will become unusable.
+</p>
+<p>
+Precondition: this method must <b>NOT</b> be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000325_source')" id="l_M000325_source">show source</a> ]</p>
+  <div id="M000325_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 260</span>
+260:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cleanup</span>
+261:                 <span class="ruby-identifier">must_not_be_in_synchronize_block</span>
+262:                 <span class="ruby-ivar">@cleanup_lock</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+263:                         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@done</span>
+264:                         <span class="ruby-ivar">@lock</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+265:                                 <span class="ruby-ivar">@done</span> = <span class="ruby-keyword kw">true</span>
+266:                                 <span class="ruby-ivar">@cond</span>.<span class="ruby-identifier">signal</span>
+267:                         <span class="ruby-keyword kw">end</span>
+268:                         <span class="ruby-ivar">@cleaner_thread</span>.<span class="ruby-identifier">join</span>
+269:                         <span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+270:                                 <span class="ruby-identifier">clear</span>
+271:                         <span class="ruby-keyword kw">end</span>
+272:                 <span class="ruby-keyword kw">end</span>
+273:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000324"></a><b>clear</b>()
+  </div>
+  <div class="description">
+  <p>
+Delete all AbstractServers from the collection. Each <a
+href="AbstractServer.html">AbstractServer</a> will be stopped, if
+necessary.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000324_source')" id="l_M000324_source">show source</a> ]</p>
+  <div id="M000324_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 241</span>
+241:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clear</span>
+242:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+243:                 <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
+244:                         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">started?</span>
+245:                                 <span class="ruby-identifier">server</span>.<span class="ruby-identifier">stop</span>
+246:                         <span class="ruby-keyword kw">end</span>
+247:                 <span class="ruby-keyword kw">end</span>
+248:                 <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">clear</span>
+249:                 <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-keyword kw">nil</span>
+250:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000319"></a><b>delete</b>(key)
+  </div>
+  <div class="description">
+  <p>
+Deletes from the collection the <a
+href="AbstractServer.html">AbstractServer</a> that&#8216;s associated with
+the given key. If no such <a href="AbstractServer.html">AbstractServer</a>
+exists, nothing will happen.
+</p>
+<p>
+If the <a href="AbstractServer.html">AbstractServer</a> is started, then it
+will be stopped before deletion.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000319_source')" id="l_M000319_source">show source</a> ]</p>
+  <div id="M000319_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 170</span>
+170:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
+171:                 <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;cleanup() has already been called.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@done</span>
+172:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+173:                 <span class="ruby-identifier">server</span> = <span class="ruby-ivar">@collection</span>[<span class="ruby-identifier">key</span>]
+174:                 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">server</span>
+175:                         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">started?</span>
+176:                                 <span class="ruby-identifier">server</span>.<span class="ruby-identifier">stop</span>
+177:                         <span class="ruby-keyword kw">end</span>
+178:                         <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
+179:                         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span> <span class="ruby-operator">==</span> <span class="ruby-ivar">@next_cleaning_time</span>
+180:                                 <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-keyword kw">nil</span>
+181:                         <span class="ruby-keyword kw">end</span>
+182:                 <span class="ruby-keyword kw">end</span>
+183:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000322"></a><b>each</b>() {|server| ...}
+  </div>
+  <div class="description">
+  <p>
+Iterate over all <a href="AbstractServer.html">AbstractServer</a> objects.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000322_source')" id="l_M000322_source">show source</a> ]</p>
+  <div id="M000322_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 219</span>
+219:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
+220:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+221:                 <span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
+222:                         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">server</span>
+223:                 <span class="ruby-keyword kw">end</span>
+224:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000323"></a><b>each_pair</b>() {|key, server| ...}
+  </div>
+  <div class="description">
+  <p>
+Iterate over all keys and associated <a
+href="AbstractServer.html">AbstractServer</a> objects.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000323_source')" id="l_M000323_source">show source</a> ]</p>
+  <div id="M000323_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 229</span>
+229:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each_pair</span>
+230:                 <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;cleanup() has already been called.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@done</span>
+231:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+232:                 <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
+233:                         <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">server</span>)
+234:                 <span class="ruby-keyword kw">end</span>
+235:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000318"></a><b>empty?</b>()
+  </div>
+  <div class="description">
+  <p>
+Checks whether the collection is empty.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000318_source')" id="l_M000318_source">show source</a> ]</p>
+  <div id="M000318_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 159</span>
+159:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">empty?</span>
+160:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+161:                 <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">empty?</span>
+162:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000317"></a><b>has_key?</b>(key)
+  </div>
+  <div class="description">
+  <p>
+Checks whether there&#8216;s an <a
+href="AbstractServer.html">AbstractServer</a> object associated with the
+given key.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000317_source')" id="l_M000317_source">show source</a> ]</p>
+  <div id="M000317_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 151</span>
+151:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">key</span>)
+152:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+153:                 <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">key</span>)
+154:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000316"></a><b>lookup_or_add</b>(key) {|| ...}
+  </div>
+  <div class="description">
+  <p>
+Lookup and returns an <a href="AbstractServer.html">AbstractServer</a> with
+the given key.
+</p>
+<p>
+If there is no AbstractSerer associated with the given key, then the given
+block will be called. That block must return an <a
+href="AbstractServer.html">AbstractServer</a> object. Then, that object
+will be stored in the collection, and returned.
+</p>
+<p>
+The block must set the &#8216;max_idle_time&#8217; attribute on the <a
+href="AbstractServer.html">AbstractServer</a>. <a
+href="AbstractServerCollection.html">AbstractServerCollection</a>&#8216;s
+idle cleaning interval will be adapted to accomodate with this. Changing
+the value outside this block is not guaranteed to have any effect on the
+idle cleaning interval. A max_idle_time value of nil or 0 means the <a
+href="AbstractServer.html">AbstractServer</a> will never be idle cleaned.
+</p>
+<p>
+If the block raises an exception, then the collection will not be modified,
+and the exception will be propagated.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000316_source')" id="l_M000316_source">show source</a> ]</p>
+  <div id="M000316_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 124</span>
+124:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lookup_or_add</span>(<span class="ruby-identifier">key</span>)
+125:                 <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;cleanup() has already been called.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@done</span>
+126:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+127:                 <span class="ruby-identifier">server</span> = <span class="ruby-ivar">@collection</span>[<span class="ruby-identifier">key</span>]
+128:                 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">server</span>
+129:                         <span class="ruby-identifier">register_activity</span>(<span class="ruby-identifier">server</span>)
+130:                         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">server</span>
+131:                 <span class="ruby-keyword kw">else</span>
+132:                         <span class="ruby-identifier">server</span> = <span class="ruby-keyword kw">yield</span>
+133:                         <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">server</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:start</span>)
+134:                                 <span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-value str">&quot;The block didn't return a valid AbstractServer object.&quot;</span>
+135:                         <span class="ruby-keyword kw">end</span>
+136:                         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">eligable_for_cleanup?</span>(<span class="ruby-identifier">server</span>)
+137:                                 <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">max_idle_time</span>
+138:                                 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@next_cleaning_time</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span> <span class="ruby-operator">&lt;</span> <span class="ruby-ivar">@next_cleaning_time</span>
+139:                                         <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span>
+140:                                         <span class="ruby-ivar">@next_cleaning_time_changed</span> = <span class="ruby-keyword kw">true</span>
+141:                                 <span class="ruby-keyword kw">end</span>
+142:                         <span class="ruby-keyword kw">end</span>
+143:                         <span class="ruby-ivar">@collection</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">server</span>
+144:                         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">server</span>
+145:                 <span class="ruby-keyword kw">end</span>
+146:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000320"></a><b>register_activity</b>(server)
+  </div>
+  <div class="description">
+  <p>
+Notify this <a
+href="AbstractServerCollection.html">AbstractServerCollection</a> that
+<tt>server</tt> has performed an activity. This <a
+href="AbstractServerCollection.html">AbstractServerCollection</a> will
+update the idle information associated with <tt>server</tt> accordingly.
+</p>
+<p>
+<a href="AbstractServerCollection.html#M000316">lookup_or_add</a> already
+automatically updates idle information, so you only need to call this
+method if the time at which the server has performed an activity is not
+close to the time at which <a
+href="AbstractServerCollection.html#M000316">lookup_or_add</a> had been
+called.
+</p>
+<p>
+Precondition: this method must be called within a <a
+href="AbstractServerCollection.html#M000315">#synchronize</a> block.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000320_source')" id="l_M000320_source">show source</a> ]</p>
+  <div id="M000320_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 194</span>
+194:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">register_activity</span>(<span class="ruby-identifier">server</span>)
+195:                 <span class="ruby-identifier">must_be_in_synchronize_block</span>
+196:                 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">eligable_for_cleanup?</span>(<span class="ruby-identifier">server</span>)
+197:                         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span> <span class="ruby-operator">==</span> <span class="ruby-ivar">@next_cleaning_time</span>
+198:                                 <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-keyword kw">nil</span>
+199:                         <span class="ruby-keyword kw">end</span>
+200:                         <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">max_idle_time</span>
+201:                 <span class="ruby-keyword kw">end</span>
+202:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+<div class="method">
+  <div class="title">
+    <a name="M000315"></a><b>synchronize</b>() {|| ...}
+  </div>
+  <div class="description">
+  <p>
+Acquire the lock for this <a
+href="AbstractServerCollection.html">AbstractServerCollection</a> object,
+and run the code within the block. The entire block will be a single atomic
+operation.
+</p>
+  </div>
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000315_source')" id="l_M000315_source">show source</a> ]</p>
+  <div id="M000315_source" class="dyn-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server_collection.rb, line 78</span>
+ 78:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">synchronize</span>
+ 79:                 <span class="ruby-ivar">@lock</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+ 80:                         <span class="ruby-ivar">@in_synchronize_block</span> = <span class="ruby-keyword kw">true</span>
+ 81:                         <span class="ruby-keyword kw">begin</span>
+ 82:                                 <span class="ruby-keyword kw">yield</span>
+ 83:                         <span class="ruby-keyword kw">ensure</span>
+ 84:                                 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@next_cleaning_time</span>.<span class="ruby-identifier">nil?</span>
+ 85:                                         <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
+ 86:                                                 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@next_cleaning_time</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span>
+ 87:                                                    (<span class="ruby-identifier">eligable_for_cleanup?</span>(<span class="ruby-identifier">server</span>) <span class="ruby-operator">&amp;&amp;</span>
+ 88:                                                     <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span> <span class="ruby-operator">&lt;</span> <span class="ruby-ivar">@next_cleaning_time</span>
+ 89:                                                    )
+ 90:                                                         <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">next_cleaning_time</span>
+ 91:                                                 <span class="ruby-keyword kw">end</span>
+ 92:                                         <span class="ruby-keyword kw">end</span>
+ 93:                                         <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@next_cleaning_time</span>.<span class="ruby-identifier">nil?</span>
+ 94:                                                 <span class="ruby-comment cmt"># There are no servers in the collection with an idle timeout.</span>
+ 95:                                                 <span class="ruby-ivar">@next_cleaning_time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">+</span> <span class="ruby-value">60</span> <span class="ruby-operator">*</span> <span class="ruby-value">60</span>
+ 96:                                         <span class="ruby-keyword kw">end</span>
+ 97:                                         <span class="ruby-ivar">@next_cleaning_time_changed</span> = <span class="ruby-keyword kw">true</span>
+ 98:                                 <span class="ruby-keyword kw">end</span>
+ 99:                                 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@next_cleaning_time_changed</span>
+100:                                         <span class="ruby-ivar">@next_cleaning_time_changed</span> = <span class="ruby-keyword kw">false</span>
+101:                                         <span class="ruby-ivar">@cond</span>.<span class="ruby-identifier">signal</span>
+102:                                 <span class="ruby-keyword kw">end</span>
+103:                                 <span class="ruby-ivar">@in_synchronize_block</span> = <span class="ruby-keyword kw">false</span>
+104:                         <span class="ruby-keyword kw">end</span>
+105:                 <span class="ruby-keyword kw">end</span>
+106:         <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+</div>
+</div>
+  </div>
+    </body>
+</html>