passenger 2.2.9 → 2.2.10

data/doc/cxxapi/PoolOptions_8h-source.html

@@ -10,6 +10,7 @@
     <ul>
       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li><a href="annotated.html"><span>Classes</span></a></li>
       <li class="current"><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -21,289 +22,481 @@
   </div>
 <h1>PoolOptions.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
 <a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
-<a name="l00003"></a>00003 <span class="comment"> *  Copyright (C) 2008  Phusion</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
 <a name="l00004"></a>00004 <span class="comment"> *</span>
-<a name="l00005"></a>00005 <span class="comment"> *  Phusion Passenger is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00005"></a>00005 <span class="comment"> *  "Phusion Passenger" is a trademark of Hongli Lai &amp; Ninh Bui.</span>
 <a name="l00006"></a>00006 <span class="comment"> *</span>
-<a name="l00007"></a>00007 <span class="comment"> *  This program is free software; you can redistribute it and/or modify</span>
-<a name="l00008"></a>00008 <span class="comment"> *  it under the terms of the GNU General Public License as published by</span>
-<a name="l00009"></a>00009 <span class="comment"> *  the Free Software Foundation; version 2 of the License.</span>
-<a name="l00010"></a>00010 <span class="comment"> *</span>
-<a name="l00011"></a>00011 <span class="comment"> *  This program is distributed in the hope that it will be useful,</span>
-<a name="l00012"></a>00012 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
-<a name="l00013"></a>00013 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
-<a name="l00014"></a>00014 <span class="comment"> *  GNU General Public License for more details.</span>
-<a name="l00015"></a>00015 <span class="comment"> *</span>
-<a name="l00016"></a>00016 <span class="comment"> *  You should have received a copy of the GNU General Public License along</span>
-<a name="l00017"></a>00017 <span class="comment"> *  with this program; if not, write to the Free Software Foundation, Inc.,</span>
-<a name="l00018"></a>00018 <span class="comment"> *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
-<a name="l00019"></a>00019 <span class="comment"> */</span>
-<a name="l00020"></a>00020 <span class="preprocessor">#ifndef _PASSENGER_SPAWN_OPTIONS_H_</span>
-<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_SPAWN_OPTIONS_H_</span>
-<a name="l00022"></a>00022 <span class="preprocessor"></span>
-<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;string&gt;</span>
-<a name="l00024"></a>00024 <span class="preprocessor">#include "Utils.h"</span>
-<a name="l00025"></a>00025 
-<a name="l00026"></a>00026 <span class="keyword">namespace </span>Passenger {
-<a name="l00027"></a>00027 
-<a name="l00028"></a>00028 <span class="keyword">using namespace </span>std;
-<a name="l00029"></a>00029 <span class="comment"></span>
-<a name="l00030"></a>00030 <span class="comment">/**</span>
-<a name="l00031"></a>00031 <span class="comment"> * This struct encapsulates information for ApplicationPool::get() and for</span>
-<a name="l00032"></a>00032 <span class="comment"> * SpawnManager::spawn(), such as which application is to be spawned.</span>
-<a name="l00033"></a>00033 <span class="comment"> *</span>
-<a name="l00034"></a>00034 <span class="comment"> * &lt;h2&gt;Notes on privilege lowering support&lt;/h2&gt;</span>
-<a name="l00035"></a>00035 <span class="comment"> *</span>
-<a name="l00036"></a>00036 <span class="comment"> * If &lt;tt&gt;lowerPrivilege&lt;/tt&gt; is true, then it will be attempt to</span>
-<a name="l00037"></a>00037 <span class="comment"> * switch the spawned application instance to the user who owns the</span>
-<a name="l00038"></a>00038 <span class="comment"> * application's &lt;tt&gt;config/environment.rb&lt;/tt&gt;, and to the default</span>
-<a name="l00039"></a>00039 <span class="comment"> * group of that user.</span>
-<a name="l00040"></a>00040 <span class="comment"> *</span>
-<a name="l00041"></a>00041 <span class="comment"> * If that user doesn't exist on the system, or if that user is root,</span>
-<a name="l00042"></a>00042 <span class="comment"> * then it will be attempted to switch to the username given by</span>
-<a name="l00043"></a>00043 <span class="comment"> * &lt;tt&gt;lowestUser&lt;/tt&gt; (and to the default group of that user).</span>
-<a name="l00044"></a>00044 <span class="comment"> * If &lt;tt&gt;lowestUser&lt;/tt&gt; doesn't exist either, or if switching user failed</span>
-<a name="l00045"></a>00045 <span class="comment"> * (because the spawn server process does not have the privilege to do so),</span>
-<a name="l00046"></a>00046 <span class="comment"> * then the application will be spawned anyway, without reporting an error.</span>
-<a name="l00047"></a>00047 <span class="comment"> *</span>
-<a name="l00048"></a>00048 <span class="comment"> * It goes without saying that lowering privilege is only possible if</span>
-<a name="l00049"></a>00049 <span class="comment"> * the spawn server is running as root (and thus, by induction, that</span>
-<a name="l00050"></a>00050 <span class="comment"> * Phusion Passenger and Apache's control process are also running as root).</span>
-<a name="l00051"></a>00051 <span class="comment"> * Note that if Apache is listening on port 80, then its control process must</span>
-<a name="l00052"></a>00052 <span class="comment"> * be running as root. See "doc/Security of user switching.txt" for</span>
-<a name="l00053"></a>00053 <span class="comment"> * a detailed explanation.</span>
-<a name="l00054"></a>00054 <span class="comment"> */</span>
-<a name="l00055"></a><a class="code" href="structPassenger_1_1PoolOptions.html">00055</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1PoolOptions.html" title="This struct encapsulates information for ApplicationPool::get() and for SpawnManager::spawn()...">PoolOptions</a> {<span class="comment"></span>
-<a name="l00056"></a>00056 <span class="comment">        /**</span>
-<a name="l00057"></a>00057 <span class="comment">         * The root directory of the application to spawn. In case of a Ruby on Rails</span>
-<a name="l00058"></a>00058 <span class="comment">         * application, this is the folder that contains 'app/', 'public/', 'config/',</span>
-<a name="l00059"></a>00059 <span class="comment">         * etc. This must be a valid directory, but the path does not have to be absolute.</span>
-<a name="l00060"></a>00060 <span class="comment">         */</span>
-<a name="l00061"></a><a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3">00061</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3" title="The root directory of the application to spawn.">appRoot</a>;
-<a name="l00062"></a>00062         <span class="comment"></span>
-<a name="l00063"></a>00063 <span class="comment">        /** Whether to lower the application's privileges. */</span>
-<a name="l00064"></a><a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db">00064</a>         <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db" title="Whether to lower the application&amp;#39;s privileges.">lowerPrivilege</a>;
-<a name="l00065"></a>00065         <span class="comment"></span>
-<a name="l00066"></a>00066 <span class="comment">        /**</span>
-<a name="l00067"></a>00067 <span class="comment">         * The user to fallback to if lowering privilege fails.</span>
-<a name="l00068"></a>00068 <span class="comment">         */</span>
-<a name="l00069"></a><a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a">00069</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a" title="The user to fallback to if lowering privilege fails.">lowestUser</a>;
-<a name="l00070"></a>00070         <span class="comment"></span>
-<a name="l00071"></a>00071 <span class="comment">        /**</span>
-<a name="l00072"></a>00072 <span class="comment">         * The RAILS_ENV/RACK_ENV environment that should be used. May not be an</span>
-<a name="l00073"></a>00073 <span class="comment">         * empty string.</span>
-<a name="l00074"></a>00074 <span class="comment">         */</span>
-<a name="l00075"></a><a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc">00075</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>;
-<a name="l00076"></a>00076         <span class="comment"></span>
-<a name="l00077"></a>00077 <span class="comment">        /**</span>
-<a name="l00078"></a>00078 <span class="comment">         * The spawn method to use. Either "smart" or "conservative". See the Ruby</span>
-<a name="l00079"></a>00079 <span class="comment">         * class &lt;tt&gt;SpawnManager&lt;/tt&gt; for details.</span>
-<a name="l00080"></a>00080 <span class="comment">         */</span>
-<a name="l00081"></a><a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e">00081</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="The spawn method to use.">spawnMethod</a>;
-<a name="l00082"></a>00082         <span class="comment"></span>
-<a name="l00083"></a>00083 <span class="comment">        /** The application type. Either "rails", "rack" or "wsgi". */</span>
-<a name="l00084"></a><a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9">00084</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>;
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the "Software"), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_SPAWN_OPTIONS_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_SPAWN_OPTIONS_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;vector&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include "Account.h"</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include "Logging.h"</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include "Constants.h"</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include "StringListCreator.h"</span>
+<a name="l00034"></a>00034 
+<a name="l00035"></a>00035 <span class="keyword">namespace </span>Passenger {
+<a name="l00036"></a>00036 
+<a name="l00037"></a>00037 <span class="keyword">using namespace </span>std;
+<a name="l00038"></a>00038 <span class="comment"></span>
+<a name="l00039"></a>00039 <span class="comment">/**</span>
+<a name="l00040"></a>00040 <span class="comment"> * This struct encapsulates information for ApplicationPool::get() and for</span>
+<a name="l00041"></a>00041 <span class="comment"> * SpawnManager::spawn(), such as which application is to be spawned.</span>
+<a name="l00042"></a>00042 <span class="comment"> *</span>
+<a name="l00043"></a>00043 <span class="comment"> * &lt;h2&gt;Privilege lowering support&lt;/h2&gt;</span>
+<a name="l00044"></a>00044 <span class="comment"> *</span>
+<a name="l00045"></a>00045 <span class="comment"> * If &lt;em&gt;user&lt;/em&gt; is given and isn't the empty string, then the application process</span>
+<a name="l00046"></a>00046 <span class="comment"> * will run as the given username. Otherwise, the owner of the application's startup</span>
+<a name="l00047"></a>00047 <span class="comment"> * file (e.g. config/environment.rb or config.ru) will be used.</span>
+<a name="l00048"></a>00048 <span class="comment"> *</span>
+<a name="l00049"></a>00049 <span class="comment"> * If &lt;em&gt;group&lt;/em&gt; is given and isn't the empty string, then the application process</span>
+<a name="l00050"></a>00050 <span class="comment"> * will run as the given group name. If it's set to the special value</span>
+<a name="l00051"></a>00051 <span class="comment"> * "!STARTUP_FILE!", then the startup file's group will be used. Otherwise,</span>
+<a name="l00052"></a>00052 <span class="comment"> * the primary group of the user that the application process will run as,</span>
+<a name="l00053"></a>00053 <span class="comment"> * will be used as group.</span>
+<a name="l00054"></a>00054 <span class="comment"> * </span>
+<a name="l00055"></a>00055 <span class="comment"> * If the user or group that the application process attempts to switch to</span>
+<a name="l00056"></a>00056 <span class="comment"> * doesn't exist, then &lt;em&gt;default_user&lt;/em&gt; and &lt;em&gt;default_group&lt;/em&gt;, respectively,</span>
+<a name="l00057"></a>00057 <span class="comment"> * will be used.</span>
+<a name="l00058"></a>00058 <span class="comment"> * </span>
+<a name="l00059"></a>00059 <span class="comment"> * Phusion Passenger will attempt to avoid running the application process as</span>
+<a name="l00060"></a>00060 <span class="comment"> * root: if &lt;em&gt;user&lt;/em&gt; or &lt;em&gt;group&lt;/em&gt; is set to the root user or the root group,</span>
+<a name="l00061"></a>00061 <span class="comment"> * or if the startup file is owned by root, then &lt;em&gt;default_user&lt;/em&gt; and</span>
+<a name="l00062"></a>00062 <span class="comment"> * &lt;em&gt;default_group&lt;/em&gt; will be used instead.</span>
+<a name="l00063"></a>00063 <span class="comment"> * </span>
+<a name="l00064"></a>00064 <span class="comment"> * All this only happen if Phusion Passenger has root privileges. If not, then</span>
+<a name="l00065"></a>00065 <span class="comment"> * these options have no effect.</span>
+<a name="l00066"></a>00066 <span class="comment"> */</span>
+<a name="l00067"></a><a class="code" href="structPassenger_1_1PoolOptions.html">00067</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1PoolOptions.html" title="This struct encapsulates information for ApplicationPool::get() and for SpawnManager::spawn()...">PoolOptions</a> {<span class="comment"></span>
+<a name="l00068"></a>00068 <span class="comment">        /**</span>
+<a name="l00069"></a>00069 <span class="comment">         * The root directory of the application to spawn. In case of a Ruby on Rails</span>
+<a name="l00070"></a>00070 <span class="comment">         * application, this is the folder that contains 'app/', 'public/', 'config/',</span>
+<a name="l00071"></a>00071 <span class="comment">         * etc. This must be a valid directory, but the path does not have to be absolute.</span>
+<a name="l00072"></a>00072 <span class="comment">         */</span>
+<a name="l00073"></a><a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3">00073</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3" title="The root directory of the application to spawn.">appRoot</a>;
+<a name="l00074"></a>00074         <span class="comment"></span>
+<a name="l00075"></a>00075 <span class="comment">        /**</span>
+<a name="l00076"></a>00076 <span class="comment">         * A name used by ApplicationPool to uniquely identify an application.</span>
+<a name="l00077"></a>00077 <span class="comment">         * If one tries to get() from the application pool with name "A", then get()</span>
+<a name="l00078"></a>00078 <span class="comment">         * again with name "B", then the latter will spawn a new application process,</span>
+<a name="l00079"></a>00079 <span class="comment">         * even if both get() requests have the same app root.</span>
+<a name="l00080"></a>00080 <span class="comment">         *</span>
+<a name="l00081"></a>00081 <span class="comment">         * If left empty (the default), then the app root is used as the app group</span>
+<a name="l00082"></a>00082 <span class="comment">         * name.</span>
+<a name="l00083"></a>00083 <span class="comment">         */</span>
+<a name="l00084"></a><a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf">00084</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf" title="A name used by ApplicationPool to uniquely identify an application.">appGroupName</a>;
 <a name="l00085"></a>00085         <span class="comment"></span>
-<a name="l00086"></a>00086 <span class="comment">        /**</span>
-<a name="l00087"></a>00087 <span class="comment">         * The idle timeout, in seconds, of Rails framework spawners.</span>
-<a name="l00088"></a>00088 <span class="comment">         * A timeout of 0 means that the framework spawner should never idle timeout. A timeout</span>
-<a name="l00089"></a>00089 <span class="comment">         * of -1 means that the default timeout value should be used.</span>
-<a name="l00090"></a>00090 <span class="comment">         *</span>
-<a name="l00091"></a>00091 <span class="comment">         * For more details about Rails framework spawners, please</span>
-<a name="l00092"></a>00092 <span class="comment">         * read the documentation on the Railz::FrameworkSpawner</span>
-<a name="l00093"></a>00093 <span class="comment">         * Ruby class.</span>
-<a name="l00094"></a>00094 <span class="comment">         */</span>
-<a name="l00095"></a><a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70">00095</a>         <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of Rails framework spawners.">frameworkSpawnerTimeout</a>;
-<a name="l00096"></a>00096         <span class="comment"></span>
-<a name="l00097"></a>00097 <span class="comment">        /**</span>
-<a name="l00098"></a>00098 <span class="comment">         * The idle timeout, in seconds, of Rails application spawners.</span>
-<a name="l00099"></a>00099 <span class="comment">         * A timeout of 0 means that the application spawner should never idle timeout. A timeout</span>
-<a name="l00100"></a>00100 <span class="comment">         * of -1 means that the default timeout value should be used.</span>
-<a name="l00101"></a>00101 <span class="comment">         *</span>
-<a name="l00102"></a>00102 <span class="comment">         * For more details about Rails application spawners, please</span>
-<a name="l00103"></a>00103 <span class="comment">         * read the documentation on the Railz::ApplicationSpawner</span>
-<a name="l00104"></a>00104 <span class="comment">         * Ruby class.</span>
-<a name="l00105"></a>00105 <span class="comment">         */</span>
-<a name="l00106"></a><a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf">00106</a>         <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of Rails application spawners.">appSpawnerTimeout</a>;
-<a name="l00107"></a>00107         <span class="comment"></span>
-<a name="l00108"></a>00108 <span class="comment">        /**</span>
-<a name="l00109"></a>00109 <span class="comment">         * The maximum number of requests that the spawned application may process</span>
-<a name="l00110"></a>00110 <span class="comment">         * before exiting. A value of 0 means unlimited.</span>
-<a name="l00111"></a>00111 <span class="comment">         */</span>
-<a name="l00112"></a><a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0">00112</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>;
-<a name="l00113"></a>00113         <span class="comment"></span>
-<a name="l00114"></a>00114 <span class="comment">        /**</span>
-<a name="l00115"></a>00115 <span class="comment">         * The maximum amount of memory (in MB) the spawned application may use.</span>
-<a name="l00116"></a>00116 <span class="comment">         * A value of 0 means unlimited.</span>
-<a name="l00117"></a>00117 <span class="comment">         */</span>
-<a name="l00118"></a><a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd">00118</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd" title="The maximum amount of memory (in MB) the spawned application may use.">memoryLimit</a>;
-<a name="l00119"></a>00119         <span class="comment"></span>
-<a name="l00120"></a>00120 <span class="comment">        /**</span>
-<a name="l00121"></a>00121 <span class="comment">         * Whether to use a global queue instead of a per-backend process</span>
-<a name="l00122"></a>00122 <span class="comment">         * queue. This option is only used by ApplicationPool::get().</span>
-<a name="l00123"></a>00123 <span class="comment">         *</span>
-<a name="l00124"></a>00124 <span class="comment">         * If enabled, when all backend processes are active, get() will</span>
-<a name="l00125"></a>00125 <span class="comment">         * wait until there's at least one backend process that's idle, instead</span>
-<a name="l00126"></a>00126 <span class="comment">         * of queuing the request into a random process's private queue.</span>
-<a name="l00127"></a>00127 <span class="comment">         * This is especially useful if a website has one or more long-running</span>
-<a name="l00128"></a>00128 <span class="comment">         * requests.</span>
-<a name="l00129"></a>00129 <span class="comment">         */</span>
-<a name="l00130"></a><a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e">00130</a>         <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>;
-<a name="l00131"></a>00131         <span class="comment"></span>
-<a name="l00132"></a>00132 <span class="comment">        /**</span>
-<a name="l00133"></a>00133 <span class="comment">         * A throttling rate for file stats. When set to a non-zero value N,</span>
-<a name="l00134"></a>00134 <span class="comment">         * restart.txt and other files which are usually stat()ted on every</span>
-<a name="l00135"></a>00135 <span class="comment">         * ApplicationPool::get() call will be stat()ed at most every N seconds.</span>
-<a name="l00136"></a>00136 <span class="comment">         */</span>
-<a name="l00137"></a><a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d">00137</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>;
-<a name="l00138"></a>00138         <span class="comment"></span>
-<a name="l00139"></a>00139 <span class="comment">        /**</span>
-<a name="l00140"></a>00140 <span class="comment">         * The directory which contains restart.txt and always_restart.txt.</span>
-<a name="l00141"></a>00141 <span class="comment">         * An empty string means that the default directory should be used.</span>
-<a name="l00142"></a>00142 <span class="comment">         */</span>
-<a name="l00143"></a><a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5">00143</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>;
-<a name="l00144"></a>00144         <span class="comment"></span>
-<a name="l00145"></a>00145 <span class="comment">        /**</span>
-<a name="l00146"></a>00146 <span class="comment">         * Creates a new PoolOptions object with the default values filled in.</span>
-<a name="l00147"></a>00147 <span class="comment">         * One must still set appRoot manually, after having used this constructor.</span>
-<a name="l00148"></a>00148 <span class="comment">         */</span>
-<a name="l00149"></a><a class="code" href="structPassenger_1_1PoolOptions.html#b2b7c72144c108657e3ad4ac9f6e26f4">00149</a>         <a class="code" href="structPassenger_1_1PoolOptions.html#b2b7c72144c108657e3ad4ac9f6e26f4" title="Creates a new PoolOptions object with the default values filled in.">PoolOptions</a>() {
-<a name="l00150"></a>00150                 <a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db" title="Whether to lower the application&amp;#39;s privileges.">lowerPrivilege</a> = <span class="keyword">true</span>;
-<a name="l00151"></a>00151                 <a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a" title="The user to fallback to if lowering privilege fails.">lowestUser</a>     = <span class="stringliteral">"nobody"</span>;
-<a name="l00152"></a>00152                 <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>    = <span class="stringliteral">"production"</span>;
-<a name="l00153"></a>00153                 <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="The spawn method to use.">spawnMethod</a>    = <span class="stringliteral">"smart"</span>;
-<a name="l00154"></a>00154                 <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>        = <span class="stringliteral">"rails"</span>;
-<a name="l00155"></a>00155                 <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of Rails framework spawners.">frameworkSpawnerTimeout</a> = -1;
-<a name="l00156"></a>00156                 <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of Rails application spawners.">appSpawnerTimeout</a>       = -1;
-<a name="l00157"></a>00157                 <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>    = 0;
-<a name="l00158"></a>00158                 <a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd" title="The maximum amount of memory (in MB) the spawned application may use.">memoryLimit</a>    = 0;
-<a name="l00159"></a>00159                 <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a> = <span class="keyword">false</span>;
-<a name="l00160"></a>00160                 <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>        = 0;
-<a name="l00161"></a>00161         }
-<a name="l00162"></a>00162         <span class="comment"></span>
-<a name="l00163"></a>00163 <span class="comment">        /**</span>
-<a name="l00164"></a>00164 <span class="comment">         * Creates a new PoolOptions object with the given values.</span>
-<a name="l00165"></a>00165 <span class="comment">         */</span>
-<a name="l00166"></a><a class="code" href="structPassenger_1_1PoolOptions.html#038861a1ee8bda738325c38ce511347d">00166</a>         <a class="code" href="structPassenger_1_1PoolOptions.html#b2b7c72144c108657e3ad4ac9f6e26f4" title="Creates a new PoolOptions object with the default values filled in.">PoolOptions</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3" title="The root directory of the application to spawn.">appRoot</a>,
-<a name="l00167"></a>00167                 <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db" title="Whether to lower the application&amp;#39;s privileges.">lowerPrivilege</a>       = <span class="keyword">true</span>,
-<a name="l00168"></a>00168                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a" title="The user to fallback to if lowering privilege fails.">lowestUser</a>  = <span class="stringliteral">"nobody"</span>,
-<a name="l00169"></a>00169                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a> = <span class="stringliteral">"production"</span>,
-<a name="l00170"></a>00170                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="The spawn method to use.">spawnMethod</a> = <span class="stringliteral">"smart"</span>,
-<a name="l00171"></a>00171                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>     = <span class="stringliteral">"rails"</span>,
-<a name="l00172"></a>00172                 <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of Rails framework spawners.">frameworkSpawnerTimeout</a> = -1,
-<a name="l00173"></a>00173                 <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of Rails application spawners.">appSpawnerTimeout</a>       = -1,
-<a name="l00174"></a>00174                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>    = 0,
-<a name="l00175"></a>00175                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd" title="The maximum amount of memory (in MB) the spawned application may use.">memoryLimit</a>    = 0,
-<a name="l00176"></a>00176                 <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>          = <span class="keyword">false</span>,
-<a name="l00177"></a>00177                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a> = 0,
-<a name="l00178"></a>00178                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>  = <span class="stringliteral">""</span>
-<a name="l00179"></a>00179         ) {
-<a name="l00180"></a>00180                 this-&gt;appRoot        = appRoot;
-<a name="l00181"></a>00181                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db" title="Whether to lower the application&amp;#39;s privileges.">lowerPrivilege</a> = <a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db" title="Whether to lower the application&amp;#39;s privileges.">lowerPrivilege</a>;
-<a name="l00182"></a>00182                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a" title="The user to fallback to if lowering privilege fails.">lowestUser</a>     = <a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a" title="The user to fallback to if lowering privilege fails.">lowestUser</a>;
-<a name="l00183"></a>00183                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>    = <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>;
-<a name="l00184"></a>00184                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="The spawn method to use.">spawnMethod</a>    = <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="The spawn method to use.">spawnMethod</a>;
-<a name="l00185"></a>00185                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>        = <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>;
-<a name="l00186"></a>00186                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of Rails framework spawners.">frameworkSpawnerTimeout</a> = <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of Rails framework spawners.">frameworkSpawnerTimeout</a>;
-<a name="l00187"></a>00187                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of Rails application spawners.">appSpawnerTimeout</a>       = <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of Rails application spawners.">appSpawnerTimeout</a>;
-<a name="l00188"></a>00188                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>    = <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>;
-<a name="l00189"></a>00189                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd" title="The maximum amount of memory (in MB) the spawned application may use.">memoryLimit</a>    = <a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd" title="The maximum amount of memory (in MB) the spawned application may use.">memoryLimit</a>;
-<a name="l00190"></a>00190                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a> = <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>;
-<a name="l00191"></a>00191                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>        = <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>;
-<a name="l00192"></a>00192                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>     = <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>;
-<a name="l00193"></a>00193         }
-<a name="l00194"></a>00194         <span class="comment"></span>
-<a name="l00195"></a>00195 <span class="comment">        /**</span>
-<a name="l00196"></a>00196 <span class="comment">         * Creates a new PoolOptions object from the given string vector.</span>
-<a name="l00197"></a>00197 <span class="comment">         * This vector contains information that's written to by toVector().</span>
-<a name="l00198"></a>00198 <span class="comment">         *</span>
-<a name="l00199"></a>00199 <span class="comment">         * For example:</span>
-<a name="l00200"></a>00200 <span class="comment">         * @code</span>
-<a name="l00201"></a>00201 <span class="comment">         *   PoolOptions options(...);</span>
-<a name="l00202"></a>00202 <span class="comment">         *   vector&lt;string&gt; vec;</span>
-<a name="l00203"></a>00203 <span class="comment">         *</span>
-<a name="l00204"></a>00204 <span class="comment">         *   vec.push_back("my");</span>
-<a name="l00205"></a>00205 <span class="comment">         *   vec.push_back("data");</span>
-<a name="l00206"></a>00206 <span class="comment">         *   options.toVector(vec);  // PoolOptions information will start at index 2.</span>
-<a name="l00207"></a>00207 <span class="comment">         *</span>
-<a name="l00208"></a>00208 <span class="comment">         *   PoolOptions copy(vec, 2);</span>
-<a name="l00209"></a>00209 <span class="comment">         * @endcode</span>
-<a name="l00210"></a>00210 <span class="comment">         *</span>
-<a name="l00211"></a>00211 <span class="comment">         * @param vec The vector containing spawn options information.</span>
-<a name="l00212"></a>00212 <span class="comment">         * @param startIndex The index in vec at which the information starts.</span>
+<a name="l00086"></a>00086 <span class="comment">        /** The application type. Either "rails" (default), "rack" or "wsgi". */</span>
+<a name="l00087"></a><a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9">00087</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>;
+<a name="l00088"></a>00088         <span class="comment"></span>
+<a name="l00089"></a>00089 <span class="comment">        /**</span>
+<a name="l00090"></a>00090 <span class="comment">         * The RAILS_ENV/RACK_ENV environment that should be used. May not be an</span>
+<a name="l00091"></a>00091 <span class="comment">         * empty string. The default is "production".</span>
+<a name="l00092"></a>00092 <span class="comment">         */</span>
+<a name="l00093"></a><a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc">00093</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>;
+<a name="l00094"></a>00094         <span class="comment"></span>
+<a name="l00095"></a>00095 <span class="comment">        /**</span>
+<a name="l00096"></a>00096 <span class="comment">         * Method with which application processes should be spawned. Different methods</span>
+<a name="l00097"></a>00097 <span class="comment">         * have different performance and compatibility properties. Available methods are</span>
+<a name="l00098"></a>00098 <span class="comment">         * "smart-lv2" (default), "smart" and "conservative". The different spawning methods</span>
+<a name="l00099"></a>00099 <span class="comment">         * are explained in the "Spawning methods explained" section of the users guide.</span>
+<a name="l00100"></a>00100 <span class="comment">         */</span>
+<a name="l00101"></a><a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e">00101</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="Method with which application processes should be spawned.">spawnMethod</a>;
+<a name="l00102"></a>00102         <span class="comment"></span>
+<a name="l00103"></a>00103 <span class="comment">        /** See overview. */</span>
+<a name="l00104"></a><a class="code" href="structPassenger_1_1PoolOptions.html#7bb617271b0a61645b17b9815ebf300c">00104</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#7bb617271b0a61645b17b9815ebf300c" title="See overview.">user</a>;<span class="comment"></span>
+<a name="l00105"></a>00105 <span class="comment">        /** See class overview. */</span>
+<a name="l00106"></a><a class="code" href="structPassenger_1_1PoolOptions.html#6292899199727c513fd641d313c42372">00106</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#6292899199727c513fd641d313c42372" title="See class overview.">group</a>;<span class="comment"></span>
+<a name="l00107"></a>00107 <span class="comment">        /** See class overview. Defaults to "nobody". */</span>
+<a name="l00108"></a><a class="code" href="structPassenger_1_1PoolOptions.html#f9e15d356066ebd5f1454dca7937374f">00108</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#f9e15d356066ebd5f1454dca7937374f" title="See class overview.">defaultUser</a>;<span class="comment"></span>
+<a name="l00109"></a>00109 <span class="comment">        /** See class overview. Defaults to the defaultUser's primary group. */</span>
+<a name="l00110"></a><a class="code" href="structPassenger_1_1PoolOptions.html#fdbe6d3418132ff3ca17427778e0948c">00110</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#fdbe6d3418132ff3ca17427778e0948c" title="See class overview.">defaultGroup</a>;
+<a name="l00111"></a>00111         <span class="comment"></span>
+<a name="l00112"></a>00112 <span class="comment">        /**</span>
+<a name="l00113"></a>00113 <span class="comment">         * The idle timeout, in seconds, of framework spawners. See the "Spawning methods</span>
+<a name="l00114"></a>00114 <span class="comment">         * explained" section of the users guide for information about framework spawners.</span>
+<a name="l00115"></a>00115 <span class="comment">         *</span>
+<a name="l00116"></a>00116 <span class="comment">         * A timeout of 0 means that the framework spawner should never idle timeout. A timeout</span>
+<a name="l00117"></a>00117 <span class="comment">         * of -1 means that the default timeout value should be used.</span>
+<a name="l00118"></a>00118 <span class="comment">         */</span>
+<a name="l00119"></a><a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70">00119</a>         <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of framework spawners.">frameworkSpawnerTimeout</a>;
+<a name="l00120"></a>00120         <span class="comment"></span>
+<a name="l00121"></a>00121 <span class="comment">        /**</span>
+<a name="l00122"></a>00122 <span class="comment">         * The idle timeout, in seconds, of application spawners. See the "Spawning methods</span>
+<a name="l00123"></a>00123 <span class="comment">         * explained" section of the users guide for information about application spawners.</span>
+<a name="l00124"></a>00124 <span class="comment">         *</span>
+<a name="l00125"></a>00125 <span class="comment">         * A timeout of 0 means that the application spawner should never idle timeout. A timeout</span>
+<a name="l00126"></a>00126 <span class="comment">         * of -1 means that the default timeout value should be used.</span>
+<a name="l00127"></a>00127 <span class="comment">         */</span>
+<a name="l00128"></a><a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf">00128</a>         <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of application spawners.">appSpawnerTimeout</a>;
+<a name="l00129"></a>00129         <span class="comment"></span>
+<a name="l00130"></a>00130 <span class="comment">        /**</span>
+<a name="l00131"></a>00131 <span class="comment">         * Environment variables which should be passed to the spawned application</span>
+<a name="l00132"></a>00132 <span class="comment">         * process.</span>
+<a name="l00133"></a>00133 <span class="comment">         *</span>
+<a name="l00134"></a>00134 <span class="comment">         * If a new application process is started, then the getItems() method</span>
+<a name="l00135"></a>00135 <span class="comment">         * on this object will be called, which is to return environment</span>
+<a name="l00136"></a>00136 <span class="comment">         * variables that should be passed to the newly spawned backend process.</span>
+<a name="l00137"></a>00137 <span class="comment">         * Odd indices in the resulting array contain keys, even indices contain</span>
+<a name="l00138"></a>00138 <span class="comment">         * the value for the key in the previous index.</span>
+<a name="l00139"></a>00139 <span class="comment">         *</span>
+<a name="l00140"></a>00140 <span class="comment">         * May be set to NULL.</span>
+<a name="l00141"></a>00141 <span class="comment">         *</span>
+<a name="l00142"></a>00142 <span class="comment">         * @invariant environmentVariables.size() is an even number.</span>
+<a name="l00143"></a>00143 <span class="comment">         */</span>
+<a name="l00144"></a><a class="code" href="structPassenger_1_1PoolOptions.html#aa4f5d4ae1534ada8613fbe497a38924">00144</a>         StringListCreatorPtr <a class="code" href="structPassenger_1_1PoolOptions.html#aa4f5d4ae1534ada8613fbe497a38924" title="Environment variables which should be passed to the spawned application process.">environmentVariables</a>;
+<a name="l00145"></a>00145         <span class="comment"></span>
+<a name="l00146"></a>00146 <span class="comment">        /**</span>
+<a name="l00147"></a>00147 <span class="comment">         * The base URI on which the application runs. If the application is</span>
+<a name="l00148"></a>00148 <span class="comment">         * running on the root URI, then this value must be "/".</span>
+<a name="l00149"></a>00149 <span class="comment">         *</span>
+<a name="l00150"></a>00150 <span class="comment">         * @invariant baseURI != ""</span>
+<a name="l00151"></a>00151 <span class="comment">         */</span>
+<a name="l00152"></a><a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192">00152</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192" title="The base URI on which the application runs.">baseURI</a>;
+<a name="l00153"></a>00153         <span class="comment"></span>
+<a name="l00154"></a>00154 <span class="comment">        /**</span>
+<a name="l00155"></a>00155 <span class="comment">         * The maximum number of requests that the spawned application may process</span>
+<a name="l00156"></a>00156 <span class="comment">         * before exiting. A value of 0 means unlimited.</span>
+<a name="l00157"></a>00157 <span class="comment">         */</span>
+<a name="l00158"></a><a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0">00158</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>;
+<a name="l00159"></a>00159         <span class="comment"></span>
+<a name="l00160"></a>00160 <span class="comment">        /**</span>
+<a name="l00161"></a>00161 <span class="comment">         * The minimum number of processes for the current group that the application</span>
+<a name="l00162"></a>00162 <span class="comment">         * pool's cleaner thread should keep around.</span>
+<a name="l00163"></a>00163 <span class="comment">         */</span>
+<a name="l00164"></a><a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1">00164</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1" title="The minimum number of processes for the current group that the application pool&amp;#39;s...">minProcesses</a>;
+<a name="l00165"></a>00165         <span class="comment"></span>
+<a name="l00166"></a>00166 <span class="comment">        /**</span>
+<a name="l00167"></a>00167 <span class="comment">         * Whether to use a global queue instead of a per-backend process</span>
+<a name="l00168"></a>00168 <span class="comment">         * queue. This option is only used by ApplicationPool::get().</span>
+<a name="l00169"></a>00169 <span class="comment">         *</span>
+<a name="l00170"></a>00170 <span class="comment">         * If enabled, when all backend processes are active, get() will</span>
+<a name="l00171"></a>00171 <span class="comment">         * wait until there's at least one backend process that's idle, instead</span>
+<a name="l00172"></a>00172 <span class="comment">         * of queuing the request into a random process's private queue.</span>
+<a name="l00173"></a>00173 <span class="comment">         * This is especially useful if a website has one or more long-running</span>
+<a name="l00174"></a>00174 <span class="comment">         * requests.</span>
+<a name="l00175"></a>00175 <span class="comment">         */</span>
+<a name="l00176"></a><a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e">00176</a>         <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>;
+<a name="l00177"></a>00177         <span class="comment"></span>
+<a name="l00178"></a>00178 <span class="comment">        /**</span>
+<a name="l00179"></a>00179 <span class="comment">         * A throttling rate for file stats. When set to a non-zero value N,</span>
+<a name="l00180"></a>00180 <span class="comment">         * restart.txt and other files which are usually stat()ted on every</span>
+<a name="l00181"></a>00181 <span class="comment">         * ApplicationPool::get() call will be stat()ed at most every N seconds.</span>
+<a name="l00182"></a>00182 <span class="comment">         */</span>
+<a name="l00183"></a><a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d">00183</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>;
+<a name="l00184"></a>00184         <span class="comment"></span>
+<a name="l00185"></a>00185 <span class="comment">        /**</span>
+<a name="l00186"></a>00186 <span class="comment">         * The directory which contains restart.txt and always_restart.txt.</span>
+<a name="l00187"></a>00187 <span class="comment">         * An empty string means that the default directory should be used.</span>
+<a name="l00188"></a>00188 <span class="comment">         */</span>
+<a name="l00189"></a><a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5">00189</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>;
+<a name="l00190"></a>00190         <span class="comment"></span>
+<a name="l00191"></a>00191 <span class="comment">        /**</span>
+<a name="l00192"></a>00192 <span class="comment">         * Any rights that the spawned application process may have. The SpawnManager</span>
+<a name="l00193"></a>00193 <span class="comment">         * will create a new account for each spawned app, and that account will be</span>
+<a name="l00194"></a>00194 <span class="comment">         * assigned these rights.</span>
+<a name="l00195"></a>00195 <span class="comment">         */</span>
+<a name="l00196"></a><a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab">00196</a>         Account::Rights <a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab" title="Any rights that the spawned application process may have.">rights</a>;
+<a name="l00197"></a>00197         <span class="comment"></span>
+<a name="l00198"></a>00198 <span class="comment">        /**</span>
+<a name="l00199"></a>00199 <span class="comment">         * An analytics log object to log things to. May be the null pointer,</span>
+<a name="l00200"></a>00200 <span class="comment">         * in which case analytics logging is disabled.</span>
+<a name="l00201"></a>00201 <span class="comment">         */</span>
+<a name="l00202"></a><a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612">00202</a>         AnalyticsLogPtr <a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a>;
+<a name="l00203"></a>00203         <span class="comment"></span>
+<a name="l00204"></a>00204 <span class="comment">        /**</span>
+<a name="l00205"></a>00205 <span class="comment">         * Whether the session returned by ApplicationPool::Interface::get()</span>
+<a name="l00206"></a>00206 <span class="comment">         * should be automatically initiated. Defaults to true.</span>
+<a name="l00207"></a>00207 <span class="comment">         */</span>
+<a name="l00208"></a><a class="code" href="structPassenger_1_1PoolOptions.html#1709d96d9d5d59ce79c90434a45cb076">00208</a>         <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#1709d96d9d5d59ce79c90434a45cb076" title="Whether the session returned by ApplicationPool::Interface::get() should be automatically...">initiateSession</a>;
+<a name="l00209"></a>00209         <span class="comment"></span>
+<a name="l00210"></a>00210 <span class="comment">        /**</span>
+<a name="l00211"></a>00211 <span class="comment">         * Whether application processes should print exceptions that occurred during</span>
+<a name="l00212"></a>00212 <span class="comment">         * application initialization. Defaults to true.</span>
 <a name="l00213"></a>00213 <span class="comment">         */</span>
-<a name="l00214"></a><a class="code" href="structPassenger_1_1PoolOptions.html#eaa4faa9716475b2592c7506d2834ba6">00214</a>         <a class="code" href="structPassenger_1_1PoolOptions.html#eaa4faa9716475b2592c7506d2834ba6" title="Creates a new PoolOptions object from the given string vector.">PoolOptions</a>(<span class="keyword">const</span> vector&lt;string&gt; &amp;vec, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> startIndex = 0) {
-<a name="l00215"></a>00215                 <a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3" title="The root directory of the application to spawn.">appRoot</a>        = vec[startIndex + 1];
-<a name="l00216"></a>00216                 <a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db" title="Whether to lower the application&amp;#39;s privileges.">lowerPrivilege</a> = vec[startIndex + 3] == <span class="stringliteral">"true"</span>;
-<a name="l00217"></a>00217                 <a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a" title="The user to fallback to if lowering privilege fails.">lowestUser</a>     = vec[startIndex + 5];
-<a name="l00218"></a>00218                 <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>    = vec[startIndex + 7];
-<a name="l00219"></a>00219                 <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="The spawn method to use.">spawnMethod</a>    = vec[startIndex + 9];
-<a name="l00220"></a>00220                 <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>        = vec[startIndex + 11];
-<a name="l00221"></a>00221                 <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of Rails framework spawners.">frameworkSpawnerTimeout</a> = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + 13]);
-<a name="l00222"></a>00222                 <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of Rails application spawners.">appSpawnerTimeout</a>       = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + 15]);
-<a name="l00223"></a>00223                 <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>    = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + 17]);
-<a name="l00224"></a>00224                 <a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd" title="The maximum amount of memory (in MB) the spawned application may use.">memoryLimit</a>    = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + 19]);
-<a name="l00225"></a>00225                 <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a> = vec[startIndex + 21] == <span class="stringliteral">"true"</span>;
-<a name="l00226"></a>00226                 <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a> = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + 23]);
-<a name="l00227"></a>00227                 <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>     = vec[startIndex + 25];
-<a name="l00228"></a>00228         }
-<a name="l00229"></a>00229         <span class="comment"></span>
-<a name="l00230"></a>00230 <span class="comment">        /**</span>
-<a name="l00231"></a>00231 <span class="comment">         * Append the information in this PoolOptions object to the given</span>
-<a name="l00232"></a>00232 <span class="comment">         * string vector. The resulting array could, for example, be used</span>
-<a name="l00233"></a>00233 <span class="comment">         * as a message to be sent to the spawn server.</span>
-<a name="l00234"></a>00234 <span class="comment">         */</span>
-<a name="l00235"></a><a class="code" href="structPassenger_1_1PoolOptions.html#b5e62e9abf7b89b8d3e5cdfb14e9d2af">00235</a>         <span class="keywordtype">void</span> <a class="code" href="structPassenger_1_1PoolOptions.html#b5e62e9abf7b89b8d3e5cdfb14e9d2af" title="Append the information in this PoolOptions object to the given string vector.">toVector</a>(vector&lt;string&gt; &amp;vec)<span class="keyword"> const </span>{
-<a name="l00236"></a>00236                 <span class="keywordflow">if</span> (vec.capacity() &lt; vec.size() + 10) {
-<a name="l00237"></a>00237                         vec.reserve(vec.size() + 10);
-<a name="l00238"></a>00238                 }
-<a name="l00239"></a>00239                 appendKeyValue (vec, <span class="stringliteral">"app_root"</span>,        <a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3" title="The root directory of the application to spawn.">appRoot</a>);
-<a name="l00240"></a>00240                 appendKeyValue (vec, <span class="stringliteral">"lower_privilege"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#7feed1c0a150ffc9bd003f5535d675db" title="Whether to lower the application&amp;#39;s privileges.">lowerPrivilege</a> ? <span class="stringliteral">"true"</span> : <span class="stringliteral">"false"</span>);
-<a name="l00241"></a>00241                 appendKeyValue (vec, <span class="stringliteral">"lowest_user"</span>,     <a class="code" href="structPassenger_1_1PoolOptions.html#ec92a9f5d0a265a77fbfdb549f39557a" title="The user to fallback to if lowering privilege fails.">lowestUser</a>);
-<a name="l00242"></a>00242                 appendKeyValue (vec, <span class="stringliteral">"environment"</span>,     <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>);
-<a name="l00243"></a>00243                 appendKeyValue (vec, <span class="stringliteral">"spawn_method"</span>,    <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="The spawn method to use.">spawnMethod</a>);
-<a name="l00244"></a>00244                 appendKeyValue (vec, <span class="stringliteral">"app_type"</span>,        <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>);
-<a name="l00245"></a>00245                 appendKeyValue2(vec, <span class="stringliteral">"framework_spawner_timeout"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of Rails framework spawners.">frameworkSpawnerTimeout</a>);
-<a name="l00246"></a>00246                 appendKeyValue2(vec, <span class="stringliteral">"app_spawner_timeout"</span>,       <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of Rails application spawners.">appSpawnerTimeout</a>);
-<a name="l00247"></a>00247                 appendKeyValue3(vec, <span class="stringliteral">"max_requests"</span>,    <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>);
-<a name="l00248"></a>00248                 appendKeyValue3(vec, <span class="stringliteral">"memory_limit"</span>,    <a class="code" href="structPassenger_1_1PoolOptions.html#f61aa527e17a4f2bb5d66260749d17cd" title="The maximum amount of memory (in MB) the spawned application may use.">memoryLimit</a>);
-<a name="l00249"></a>00249                 appendKeyValue (vec, <span class="stringliteral">"use_global_queue"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a> ? <span class="stringliteral">"true"</span> : <span class="stringliteral">"false"</span>);
-<a name="l00250"></a>00250                 appendKeyValue3(vec, <span class="stringliteral">"stat_throttle_rate"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>);
-<a name="l00251"></a>00251                 appendKeyValue (vec, <span class="stringliteral">"restart_dir"</span>,     <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>);
-<a name="l00252"></a>00252         }
-<a name="l00253"></a>00253 
-<a name="l00254"></a>00254 <span class="keyword">private</span>:
-<a name="l00255"></a>00255         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
-<a name="l00256"></a>00256         appendKeyValue(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;value) {
-<a name="l00257"></a>00257                 vec.push_back(key);
-<a name="l00258"></a>00258                 vec.push_back(const_cast&lt;string &amp;&gt;(value));
-<a name="l00259"></a>00259         }
-<a name="l00260"></a>00260         
-<a name="l00261"></a>00261         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
-<a name="l00262"></a>00262         appendKeyValue(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">char</span> *value) {
-<a name="l00263"></a>00263                 vec.push_back(key);
-<a name="l00264"></a>00264                 vec.push_back(value);
-<a name="l00265"></a>00265         }
-<a name="l00266"></a>00266         
-<a name="l00267"></a>00267         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
-<a name="l00268"></a>00268         appendKeyValue2(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">long</span> value) {
-<a name="l00269"></a>00269                 vec.push_back(key);
-<a name="l00270"></a>00270                 vec.push_back(<a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(value));
-<a name="l00271"></a>00271         }
-<a name="l00272"></a>00272         
-<a name="l00273"></a>00273         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
-<a name="l00274"></a>00274         appendKeyValue3(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> value) {
-<a name="l00275"></a>00275                 vec.push_back(key);
-<a name="l00276"></a>00276                 vec.push_back(<a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(value));
-<a name="l00277"></a>00277         }
-<a name="l00278"></a>00278 };
-<a name="l00279"></a>00279 
-<a name="l00280"></a>00280 } <span class="comment">// namespace Passenger</span>
-<a name="l00281"></a>00281 
-<a name="l00282"></a>00282 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SPAWN_OPTIONS_H_ */</span>
-<a name="l00283"></a>00283 
+<a name="l00214"></a><a class="code" href="structPassenger_1_1PoolOptions.html#d3d545cee2806198797fc6b4197ff87b">00214</a>         <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#d3d545cee2806198797fc6b4197ff87b" title="Whether application processes should print exceptions that occurred during application...">printExceptions</a>;
+<a name="l00215"></a>00215         
+<a name="l00216"></a>00216         <span class="comment">/*********************************/</span>
+<a name="l00217"></a>00217         <span class="comment"></span>
+<a name="l00218"></a>00218 <span class="comment">        /**</span>
+<a name="l00219"></a>00219 <span class="comment">         * Creates a new PoolOptions object with the default values filled in.</span>
+<a name="l00220"></a>00220 <span class="comment">         * One must still set appRoot manually, after having used this constructor.</span>
+<a name="l00221"></a>00221 <span class="comment">         */</span>
+<a name="l00222"></a><a class="code" href="structPassenger_1_1PoolOptions.html#b2b7c72144c108657e3ad4ac9f6e26f4">00222</a>         <a class="code" href="structPassenger_1_1PoolOptions.html#b2b7c72144c108657e3ad4ac9f6e26f4" title="Creates a new PoolOptions object with the default values filled in.">PoolOptions</a>() {
+<a name="l00223"></a>00223                 <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>                 = <span class="stringliteral">"rails"</span>;
+<a name="l00224"></a>00224                 <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>             = <span class="stringliteral">"production"</span>;
+<a name="l00225"></a>00225                 <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="Method with which application processes should be spawned.">spawnMethod</a>             = <span class="stringliteral">"smart-lv2"</span>;
+<a name="l00226"></a>00226                 <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of framework spawners.">frameworkSpawnerTimeout</a> = -1;
+<a name="l00227"></a>00227                 <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of application spawners.">appSpawnerTimeout</a>       = -1;
+<a name="l00228"></a>00228                 <a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192" title="The base URI on which the application runs.">baseURI</a>                 = <span class="stringliteral">"/"</span>;
+<a name="l00229"></a>00229                 <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>             = 0;
+<a name="l00230"></a>00230                 <a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1" title="The minimum number of processes for the current group that the application pool&amp;#39;s...">minProcesses</a>            = 0;
+<a name="l00231"></a>00231                 <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>          = <span class="keyword">false</span>;
+<a name="l00232"></a>00232                 <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>        = 0;
+<a name="l00233"></a>00233                 <a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab" title="Any rights that the spawned application process may have.">rights</a>                  = DEFAULT_BACKEND_ACCOUNT_RIGHTS;
+<a name="l00234"></a>00234                 <a class="code" href="structPassenger_1_1PoolOptions.html#1709d96d9d5d59ce79c90434a45cb076" title="Whether the session returned by ApplicationPool::Interface::get() should be automatically...">initiateSession</a>         = <span class="keyword">true</span>;
+<a name="l00235"></a>00235                 <a class="code" href="structPassenger_1_1PoolOptions.html#d3d545cee2806198797fc6b4197ff87b" title="Whether application processes should print exceptions that occurred during application...">printExceptions</a>         = <span class="keyword">true</span>;
+<a name="l00236"></a>00236                 
+<a name="l00237"></a>00237                 <span class="comment">/*********************************/</span>
+<a name="l00238"></a>00238         }
+<a name="l00239"></a>00239         <span class="comment"></span>
+<a name="l00240"></a>00240 <span class="comment">        /**</span>
+<a name="l00241"></a>00241 <span class="comment">         * Creates a new PoolOptions object with the given values.</span>
+<a name="l00242"></a>00242 <span class="comment">         */</span>
+<a name="l00243"></a><a class="code" href="structPassenger_1_1PoolOptions.html#3e80ba601729a1a1eedc33cbc2217949">00243</a>         <a class="code" href="structPassenger_1_1PoolOptions.html#b2b7c72144c108657e3ad4ac9f6e26f4" title="Creates a new PoolOptions object with the default values filled in.">PoolOptions</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#822039d204b48d9ed49184646734acf3" title="The root directory of the application to spawn.">appRoot</a>,
+<a name="l00244"></a>00244                 <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf" title="A name used by ApplicationPool to uniquely identify an application.">appGroupName</a>          = <span class="stringliteral">""</span>,
+<a name="l00245"></a>00245                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>        = <span class="stringliteral">"rails"</span>,
+<a name="l00246"></a>00246                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>    = <span class="stringliteral">"production"</span>,
+<a name="l00247"></a>00247                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="Method with which application processes should be spawned.">spawnMethod</a>    = <span class="stringliteral">"smart-lv2"</span>,
+<a name="l00248"></a>00248                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#7bb617271b0a61645b17b9815ebf300c" title="See overview.">user</a>           = <span class="stringliteral">""</span>,
+<a name="l00249"></a>00249                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#6292899199727c513fd641d313c42372" title="See class overview.">group</a>          = <span class="stringliteral">""</span>,
+<a name="l00250"></a>00250                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#f9e15d356066ebd5f1454dca7937374f" title="See class overview.">defaultUser</a>    = <span class="stringliteral">""</span>,
+<a name="l00251"></a>00251                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#fdbe6d3418132ff3ca17427778e0948c" title="See class overview.">defaultGroup</a>   = <span class="stringliteral">""</span>,
+<a name="l00252"></a>00252                 <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of framework spawners.">frameworkSpawnerTimeout</a> = -1,
+<a name="l00253"></a>00253                 <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of application spawners.">appSpawnerTimeout</a>       = -1,
+<a name="l00254"></a>00254                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192" title="The base URI on which the application runs.">baseURI</a>        = <span class="stringliteral">"/"</span>,
+<a name="l00255"></a>00255                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>    = 0,
+<a name="l00256"></a>00256                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1" title="The minimum number of processes for the current group that the application pool&amp;#39;s...">minProcesses</a>   = 0,
+<a name="l00257"></a>00257                 <span class="keywordtype">bool</span> <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>          = <span class="keyword">false</span>,
+<a name="l00258"></a>00258                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a> = 0,
+<a name="l00259"></a>00259                 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>     = <span class="stringliteral">""</span>,
+<a name="l00260"></a>00260                 Account::Rights <a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab" title="Any rights that the spawned application process may have.">rights</a>       = DEFAULT_BACKEND_ACCOUNT_RIGHTS,
+<a name="l00261"></a>00261                 <span class="keyword">const</span> AnalyticsLogPtr &amp;<a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a>   = AnalyticsLogPtr()
+<a name="l00262"></a>00262         ) {
+<a name="l00263"></a>00263                 this-&gt;appRoot                 = appRoot;
+<a name="l00264"></a>00264                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf" title="A name used by ApplicationPool to uniquely identify an application.">appGroupName</a>            = <a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf" title="A name used by ApplicationPool to uniquely identify an application.">appGroupName</a>;
+<a name="l00265"></a>00265                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>                 = <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>;
+<a name="l00266"></a>00266                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>             = <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>;
+<a name="l00267"></a>00267                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="Method with which application processes should be spawned.">spawnMethod</a>             = <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="Method with which application processes should be spawned.">spawnMethod</a>;
+<a name="l00268"></a>00268                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#7bb617271b0a61645b17b9815ebf300c" title="See overview.">user</a>                    = <a class="code" href="structPassenger_1_1PoolOptions.html#7bb617271b0a61645b17b9815ebf300c" title="See overview.">user</a>;
+<a name="l00269"></a>00269                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#6292899199727c513fd641d313c42372" title="See class overview.">group</a>                   = <a class="code" href="structPassenger_1_1PoolOptions.html#6292899199727c513fd641d313c42372" title="See class overview.">group</a>;
+<a name="l00270"></a>00270                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#f9e15d356066ebd5f1454dca7937374f" title="See class overview.">defaultUser</a>             = <a class="code" href="structPassenger_1_1PoolOptions.html#f9e15d356066ebd5f1454dca7937374f" title="See class overview.">defaultUser</a>;
+<a name="l00271"></a>00271                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#fdbe6d3418132ff3ca17427778e0948c" title="See class overview.">defaultGroup</a>            = <a class="code" href="structPassenger_1_1PoolOptions.html#fdbe6d3418132ff3ca17427778e0948c" title="See class overview.">defaultGroup</a>;
+<a name="l00272"></a>00272                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of framework spawners.">frameworkSpawnerTimeout</a> = <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of framework spawners.">frameworkSpawnerTimeout</a>;
+<a name="l00273"></a>00273                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of application spawners.">appSpawnerTimeout</a>       = <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of application spawners.">appSpawnerTimeout</a>;
+<a name="l00274"></a>00274                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192" title="The base URI on which the application runs.">baseURI</a>                 = <a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192" title="The base URI on which the application runs.">baseURI</a>;
+<a name="l00275"></a>00275                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>             = <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>;
+<a name="l00276"></a>00276                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1" title="The minimum number of processes for the current group that the application pool&amp;#39;s...">minProcesses</a>            = <a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1" title="The minimum number of processes for the current group that the application pool&amp;#39;s...">minProcesses</a>;
+<a name="l00277"></a>00277                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>          = <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>;
+<a name="l00278"></a>00278                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>        = <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>;
+<a name="l00279"></a>00279                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>              = <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>;
+<a name="l00280"></a>00280                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab" title="Any rights that the spawned application process may have.">rights</a>                  = <a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab" title="Any rights that the spawned application process may have.">rights</a>;
+<a name="l00281"></a>00281                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a>                     = <a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a>;
+<a name="l00282"></a>00282                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#1709d96d9d5d59ce79c90434a45cb076" title="Whether the session returned by ApplicationPool::Interface::get() should be automatically...">initiateSession</a>         = <span class="keyword">true</span>;
+<a name="l00283"></a>00283                 this-&gt;<a class="code" href="structPassenger_1_1PoolOptions.html#d3d545cee2806198797fc6b4197ff87b" title="Whether application processes should print exceptions that occurred during application...">printExceptions</a>         = <span class="keyword">true</span>;
+<a name="l00284"></a>00284                 
+<a name="l00285"></a>00285                 <span class="comment">/*********************************/</span>
+<a name="l00286"></a>00286         }
+<a name="l00287"></a>00287         <span class="comment"></span>
+<a name="l00288"></a>00288 <span class="comment">        /**</span>
+<a name="l00289"></a>00289 <span class="comment">         * Creates a new PoolOptions object from the given string vector.</span>
+<a name="l00290"></a>00290 <span class="comment">         * This vector contains information that's written to by toVector().</span>
+<a name="l00291"></a>00291 <span class="comment">         *</span>
+<a name="l00292"></a>00292 <span class="comment">         * For example:</span>
+<a name="l00293"></a>00293 <span class="comment">         * @code</span>
+<a name="l00294"></a>00294 <span class="comment">         *   PoolOptions options(...);</span>
+<a name="l00295"></a>00295 <span class="comment">         *   vector&lt;string&gt; vec;</span>
+<a name="l00296"></a>00296 <span class="comment">         *</span>
+<a name="l00297"></a>00297 <span class="comment">         *   vec.push_back("my");</span>
+<a name="l00298"></a>00298 <span class="comment">         *   vec.push_back("data");</span>
+<a name="l00299"></a>00299 <span class="comment">         *   options.toVector(vec);  // PoolOptions information will start at index 2.</span>
+<a name="l00300"></a>00300 <span class="comment">         *</span>
+<a name="l00301"></a>00301 <span class="comment">         *   PoolOptions copy(vec, 2);</span>
+<a name="l00302"></a>00302 <span class="comment">         * @endcode</span>
+<a name="l00303"></a>00303 <span class="comment">         *</span>
+<a name="l00304"></a>00304 <span class="comment">         * @param vec The vector containing spawn options information.</span>
+<a name="l00305"></a>00305 <span class="comment">         * @param startIndex The index in vec at which the information starts.</span>
+<a name="l00306"></a>00306 <span class="comment">         * @param analyticsLogger If given, and the vector contains logging information,</span>
+<a name="l00307"></a>00307 <span class="comment">         *                        then the 'log' member will be constructed using this logger.</span>
+<a name="l00308"></a>00308 <span class="comment">         */</span>
+<a name="l00309"></a><a class="code" href="structPassenger_1_1PoolOptions.html#0caa024c33da2f68b5c79b41122397b3">00309</a>         <a class="code" href="structPassenger_1_1PoolOptions.html#b2b7c72144c108657e3ad4ac9f6e26f4" title="Creates a new PoolOptions object with the default values filled in.">PoolOptions</a>(<span class="keyword">const</span> vector&lt;string&gt; &amp;vec, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> startIndex = 0,
+<a name="l00310"></a>00310                     AnalyticsLoggerPtr analyticsLogger = AnalyticsLoggerPtr()
+<a name="l00311"></a>00311         ) {
+<a name="l00312"></a>00312                 <span class="keywordtype">int</span> offset = 1;
+<a name="l00313"></a>00313                 <span class="keywordtype">bool</span> hasEnvVars;
+<a name="l00314"></a>00314                 
+<a name="l00315"></a>00315                 appRoot          = vec[startIndex + offset];                 offset += 2;
+<a name="l00316"></a>00316                 <a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf" title="A name used by ApplicationPool to uniquely identify an application.">appGroupName</a>     = vec[startIndex + offset];                 offset += 2;
+<a name="l00317"></a>00317                 <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>          = vec[startIndex + offset];                 offset += 2;
+<a name="l00318"></a>00318                 <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>      = vec[startIndex + offset];                 offset += 2;
+<a name="l00319"></a>00319                 <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="Method with which application processes should be spawned.">spawnMethod</a>      = vec[startIndex + offset];                 offset += 2;
+<a name="l00320"></a>00320                 <a class="code" href="structPassenger_1_1PoolOptions.html#7bb617271b0a61645b17b9815ebf300c" title="See overview.">user</a>             = vec[startIndex + offset];                 offset += 2;
+<a name="l00321"></a>00321                 <a class="code" href="structPassenger_1_1PoolOptions.html#6292899199727c513fd641d313c42372" title="See class overview.">group</a>            = vec[startIndex + offset];                 offset += 2;
+<a name="l00322"></a>00322                 <a class="code" href="structPassenger_1_1PoolOptions.html#f9e15d356066ebd5f1454dca7937374f" title="See class overview.">defaultUser</a>      = vec[startIndex + offset];                 offset += 2;
+<a name="l00323"></a>00323                 <a class="code" href="structPassenger_1_1PoolOptions.html#fdbe6d3418132ff3ca17427778e0948c" title="See class overview.">defaultGroup</a>     = vec[startIndex + offset];                 offset += 2;
+<a name="l00324"></a>00324                 <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of framework spawners.">frameworkSpawnerTimeout</a> = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + offset]);    offset += 2;
+<a name="l00325"></a>00325                 <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of application spawners.">appSpawnerTimeout</a>       = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + offset]);    offset += 2;
+<a name="l00326"></a>00326                 <a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192" title="The base URI on which the application runs.">baseURI</a>          = vec[startIndex + offset];                 offset += 2;
+<a name="l00327"></a>00327                 <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>      = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + offset]);           offset += 2;
+<a name="l00328"></a>00328                 <a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1" title="The minimum number of processes for the current group that the application pool&amp;#39;s...">minProcesses</a>     = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + offset]);           offset += 2;
+<a name="l00329"></a>00329                 <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>   = vec[startIndex + offset] == <span class="stringliteral">"true"</span>;       offset += 2;
+<a name="l00330"></a>00330                 <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a> = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + offset]);           offset += 2;
+<a name="l00331"></a>00331                 <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>       = vec[startIndex + offset];                 offset += 2;
+<a name="l00332"></a>00332                 <a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab" title="Any rights that the spawned application process may have.">rights</a>           = (Account::Rights) <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(vec[startIndex + offset]);
+<a name="l00333"></a>00333                                                                              offset += 2;
+<a name="l00334"></a>00334                 <span class="keywordflow">if</span> (vec[startIndex + offset - 1] == <span class="stringliteral">"analytics_log_group_name"</span>) {
+<a name="l00335"></a>00335                         <span class="keywordflow">if</span> (analyticsLogger != NULL) {
+<a name="l00336"></a>00336                                 <span class="keywordtype">string</span> groupName = vec[startIndex + offset];
+<a name="l00337"></a>00337                                 <span class="keywordtype">string</span> txnId = vec[startIndex + offset + 2];
+<a name="l00338"></a>00338                                 <a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a> = analyticsLogger-&gt;continueTransaction(groupName, txnId);
+<a name="l00339"></a>00339                         }
+<a name="l00340"></a>00340                         offset += 4;
+<a name="l00341"></a>00341                 }
+<a name="l00342"></a>00342                 <a class="code" href="structPassenger_1_1PoolOptions.html#1709d96d9d5d59ce79c90434a45cb076" title="Whether the session returned by ApplicationPool::Interface::get() should be automatically...">initiateSession</a>  = vec[startIndex + offset] == <span class="stringliteral">"true"</span>;       offset += 2;
+<a name="l00343"></a>00343                 <a class="code" href="structPassenger_1_1PoolOptions.html#d3d545cee2806198797fc6b4197ff87b" title="Whether application processes should print exceptions that occurred during application...">printExceptions</a>  = vec[startIndex + offset] == <span class="stringliteral">"true"</span>;       offset += 2;
+<a name="l00344"></a>00344                 hasEnvVars       = vec[startIndex + offset] == <span class="stringliteral">"true"</span>;       offset += 2;
+<a name="l00345"></a>00345                 <span class="keywordflow">if</span> (hasEnvVars) {
+<a name="l00346"></a>00346                         <a class="code" href="structPassenger_1_1PoolOptions.html#aa4f5d4ae1534ada8613fbe497a38924" title="Environment variables which should be passed to the spawned application process.">environmentVariables</a> = <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> SimpleStringListCreator(vec[startIndex + offset]));
+<a name="l00347"></a>00347                 }
+<a name="l00348"></a>00348                 offset += 2;
+<a name="l00349"></a>00349                 
+<a name="l00350"></a>00350                 <span class="comment">/*********************************/</span>
+<a name="l00351"></a>00351         }
+<a name="l00352"></a>00352         <span class="comment"></span>
+<a name="l00353"></a>00353 <span class="comment">        /**</span>
+<a name="l00354"></a>00354 <span class="comment">         * Append the information in this PoolOptions object to the given</span>
+<a name="l00355"></a>00355 <span class="comment">         * string vector. The resulting array could, for example, be used</span>
+<a name="l00356"></a>00356 <span class="comment">         * as a message to be sent to the spawn server.</span>
+<a name="l00357"></a>00357 <span class="comment">         *</span>
+<a name="l00358"></a>00358 <span class="comment">         * @param vec The vector to store the information in.</span>
+<a name="l00359"></a>00359 <span class="comment">         * @param storeEnvVars Whether to store environment variable information into vec as well.</span>
+<a name="l00360"></a>00360 <span class="comment">         * @throws Anything thrown by environmentVariables-&gt;getItems().</span>
+<a name="l00361"></a>00361 <span class="comment">         */</span>
+<a name="l00362"></a><a class="code" href="structPassenger_1_1PoolOptions.html#437e077b0ab037f4e86680e9164a694e">00362</a>         <span class="keywordtype">void</span> <a class="code" href="structPassenger_1_1PoolOptions.html#437e077b0ab037f4e86680e9164a694e" title="Append the information in this PoolOptions object to the given string vector.">toVector</a>(vector&lt;string&gt; &amp;vec, <span class="keywordtype">bool</span> storeEnvVars = <span class="keyword">true</span>)<span class="keyword"> const </span>{
+<a name="l00363"></a>00363                 <span class="keywordflow">if</span> (vec.capacity() &lt; vec.size() + 40) {
+<a name="l00364"></a>00364                         vec.reserve(vec.size() + 40);
+<a name="l00365"></a>00365                 }
+<a name="l00366"></a>00366                 appendKeyValue (vec, <span class="stringliteral">"app_root"</span>,           appRoot);
+<a name="l00367"></a>00367                 appendKeyValue (vec, <span class="stringliteral">"app_group_name"</span>,     <a class="code" href="structPassenger_1_1PoolOptions.html#43eb2294bff16bbcbafec569babca883" title="Returns the app group name.">getAppGroupName</a>());
+<a name="l00368"></a>00368                 appendKeyValue (vec, <span class="stringliteral">"app_type"</span>,           <a class="code" href="structPassenger_1_1PoolOptions.html#5e1c129ae0b8be350c7ed238eec8a8c9" title="The application type.">appType</a>);
+<a name="l00369"></a>00369                 appendKeyValue (vec, <span class="stringliteral">"environment"</span>,        <a class="code" href="structPassenger_1_1PoolOptions.html#4324bb724859905f9991faa9b90aedbc" title="The RAILS_ENV/RACK_ENV environment that should be used.">environment</a>);
+<a name="l00370"></a>00370                 appendKeyValue (vec, <span class="stringliteral">"spawn_method"</span>,       <a class="code" href="structPassenger_1_1PoolOptions.html#feb629e3ced79f5a2dbccc1beeeeab9e" title="Method with which application processes should be spawned.">spawnMethod</a>);
+<a name="l00371"></a>00371                 appendKeyValue (vec, <span class="stringliteral">"user"</span>,               <a class="code" href="structPassenger_1_1PoolOptions.html#7bb617271b0a61645b17b9815ebf300c" title="See overview.">user</a>);
+<a name="l00372"></a>00372                 appendKeyValue (vec, <span class="stringliteral">"group"</span>,              <a class="code" href="structPassenger_1_1PoolOptions.html#6292899199727c513fd641d313c42372" title="See class overview.">group</a>);
+<a name="l00373"></a>00373                 appendKeyValue (vec, <span class="stringliteral">"default_user"</span>,       <a class="code" href="structPassenger_1_1PoolOptions.html#f9e15d356066ebd5f1454dca7937374f" title="See class overview.">defaultUser</a>);
+<a name="l00374"></a>00374                 appendKeyValue (vec, <span class="stringliteral">"default_group"</span>,      <a class="code" href="structPassenger_1_1PoolOptions.html#fdbe6d3418132ff3ca17427778e0948c" title="See class overview.">defaultGroup</a>);
+<a name="l00375"></a>00375                 appendKeyValue2(vec, <span class="stringliteral">"framework_spawner_timeout"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#cbbea86958b42ffa7989680ed1587c70" title="The idle timeout, in seconds, of framework spawners.">frameworkSpawnerTimeout</a>);
+<a name="l00376"></a>00376                 appendKeyValue2(vec, <span class="stringliteral">"app_spawner_timeout"</span>,       <a class="code" href="structPassenger_1_1PoolOptions.html#5a2f27a853e33c22da71430216d798cf" title="The idle timeout, in seconds, of application spawners.">appSpawnerTimeout</a>);
+<a name="l00377"></a>00377                 appendKeyValue (vec, <span class="stringliteral">"base_uri"</span>,           <a class="code" href="structPassenger_1_1PoolOptions.html#85c99df1b3d74b47c73049e20f0a7192" title="The base URI on which the application runs.">baseURI</a>);
+<a name="l00378"></a>00378                 appendKeyValue3(vec, <span class="stringliteral">"max_requests"</span>,       <a class="code" href="structPassenger_1_1PoolOptions.html#70251ed3cb3713cb26a0b166c6b015c0" title="The maximum number of requests that the spawned application may process before exiting...">maxRequests</a>);
+<a name="l00379"></a>00379                 appendKeyValue3(vec, <span class="stringliteral">"min_processes"</span>,      <a class="code" href="structPassenger_1_1PoolOptions.html#9d887031bbee2ad75ed88c8533ce41c1" title="The minimum number of processes for the current group that the application pool&amp;#39;s...">minProcesses</a>);
+<a name="l00380"></a>00380                 appendKeyValue4(vec, <span class="stringliteral">"use_global_queue"</span>,   <a class="code" href="structPassenger_1_1PoolOptions.html#b610e568a7b5d3bb27460d6e35952b7e" title="Whether to use a global queue instead of a per-backend process queue.">useGlobalQueue</a>);
+<a name="l00381"></a>00381                 appendKeyValue3(vec, <span class="stringliteral">"stat_throttle_rate"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#eaf5a998b4a5da2246685c2dfb8a8c6d" title="A throttling rate for file stats.">statThrottleRate</a>);
+<a name="l00382"></a>00382                 appendKeyValue (vec, <span class="stringliteral">"restart_dir"</span>,        <a class="code" href="structPassenger_1_1PoolOptions.html#b0f889f70a3ed22f2423d110ddaf26f5" title="The directory which contains restart.txt and always_restart.txt.">restartDir</a>);
+<a name="l00383"></a>00383                 appendKeyValue3(vec, <span class="stringliteral">"rights"</span>,             <a class="code" href="structPassenger_1_1PoolOptions.html#45665fffc8a20ea60a3fcafaff8627ab" title="Any rights that the spawned application process may have.">rights</a>);
+<a name="l00384"></a>00384                 <span class="keywordflow">if</span> (<a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a>) {
+<a name="l00385"></a>00385                         appendKeyValue(vec, <span class="stringliteral">"analytics_log_group_name"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a>-&gt;getGroupName());
+<a name="l00386"></a>00386                         appendKeyValue(vec, <span class="stringliteral">"analytics_log_id"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#ce54185a9981f103a036a7ac3e768612" title="An analytics log object to log things to.">log</a>-&gt;getTxnId());
+<a name="l00387"></a>00387                 }
+<a name="l00388"></a>00388                 appendKeyValue4(vec, <span class="stringliteral">"initiate_session"</span>,   <a class="code" href="structPassenger_1_1PoolOptions.html#1709d96d9d5d59ce79c90434a45cb076" title="Whether the session returned by ApplicationPool::Interface::get() should be automatically...">initiateSession</a>);
+<a name="l00389"></a>00389                 appendKeyValue4(vec, <span class="stringliteral">"print_exceptions"</span>,   <a class="code" href="structPassenger_1_1PoolOptions.html#d3d545cee2806198797fc6b4197ff87b" title="Whether application processes should print exceptions that occurred during application...">printExceptions</a>);
+<a name="l00390"></a>00390                 <span class="keywordflow">if</span> (storeEnvVars) {
+<a name="l00391"></a>00391                         appendKeyValue(vec, <span class="stringliteral">"has_environment_variables"</span>, <span class="stringliteral">"true"</span>);
+<a name="l00392"></a>00392                         appendKeyValue(vec, <span class="stringliteral">"environment_variables"</span>, <a class="code" href="structPassenger_1_1PoolOptions.html#cb2df1a0b558e7fa457e46373c17b679" title="Serializes the items in environmentVariables into a string, which can be used to...">serializeEnvironmentVariables</a>());
+<a name="l00393"></a>00393                 } <span class="keywordflow">else</span> {
+<a name="l00394"></a>00394                         appendKeyValue(vec, <span class="stringliteral">"has_environment_variables"</span>, <span class="stringliteral">"false"</span>);
+<a name="l00395"></a>00395                         appendKeyValue(vec, <span class="stringliteral">"environment_variables"</span>, <span class="stringliteral">""</span>);
+<a name="l00396"></a>00396                 }
+<a name="l00397"></a>00397                 
+<a name="l00398"></a>00398                 <span class="comment">/*********************************/</span>
+<a name="l00399"></a>00399         }
+<a name="l00400"></a>00400         <span class="comment"></span>
+<a name="l00401"></a>00401 <span class="comment">        /**</span>
+<a name="l00402"></a>00402 <span class="comment">         * Returns the app group name. If there is no explicitly set app group name</span>
+<a name="l00403"></a>00403 <span class="comment">         * then the app root is considered to be the app group name.</span>
+<a name="l00404"></a>00404 <span class="comment">         */</span>
+<a name="l00405"></a><a class="code" href="structPassenger_1_1PoolOptions.html#43eb2294bff16bbcbafec569babca883">00405</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#43eb2294bff16bbcbafec569babca883" title="Returns the app group name.">getAppGroupName</a>()<span class="keyword"> const </span>{
+<a name="l00406"></a>00406                 <span class="keywordflow">if</span> (<a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf" title="A name used by ApplicationPool to uniquely identify an application.">appGroupName</a>.empty()) {
+<a name="l00407"></a>00407                         <span class="keywordflow">return</span> appRoot;
+<a name="l00408"></a>00408                 } <span class="keywordflow">else</span> {
+<a name="l00409"></a>00409                         <span class="keywordflow">return</span> <a class="code" href="structPassenger_1_1PoolOptions.html#dce57f30c4f33d8b55726d0eaa15addf" title="A name used by ApplicationPool to uniquely identify an application.">appGroupName</a>;
+<a name="l00410"></a>00410                 }
+<a name="l00411"></a>00411         }
+<a name="l00412"></a>00412         <span class="comment"></span>
+<a name="l00413"></a>00413 <span class="comment">        /**</span>
+<a name="l00414"></a>00414 <span class="comment">         * Serializes the items in environmentVariables into a string, which</span>
+<a name="l00415"></a>00415 <span class="comment">         * can be used to create a SimpleStringListCreator object.</span>
+<a name="l00416"></a>00416 <span class="comment">         *</span>
+<a name="l00417"></a>00417 <span class="comment">         * @throws Anything thrown by environmentVariables-&gt;getItems().</span>
+<a name="l00418"></a>00418 <span class="comment">         */</span>
+<a name="l00419"></a><a class="code" href="structPassenger_1_1PoolOptions.html#cb2df1a0b558e7fa457e46373c17b679">00419</a>         <span class="keywordtype">string</span> <a class="code" href="structPassenger_1_1PoolOptions.html#cb2df1a0b558e7fa457e46373c17b679" title="Serializes the items in environmentVariables into a string, which can be used to...">serializeEnvironmentVariables</a>()<span class="keyword"> const </span>{
+<a name="l00420"></a>00420                 vector&lt;string&gt;::const_iterator it, end;
+<a name="l00421"></a>00421                 <span class="keywordtype">string</span> result;
+<a name="l00422"></a>00422                 
+<a name="l00423"></a>00423                 <span class="keywordflow">if</span> (<a class="code" href="structPassenger_1_1PoolOptions.html#aa4f5d4ae1534ada8613fbe497a38924" title="Environment variables which should be passed to the spawned application process.">environmentVariables</a>) {
+<a name="l00424"></a>00424                         result.reserve(1024);
+<a name="l00425"></a>00425                         
+<a name="l00426"></a>00426                         StringListPtr items = <a class="code" href="structPassenger_1_1PoolOptions.html#aa4f5d4ae1534ada8613fbe497a38924" title="Environment variables which should be passed to the spawned application process.">environmentVariables</a>-&gt;getItems();
+<a name="l00427"></a>00427                         end = items-&gt;end();
+<a name="l00428"></a>00428                         
+<a name="l00429"></a>00429                         <span class="keywordflow">for</span> (it = items-&gt;begin(); it != end; it++) {
+<a name="l00430"></a>00430                                 result.append(*it);
+<a name="l00431"></a>00431                                 result.append(1, <span class="charliteral">'\0'</span>);
+<a name="l00432"></a>00432                                 it++;
+<a name="l00433"></a>00433                                 result.append(*it);
+<a name="l00434"></a>00434                                 result.append(1, <span class="charliteral">'\0'</span>);
+<a name="l00435"></a>00435                         }
+<a name="l00436"></a>00436                 }
+<a name="l00437"></a>00437                 <span class="keywordflow">return</span> Base64::encode(result);
+<a name="l00438"></a>00438         }
+<a name="l00439"></a>00439 
+<a name="l00440"></a>00440 <span class="keyword">private</span>:
+<a name="l00441"></a>00441         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
+<a name="l00442"></a>00442         appendKeyValue(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;value) {
+<a name="l00443"></a>00443                 vec.push_back(key);
+<a name="l00444"></a>00444                 vec.push_back(const_cast&lt;string &amp;&gt;(value));
+<a name="l00445"></a>00445         }
+<a name="l00446"></a>00446         
+<a name="l00447"></a>00447         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
+<a name="l00448"></a>00448         appendKeyValue(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">char</span> *value) {
+<a name="l00449"></a>00449                 vec.push_back(key);
+<a name="l00450"></a>00450                 vec.push_back(value);
+<a name="l00451"></a>00451         }
+<a name="l00452"></a>00452         
+<a name="l00453"></a>00453         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
+<a name="l00454"></a>00454         appendKeyValue2(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">long</span> value) {
+<a name="l00455"></a>00455                 vec.push_back(key);
+<a name="l00456"></a>00456                 vec.push_back(<a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(value));
+<a name="l00457"></a>00457         }
+<a name="l00458"></a>00458         
+<a name="l00459"></a>00459         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
+<a name="l00460"></a>00460         appendKeyValue3(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> value) {
+<a name="l00461"></a>00461                 vec.push_back(key);
+<a name="l00462"></a>00462                 vec.push_back(<a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(value));
+<a name="l00463"></a>00463         }
+<a name="l00464"></a>00464         
+<a name="l00465"></a>00465         <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
+<a name="l00466"></a>00466         appendKeyValue4(vector&lt;string&gt; &amp;vec, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">bool</span> value) {
+<a name="l00467"></a>00467                 vec.push_back(key);
+<a name="l00468"></a>00468                 vec.push_back(value ? <span class="stringliteral">"true"</span> : <span class="stringliteral">"false"</span>);
+<a name="l00469"></a>00469         }
+<a name="l00470"></a>00470 };
+<a name="l00471"></a>00471 
+<a name="l00472"></a>00472 } <span class="comment">// namespace Passenger</span>
+<a name="l00473"></a>00473 
+<a name="l00474"></a>00474 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SPAWN_OPTIONS_H_ */</span>
+<a name="l00475"></a>00475 
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 8 22:35:10 2009 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
 </body>