passenger 3.0.0.pre4 → 3.0.0

data/bin/passenger-install-apache2-module

@@ -78,11 +78,6 @@ class Installer < PhusionPassenger::AbstractInstaller
 	end
 	
 	def install!
-		if @snippet
-			show_apache2_config_snippets(true)
-			exit
-		end
-		
 		if PhusionPassenger.natively_packaged?
 			check_dependencies || exit(1)
 			show_apache2_config_snippets
@@ -234,4 +229,9 @@ rescue OptionParser::ParseError => e
 	exit 1
 end
 
-Installer.new(options).start
+installer = Installer.new(options)
+if options[:snippet]
+	installer.send(:show_apache2_config_snippets, true)
+else
+	installer.start
+end

data/doc/Users guide Apache.html

@@ -4476,7 +4476,7 @@ has no effect.</p></div>
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2010-09-15 16:19:46 CEST
+Last updated 2010-10-10 20:52:03 CEST
 </div>
 </div>
 </body>

data/doc/Users guide Nginx.html

@@ -3426,7 +3426,7 @@ has no effect.</p></div>
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2010-09-15 16:20:02 CEST
+Last updated 2010-10-10 20:52:03 CEST
 </div>
 </div>
 </body>

data/doc/Users guide Standalone.html

@@ -596,7 +596,7 @@ use the <tt>-p</tt> option, e.g.:</p></div>
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2010-09-15 07:58:46 CEST
+Last updated 2010-10-01 12:22:34 CEST
 </div>
 </div>
 </body>

data/doc/cxxapi/Constants_8h_source.html

@@ -51,7 +51,7 @@
 <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_CONSTANTS_H_</span>
 <a name="l00027"></a>00027 <span class="preprocessor"></span>
 <a name="l00028"></a>00028 <span class="comment">/* Don&#39;t forget to update lib/phusion_passenger.rb too. */</span>
-<a name="l00029"></a>00029 <span class="preprocessor">#define PASSENGER_VERSION &quot;3.0.0.pre2&quot;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#define PASSENGER_VERSION &quot;3.0.0&quot;</span>
 <a name="l00030"></a>00030 <span class="preprocessor"></span>
 <a name="l00031"></a>00031 <span class="preprocessor">#define FEEDBACK_FD 3</span>
 <a name="l00032"></a>00032 <span class="preprocessor"></span>

data/doc/cxxapi/MessageServer_8h_source.html

@@ -182,422 +182,428 @@
 <a name="l00157"></a>00157 <span class="comment"> */</span>
 <a name="l00158"></a><a class="code" href="classPassenger_1_1MessageServer.html">00158</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a> {
 <a name="l00159"></a>00159 <span class="keyword">public</span>:
-<a name="l00160"></a>00160         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> CLIENT_THREAD_STACK_SIZE = 64 * 1024;
-<a name="l00161"></a>00161         <span class="comment"></span>
-<a name="l00162"></a>00162 <span class="comment">        /** Interface for client context objects. */</span>
-<a name="l00163"></a><a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html">00163</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html" title="Interface for client context objects.">ClientContext</a> {
-<a name="l00164"></a>00164         <span class="keyword">public</span>:
-<a name="l00165"></a>00165                 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html" title="Interface for client context objects.">ClientContext</a>() { }
-<a name="l00166"></a>00166         };
-<a name="l00167"></a>00167         
-<a name="l00168"></a>00168         <span class="keyword">typedef</span> shared_ptr&lt;ClientContext&gt; ClientContextPtr;
-<a name="l00169"></a>00169         <span class="comment"></span>
-<a name="l00170"></a>00170 <span class="comment">        /**</span>
-<a name="l00171"></a>00171 <span class="comment">         * A common client context, containing client-specific information</span>
-<a name="l00172"></a>00172 <span class="comment">         * used by MessageServer itself.</span>
-<a name="l00173"></a>00173 <span class="comment">         */</span>
-<a name="l00174"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">00174</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a>: <span class="keyword">public</span> <a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html" title="Interface for client context objects.">ClientContext</a> {
-<a name="l00175"></a>00175         <span class="keyword">public</span>:<span class="comment"></span>
-<a name="l00176"></a>00176 <span class="comment">                /** The client&#39;s socket file descriptor. */</span>
-<a name="l00177"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a21f1a10d55f9ed0c1f6d92e00e93045b">00177</a>                 <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a21f1a10d55f9ed0c1f6d92e00e93045b" title="The client&amp;#39;s socket file descriptor.">fd</a>;
-<a name="l00178"></a>00178                 <span class="comment"></span>
-<a name="l00179"></a>00179 <span class="comment">                /** The channel that&#39;s associated with the client&#39;s socket. */</span>
-<a name="l00180"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8">00180</a>                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>;
-<a name="l00181"></a>00181                 <span class="comment"></span>
-<a name="l00182"></a>00182 <span class="comment">                /** The account with which the client authenticated. */</span>
-<a name="l00183"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb">00183</a>                 AccountPtr <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb" title="The account with which the client authenticated.">account</a>;
-<a name="l00184"></a>00184                 
-<a name="l00185"></a>00185                 
-<a name="l00186"></a>00186                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a>(<a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;theFd, AccountPtr &amp;theAccount)
-<a name="l00187"></a>00187                         : <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a21f1a10d55f9ed0c1f6d92e00e93045b" title="The client&amp;#39;s socket file descriptor.">fd</a>(theFd), <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>(theFd), <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb" title="The account with which the client authenticated.">account</a>(theAccount)
-<a name="l00188"></a>00188                 { }
-<a name="l00189"></a>00189                 <span class="comment"></span>
-<a name="l00190"></a>00190 <span class="comment">                /** Returns a string representation for this client context. */</span>
-<a name="l00191"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ac7779e4dafe06a54fc3075ddf7e3f25b">00191</a>                 <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ac7779e4dafe06a54fc3075ddf7e3f25b" title="Returns a string representation for this client context.">name</a>() {
-<a name="l00192"></a>00192                         <span class="keywordflow">return</span> toString(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a" title="Returns the underlying file descriptor.">filenum</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">                 * Checks whether this client has all of the rights in &lt;tt&gt;rights&lt;/tt&gt;. The</span>
-<a name="l00197"></a>00197 <span class="comment">                 * client will be notified about the result of this check, by sending it a</span>
-<a name="l00198"></a>00198 <span class="comment">                 * message.</span>
-<a name="l00199"></a>00199 <span class="comment">                 *</span>
-<a name="l00200"></a>00200 <span class="comment">                 * @throws SecurityException The client doesn&#39;t have one of the required rights.</span>
-<a name="l00201"></a>00201 <span class="comment">                 * @throws SystemException Something went wrong while communicating with the client.</span>
-<a name="l00202"></a>00202 <span class="comment">                 * @throws boost::thread_interrupted</span>
-<a name="l00203"></a>00203 <span class="comment">                 */</span>
-<a name="l00204"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a965521e6a28923ecaa03f8722eca8ff4">00204</a>                 <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a965521e6a28923ecaa03f8722eca8ff4" title="Checks whether this client has all of the rights in rights.">requireRights</a>(Account::Rights rights) {
-<a name="l00205"></a>00205                         <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb" title="The account with which the client authenticated.">account</a>-&gt;hasRights(rights)) {
-<a name="l00206"></a>00206                                 P_TRACE(2, <span class="stringliteral">&quot;Security error: insufficient rights to execute this command.&quot;</span>);
-<a name="l00207"></a>00207                                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;SecurityException&quot;</span>, <span class="stringliteral">&quot;Insufficient rights to execute this command.&quot;</span>, NULL);
-<a name="l00208"></a>00208                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a>(<span class="stringliteral">&quot;Insufficient rights to execute this command.&quot;</span>);
-<a name="l00209"></a>00209                         } <span class="keywordflow">else</span> {
-<a name="l00210"></a>00210                                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;Passed security&quot;</span>, NULL);
-<a name="l00211"></a>00211                         }
-<a name="l00212"></a>00212                 }
-<a name="l00213"></a>00213         };
-<a name="l00214"></a>00214         <span class="comment"></span>
-<a name="l00215"></a>00215 <span class="comment">        /**</span>
-<a name="l00216"></a>00216 <span class="comment">         * An abstract message handler class.</span>
-<a name="l00217"></a>00217 <span class="comment">         *</span>
-<a name="l00218"></a>00218 <span class="comment">         * The methods defined in this class are allowed to throw arbitrary exceptions.</span>
-<a name="l00219"></a>00219 <span class="comment">         * Such exceptions are caught and logged, after which the connection to the</span>
-<a name="l00220"></a>00220 <span class="comment">         * client is closed.</span>
-<a name="l00221"></a>00221 <span class="comment">         */</span>
-<a name="l00222"></a><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html">00222</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html" title="An abstract message handler class.">Handler</a> {
-<a name="l00223"></a>00223         <span class="keyword">public</span>:
-<a name="l00224"></a>00224                 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html" title="An abstract message handler class.">Handler</a>() { }
-<a name="l00225"></a>00225                 <span class="comment"></span>
-<a name="l00226"></a>00226 <span class="comment">                /**</span>
-<a name="l00227"></a>00227 <span class="comment">                 * Called when a new client has connected to the MessageServer.</span>
-<a name="l00228"></a>00228 <span class="comment">                 *</span>
-<a name="l00229"></a>00229 <span class="comment">                 * This method is called after the client has authenticated itself.</span>
-<a name="l00230"></a>00230 <span class="comment">                 *</span>
-<a name="l00231"></a>00231 <span class="comment">                 * @param context Contains common client-specific information.</span>
-<a name="l00232"></a>00232 <span class="comment">                 * @return A client context object for storing handler-specific client</span>
-<a name="l00233"></a>00233 <span class="comment">                 *         information, or null. The default implementation returns null.</span>
-<a name="l00234"></a>00234 <span class="comment">                 */</span>
-<a name="l00235"></a><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552">00235</a>                 <span class="keyword">virtual</span> ClientContextPtr <a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552" title="Called when a new client has connected to the MessageServer.">newClient</a>(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;context) {
-<a name="l00236"></a>00236                         <span class="keywordflow">return</span> ClientContextPtr();
-<a name="l00237"></a>00237                 }
-<a name="l00238"></a>00238                 <span class="comment"></span>
-<a name="l00239"></a>00239 <span class="comment">                /**</span>
-<a name="l00240"></a>00240 <span class="comment">                 * Called when a client has disconnected from the MessageServer. The</span>
-<a name="l00241"></a>00241 <span class="comment">                 * default implementation does nothing.</span>
-<a name="l00242"></a>00242 <span class="comment">                 *</span>
-<a name="l00243"></a>00243 <span class="comment">                 * This method is called even if processMessage() throws an exception.</span>
-<a name="l00244"></a>00244 <span class="comment">                 * It is however not called if newClient() throws an exception.</span>
-<a name="l00245"></a>00245 <span class="comment">                 *</span>
-<a name="l00246"></a>00246 <span class="comment">                 * @param commonContext Contains common client-specific information.</span>
-<a name="l00247"></a>00247 <span class="comment">                 * @param handlerSpecificContext The client context object as was returned</span>
-<a name="l00248"></a>00248 <span class="comment">                 *     earlier by newClient().</span>
-<a name="l00249"></a>00249 <span class="comment">                 */</span>
-<a name="l00250"></a><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#aabbc0f2b4ff4676b34a79a6cb550253f">00250</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#aabbc0f2b4ff4676b34a79a6cb550253f" title="Called when a client has disconnected from the MessageServer.">clientDisconnected</a>(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">MessageServer::CommonClientContext</a> &amp;context,
-<a name="l00251"></a>00251                                                 MessageServer::ClientContextPtr &amp;handlerSpecificContext)
-<a name="l00252"></a>00252                 { }
-<a name="l00253"></a>00253                 <span class="comment"></span>
-<a name="l00254"></a>00254 <span class="comment">                /**</span>
-<a name="l00255"></a>00255 <span class="comment">                 * Called then a client has sent a request message.</span>
-<a name="l00256"></a>00256 <span class="comment">                 *</span>
-<a name="l00257"></a>00257 <span class="comment">                 * This method is called after newClient() is called.</span>
-<a name="l00258"></a>00258 <span class="comment">                 *</span>
-<a name="l00259"></a>00259 <span class="comment">                 * @param commonContext Contains common client-specific information.</span>
-<a name="l00260"></a>00260 <span class="comment">                 * @param handlerSpecificContext The client context object as was returned</span>
-<a name="l00261"></a>00261 <span class="comment">                 *     earlier by newClient().</span>
-<a name="l00262"></a>00262 <span class="comment">                 * @param args The request message&#39;s contents.</span>
-<a name="l00263"></a>00263 <span class="comment">                 * @return Whether this handler has processed the message. Return false</span>
-<a name="l00264"></a>00264 <span class="comment">                 *         if the message is unrecognized.</span>
-<a name="l00265"></a>00265 <span class="comment">                 */</span>
-<a name="l00266"></a>00266                 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#ab5c45d7f498f6ab71d665e341bddd86f" title="Called then a client has sent a request message.">processMessage</a>(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;commonContext,
-<a name="l00267"></a>00267                                             ClientContextPtr &amp;handlerSpecificContext,
-<a name="l00268"></a>00268                                             <span class="keyword">const</span> vector&lt;string&gt; &amp;args) = 0;
-<a name="l00269"></a>00269         };
-<a name="l00270"></a>00270         
-<a name="l00271"></a>00271         <span class="keyword">typedef</span> shared_ptr&lt;Handler&gt; HandlerPtr;
-<a name="l00272"></a>00272         
-<a name="l00273"></a>00273 <span class="keyword">protected</span>:<span class="comment"></span>
-<a name="l00274"></a>00274 <span class="comment">        /** The filename of the server socket on which this MessageServer is listening. */</span>
-<a name="l00275"></a><a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3">00275</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>;
-<a name="l00276"></a>00276         <span class="comment"></span>
-<a name="l00277"></a>00277 <span class="comment">        /** An accounts database, used for authenticating clients. */</span>
-<a name="l00278"></a><a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93">00278</a>         AccountsDatabasePtr <a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93" title="An accounts database, used for authenticating clients.">accountsDatabase</a>;
-<a name="l00279"></a>00279         <span class="comment"></span>
-<a name="l00280"></a>00280 <span class="comment">        /** The registered message handlers. */</span>
-<a name="l00281"></a><a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a">00281</a>         vector&lt;HandlerPtr&gt; <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>;
+<a name="l00160"></a>00160         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> CLIENT_THREAD_STACK_SIZE =
+<a name="l00161"></a>00161 <span class="preprocessor">                #ifdef __FreeBSD__</span>
+<a name="l00162"></a>00162 <span class="preprocessor"></span>                        <span class="comment">// localtime() on FreeBSD needs some more stack space.</span>
+<a name="l00163"></a>00163                         1024 * 96;
+<a name="l00164"></a>00164 <span class="preprocessor">                #else</span>
+<a name="l00165"></a>00165 <span class="preprocessor"></span>                        1024 * 64;
+<a name="l00166"></a>00166 <span class="preprocessor">                #endif</span>
+<a name="l00167"></a>00167 <span class="preprocessor"></span>        <span class="comment"></span>
+<a name="l00168"></a>00168 <span class="comment">        /** Interface for client context objects. */</span>
+<a name="l00169"></a><a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html">00169</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html" title="Interface for client context objects.">ClientContext</a> {
+<a name="l00170"></a>00170         <span class="keyword">public</span>:
+<a name="l00171"></a>00171                 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html" title="Interface for client context objects.">ClientContext</a>() { }
+<a name="l00172"></a>00172         };
+<a name="l00173"></a>00173         
+<a name="l00174"></a>00174         <span class="keyword">typedef</span> shared_ptr&lt;ClientContext&gt; ClientContextPtr;
+<a name="l00175"></a>00175         <span class="comment"></span>
+<a name="l00176"></a>00176 <span class="comment">        /**</span>
+<a name="l00177"></a>00177 <span class="comment">         * A common client context, containing client-specific information</span>
+<a name="l00178"></a>00178 <span class="comment">         * used by MessageServer itself.</span>
+<a name="l00179"></a>00179 <span class="comment">         */</span>
+<a name="l00180"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html">00180</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a>: <span class="keyword">public</span> <a class="code" href="classPassenger_1_1MessageServer_1_1ClientContext.html" title="Interface for client context objects.">ClientContext</a> {
+<a name="l00181"></a>00181         <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00182"></a>00182 <span class="comment">                /** The client&#39;s socket file descriptor. */</span>
+<a name="l00183"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a21f1a10d55f9ed0c1f6d92e00e93045b">00183</a>                 <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a21f1a10d55f9ed0c1f6d92e00e93045b" title="The client&amp;#39;s socket file descriptor.">fd</a>;
+<a name="l00184"></a>00184                 <span class="comment"></span>
+<a name="l00185"></a>00185 <span class="comment">                /** The channel that&#39;s associated with the client&#39;s socket. */</span>
+<a name="l00186"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8">00186</a>                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>;
+<a name="l00187"></a>00187                 <span class="comment"></span>
+<a name="l00188"></a>00188 <span class="comment">                /** The account with which the client authenticated. */</span>
+<a name="l00189"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb">00189</a>                 AccountPtr <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb" title="The account with which the client authenticated.">account</a>;
+<a name="l00190"></a>00190                 
+<a name="l00191"></a>00191                 
+<a name="l00192"></a>00192                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a>(<a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;theFd, AccountPtr &amp;theAccount)
+<a name="l00193"></a>00193                         : <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a21f1a10d55f9ed0c1f6d92e00e93045b" title="The client&amp;#39;s socket file descriptor.">fd</a>(theFd), <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>(theFd), <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb" title="The account with which the client authenticated.">account</a>(theAccount)
+<a name="l00194"></a>00194                 { }
+<a name="l00195"></a>00195                 <span class="comment"></span>
+<a name="l00196"></a>00196 <span class="comment">                /** Returns a string representation for this client context. */</span>
+<a name="l00197"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ac7779e4dafe06a54fc3075ddf7e3f25b">00197</a>                 <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ac7779e4dafe06a54fc3075ddf7e3f25b" title="Returns a string representation for this client context.">name</a>() {
+<a name="l00198"></a>00198                         <span class="keywordflow">return</span> toString(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a" title="Returns the underlying file descriptor.">filenum</a>());
+<a name="l00199"></a>00199                 }
+<a name="l00200"></a>00200                 <span class="comment"></span>
+<a name="l00201"></a>00201 <span class="comment">                /**</span>
+<a name="l00202"></a>00202 <span class="comment">                 * Checks whether this client has all of the rights in &lt;tt&gt;rights&lt;/tt&gt;. The</span>
+<a name="l00203"></a>00203 <span class="comment">                 * client will be notified about the result of this check, by sending it a</span>
+<a name="l00204"></a>00204 <span class="comment">                 * message.</span>
+<a name="l00205"></a>00205 <span class="comment">                 *</span>
+<a name="l00206"></a>00206 <span class="comment">                 * @throws SecurityException The client doesn&#39;t have one of the required rights.</span>
+<a name="l00207"></a>00207 <span class="comment">                 * @throws SystemException Something went wrong while communicating with the client.</span>
+<a name="l00208"></a>00208 <span class="comment">                 * @throws boost::thread_interrupted</span>
+<a name="l00209"></a>00209 <span class="comment">                 */</span>
+<a name="l00210"></a><a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a965521e6a28923ecaa03f8722eca8ff4">00210</a>                 <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a965521e6a28923ecaa03f8722eca8ff4" title="Checks whether this client has all of the rights in rights.">requireRights</a>(Account::Rights rights) {
+<a name="l00211"></a>00211                         <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ad3316dada1f190fe523d4ab9b5e055fb" title="The account with which the client authenticated.">account</a>-&gt;hasRights(rights)) {
+<a name="l00212"></a>00212                                 P_TRACE(2, <span class="stringliteral">&quot;Security error: insufficient rights to execute this command.&quot;</span>);
+<a name="l00213"></a>00213                                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;SecurityException&quot;</span>, <span class="stringliteral">&quot;Insufficient rights to execute this command.&quot;</span>, NULL);
+<a name="l00214"></a>00214                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a>(<span class="stringliteral">&quot;Insufficient rights to execute this command.&quot;</span>);
+<a name="l00215"></a>00215                         } <span class="keywordflow">else</span> {
+<a name="l00216"></a>00216                                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;Passed security&quot;</span>, NULL);
+<a name="l00217"></a>00217                         }
+<a name="l00218"></a>00218                 }
+<a name="l00219"></a>00219         };
+<a name="l00220"></a>00220         <span class="comment"></span>
+<a name="l00221"></a>00221 <span class="comment">        /**</span>
+<a name="l00222"></a>00222 <span class="comment">         * An abstract message handler class.</span>
+<a name="l00223"></a>00223 <span class="comment">         *</span>
+<a name="l00224"></a>00224 <span class="comment">         * The methods defined in this class are allowed to throw arbitrary exceptions.</span>
+<a name="l00225"></a>00225 <span class="comment">         * Such exceptions are caught and logged, after which the connection to the</span>
+<a name="l00226"></a>00226 <span class="comment">         * client is closed.</span>
+<a name="l00227"></a>00227 <span class="comment">         */</span>
+<a name="l00228"></a><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html">00228</a>         <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html" title="An abstract message handler class.">Handler</a> {
+<a name="l00229"></a>00229         <span class="keyword">public</span>:
+<a name="l00230"></a>00230                 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html" title="An abstract message handler class.">Handler</a>() { }
+<a name="l00231"></a>00231                 <span class="comment"></span>
+<a name="l00232"></a>00232 <span class="comment">                /**</span>
+<a name="l00233"></a>00233 <span class="comment">                 * Called when a new client has connected to the MessageServer.</span>
+<a name="l00234"></a>00234 <span class="comment">                 *</span>
+<a name="l00235"></a>00235 <span class="comment">                 * This method is called after the client has authenticated itself.</span>
+<a name="l00236"></a>00236 <span class="comment">                 *</span>
+<a name="l00237"></a>00237 <span class="comment">                 * @param context Contains common client-specific information.</span>
+<a name="l00238"></a>00238 <span class="comment">                 * @return A client context object for storing handler-specific client</span>
+<a name="l00239"></a>00239 <span class="comment">                 *         information, or null. The default implementation returns null.</span>
+<a name="l00240"></a>00240 <span class="comment">                 */</span>
+<a name="l00241"></a><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552">00241</a>                 <span class="keyword">virtual</span> ClientContextPtr <a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#a8693a487d0b53266943cc718c95d5552" title="Called when a new client has connected to the MessageServer.">newClient</a>(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;context) {
+<a name="l00242"></a>00242                         <span class="keywordflow">return</span> ClientContextPtr();
+<a name="l00243"></a>00243                 }
+<a name="l00244"></a>00244                 <span class="comment"></span>
+<a name="l00245"></a>00245 <span class="comment">                /**</span>
+<a name="l00246"></a>00246 <span class="comment">                 * Called when a client has disconnected from the MessageServer. The</span>
+<a name="l00247"></a>00247 <span class="comment">                 * default implementation does nothing.</span>
+<a name="l00248"></a>00248 <span class="comment">                 *</span>
+<a name="l00249"></a>00249 <span class="comment">                 * This method is called even if processMessage() throws an exception.</span>
+<a name="l00250"></a>00250 <span class="comment">                 * It is however not called if newClient() throws an exception.</span>
+<a name="l00251"></a>00251 <span class="comment">                 *</span>
+<a name="l00252"></a>00252 <span class="comment">                 * @param commonContext Contains common client-specific information.</span>
+<a name="l00253"></a>00253 <span class="comment">                 * @param handlerSpecificContext The client context object as was returned</span>
+<a name="l00254"></a>00254 <span class="comment">                 *     earlier by newClient().</span>
+<a name="l00255"></a>00255 <span class="comment">                 */</span>
+<a name="l00256"></a><a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#aabbc0f2b4ff4676b34a79a6cb550253f">00256</a>                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#aabbc0f2b4ff4676b34a79a6cb550253f" title="Called when a client has disconnected from the MessageServer.">clientDisconnected</a>(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">MessageServer::CommonClientContext</a> &amp;context,
+<a name="l00257"></a>00257                                                 MessageServer::ClientContextPtr &amp;handlerSpecificContext)
+<a name="l00258"></a>00258                 { }
+<a name="l00259"></a>00259                 <span class="comment"></span>
+<a name="l00260"></a>00260 <span class="comment">                /**</span>
+<a name="l00261"></a>00261 <span class="comment">                 * Called then a client has sent a request message.</span>
+<a name="l00262"></a>00262 <span class="comment">                 *</span>
+<a name="l00263"></a>00263 <span class="comment">                 * This method is called after newClient() is called.</span>
+<a name="l00264"></a>00264 <span class="comment">                 *</span>
+<a name="l00265"></a>00265 <span class="comment">                 * @param commonContext Contains common client-specific information.</span>
+<a name="l00266"></a>00266 <span class="comment">                 * @param handlerSpecificContext The client context object as was returned</span>
+<a name="l00267"></a>00267 <span class="comment">                 *     earlier by newClient().</span>
+<a name="l00268"></a>00268 <span class="comment">                 * @param args The request message&#39;s contents.</span>
+<a name="l00269"></a>00269 <span class="comment">                 * @return Whether this handler has processed the message. Return false</span>
+<a name="l00270"></a>00270 <span class="comment">                 *         if the message is unrecognized.</span>
+<a name="l00271"></a>00271 <span class="comment">                 */</span>
+<a name="l00272"></a>00272                 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageServer_1_1Handler.html#ab5c45d7f498f6ab71d665e341bddd86f" title="Called then a client has sent a request message.">processMessage</a>(<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;commonContext,
+<a name="l00273"></a>00273                                             ClientContextPtr &amp;handlerSpecificContext,
+<a name="l00274"></a>00274                                             <span class="keyword">const</span> vector&lt;string&gt; &amp;args) = 0;
+<a name="l00275"></a>00275         };
+<a name="l00276"></a>00276         
+<a name="l00277"></a>00277         <span class="keyword">typedef</span> shared_ptr&lt;Handler&gt; HandlerPtr;
+<a name="l00278"></a>00278         
+<a name="l00279"></a>00279 <span class="keyword">protected</span>:<span class="comment"></span>
+<a name="l00280"></a>00280 <span class="comment">        /** The filename of the server socket on which this MessageServer is listening. */</span>
+<a name="l00281"></a><a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3">00281</a>         <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>;
 <a name="l00282"></a>00282         <span class="comment"></span>
-<a name="l00283"></a>00283 <span class="comment">        /** The maximum number of milliseconds that client may spend on logging in.</span>
-<a name="l00284"></a>00284 <span class="comment">         * Clients that take longer are disconnected.</span>
-<a name="l00285"></a>00285 <span class="comment">         *</span>
-<a name="l00286"></a>00286 <span class="comment">         * @invariant loginTimeout != 0</span>
-<a name="l00287"></a>00287 <span class="comment">         */</span>
-<a name="l00288"></a><a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926">00288</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a>;
-<a name="l00289"></a>00289         <span class="comment"></span>
-<a name="l00290"></a>00290 <span class="comment">        /** The client threads. */</span>
-<a name="l00291"></a><a class="code" href="classPassenger_1_1MessageServer.html#a48ccf2c09c2c8b5dcfe3a0585dba67cf">00291</a>         dynamic_thread_group <a class="code" href="classPassenger_1_1MessageServer.html#a48ccf2c09c2c8b5dcfe3a0585dba67cf" title="The client threads.">threadGroup</a>;
-<a name="l00292"></a>00292         <span class="comment"></span>
-<a name="l00293"></a>00293 <span class="comment">        /** The server socket&#39;s file descriptor.</span>
-<a name="l00294"></a>00294 <span class="comment">         * @invariant serverFd &gt;= 0</span>
-<a name="l00295"></a>00295 <span class="comment">         */</span>
-<a name="l00296"></a><a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4">00296</a>         <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a>;
-<a name="l00297"></a>00297         
+<a name="l00283"></a>00283 <span class="comment">        /** An accounts database, used for authenticating clients. */</span>
+<a name="l00284"></a><a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93">00284</a>         AccountsDatabasePtr <a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93" title="An accounts database, used for authenticating clients.">accountsDatabase</a>;
+<a name="l00285"></a>00285         <span class="comment"></span>
+<a name="l00286"></a>00286 <span class="comment">        /** The registered message handlers. */</span>
+<a name="l00287"></a><a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a">00287</a>         vector&lt;HandlerPtr&gt; <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>;
+<a name="l00288"></a>00288         <span class="comment"></span>
+<a name="l00289"></a>00289 <span class="comment">        /** The maximum number of milliseconds that client may spend on logging in.</span>
+<a name="l00290"></a>00290 <span class="comment">         * Clients that take longer are disconnected.</span>
+<a name="l00291"></a>00291 <span class="comment">         *</span>
+<a name="l00292"></a>00292 <span class="comment">         * @invariant loginTimeout != 0</span>
+<a name="l00293"></a>00293 <span class="comment">         */</span>
+<a name="l00294"></a><a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926">00294</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a>;
+<a name="l00295"></a>00295         <span class="comment"></span>
+<a name="l00296"></a>00296 <span class="comment">        /** The client threads. */</span>
+<a name="l00297"></a><a class="code" href="classPassenger_1_1MessageServer.html#a48ccf2c09c2c8b5dcfe3a0585dba67cf">00297</a>         dynamic_thread_group <a class="code" href="classPassenger_1_1MessageServer.html#a48ccf2c09c2c8b5dcfe3a0585dba67cf" title="The client threads.">threadGroup</a>;
 <a name="l00298"></a>00298         <span class="comment"></span>
-<a name="l00299"></a>00299 <span class="comment">        /** Calls clientDisconnected() on all handlers when destroyed. */</span>
-<a name="l00300"></a><a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html">00300</a>         <span class="keyword">struct </span><a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a> {
-<a name="l00301"></a>00301                 vector&lt;HandlerPtr&gt; &amp;handlers;
-<a name="l00302"></a>00302                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;commonContext;
-<a name="l00303"></a>00303                 vector&lt;ClientContextPtr&gt; &amp;handlerSpecificContexts;
-<a name="l00304"></a>00304                 
-<a name="l00305"></a>00305                 <a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a>(vector&lt;HandlerPtr&gt; &amp;_handlers,
-<a name="l00306"></a>00306                                               <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;_commonContext,
-<a name="l00307"></a>00307                                               vector&lt;ClientContextPtr&gt; &amp;_handlerSpecificContexts)
-<a name="l00308"></a>00308                 : handlers(_handlers),
-<a name="l00309"></a>00309                   commonContext(_commonContext),
-<a name="l00310"></a>00310                   handlerSpecificContexts(_handlerSpecificContexts)
-<a name="l00311"></a>00311                 { }
-<a name="l00312"></a>00312                 
-<a name="l00313"></a>00313                 ~<a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a>() {
-<a name="l00314"></a>00314                         vector&lt;HandlerPtr&gt;::iterator handler_iter;
-<a name="l00315"></a>00315                         vector&lt;ClientContextPtr&gt;::iterator context_iter;
-<a name="l00316"></a>00316 
-<a name="l00317"></a>00317                         <span class="keywordflow">for</span> (handler_iter = handlers.begin(), context_iter = handlerSpecificContexts.begin();
-<a name="l00318"></a>00318                              handler_iter != handlers.end();
-<a name="l00319"></a>00319                              handler_iter++, context_iter++) {
-<a name="l00320"></a>00320                                 (*handler_iter)-&gt;clientDisconnected(commonContext, *context_iter);
-<a name="l00321"></a>00321                         }
-<a name="l00322"></a>00322                 }
-<a name="l00323"></a>00323         };
-<a name="l00324"></a>00324         
-<a name="l00325"></a>00325         <span class="comment"></span>
-<a name="l00326"></a>00326 <span class="comment">        /**</span>
-<a name="l00327"></a>00327 <span class="comment">         * Create a server socket and set it up for listening. This socket will</span>
-<a name="l00328"></a>00328 <span class="comment">         * be world-writable.</span>
-<a name="l00329"></a>00329 <span class="comment">         *</span>
-<a name="l00330"></a>00330 <span class="comment">         * @throws RuntimeException</span>
-<a name="l00331"></a>00331 <span class="comment">         * @throws SystemException</span>
-<a name="l00332"></a>00332 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00333"></a>00333 <span class="comment">         */</span>
-<a name="l00334"></a><a class="code" href="classPassenger_1_1MessageServer.html#a86f9ec99fe5dbed5c04d4b9e8f170995">00334</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#a86f9ec99fe5dbed5c04d4b9e8f170995" title="Create a server socket and set it up for listening.">startListening</a>() {
-<a name="l00335"></a>00335                 TRACE_POINT();
-<a name="l00336"></a>00336                 <span class="keywordtype">int</span> ret;
-<a name="l00337"></a>00337                 
-<a name="l00338"></a>00338                 <a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a> = createUnixServer(<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>.c_str());
-<a name="l00339"></a>00339                 <span class="keywordflow">do</span> {
-<a name="l00340"></a>00340                         ret = chmod(<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>.c_str(),
-<a name="l00341"></a>00341                                 S_ISVTX |
-<a name="l00342"></a>00342                                 S_IRUSR | S_IWUSR | S_IXUSR |
-<a name="l00343"></a>00343                                 S_IRGRP | S_IWGRP | S_IXGRP |
-<a name="l00344"></a>00344                                 S_IROTH | S_IWOTH | S_IXOTH);
-<a name="l00345"></a>00345                 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
-<a name="l00346"></a>00346         }
-<a name="l00347"></a>00347         <span class="comment"></span>
-<a name="l00348"></a>00348 <span class="comment">        /**</span>
-<a name="l00349"></a>00349 <span class="comment">         * Authenticate the given client and returns its account information.</span>
-<a name="l00350"></a>00350 <span class="comment">         *</span>
-<a name="l00351"></a>00351 <span class="comment">         * @return A smart pointer to an Account object, or NULL if authentication failed.</span>
-<a name="l00352"></a>00352 <span class="comment">         */</span>
-<a name="l00353"></a><a class="code" href="classPassenger_1_1MessageServer.html#a6687fdc90ef1c361a69c0fdcde38bb42">00353</a>         AccountPtr <a class="code" href="classPassenger_1_1MessageServer.html#a6687fdc90ef1c361a69c0fdcde38bb42" title="Authenticate the given client and returns its account information.">authenticate</a>(<a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;client) {
-<a name="l00354"></a>00354                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(client);
-<a name="l00355"></a>00355                 <span class="keywordtype">string</span> username, password;
-<a name="l00356"></a>00356                 MemZeroGuard passwordGuard(password);
-<a name="l00357"></a>00357                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timeout = <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a>;
-<a name="l00358"></a>00358                 
-<a name="l00359"></a>00359                 <span class="keywordflow">try</span> {
-<a name="l00360"></a>00360                         channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;version&quot;</span>, <span class="stringliteral">&quot;1&quot;</span>, NULL);
-<a name="l00361"></a>00361                         
-<a name="l00362"></a>00362                         <span class="keywordflow">try</span> {
-<a name="l00363"></a>00363                                 <span class="keywordflow">if</span> (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(username, MESSAGE_SERVER_MAX_USERNAME_SIZE, &amp;timeout)) {
-<a name="l00364"></a>00364                                         <span class="keywordflow">return</span> AccountPtr();
-<a name="l00365"></a>00365                                 }
-<a name="l00366"></a>00366                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a> &amp;) {
-<a name="l00367"></a>00367                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;The supplied username is too long.&quot;</span>, NULL);
-<a name="l00368"></a>00368                                 <span class="keywordflow">return</span> AccountPtr();
-<a name="l00369"></a>00369                         }
-<a name="l00370"></a>00370                         
-<a name="l00371"></a>00371                         <span class="keywordflow">try</span> {
-<a name="l00372"></a>00372                                 <span class="keywordflow">if</span> (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(password, MESSAGE_SERVER_MAX_PASSWORD_SIZE, &amp;timeout)) {
-<a name="l00373"></a>00373                                         <span class="keywordflow">return</span> AccountPtr();
-<a name="l00374"></a>00374                                 }
-<a name="l00375"></a>00375                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a> &amp;) {
-<a name="l00376"></a>00376                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;The supplied password is too long.&quot;</span>, NULL);
-<a name="l00377"></a>00377                                 <span class="keywordflow">return</span> AccountPtr();
-<a name="l00378"></a>00378                         }
-<a name="l00379"></a>00379                         
-<a name="l00380"></a>00380                         AccountPtr account = <a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93" title="An accounts database, used for authenticating clients.">accountsDatabase</a>-&gt;authenticate(username, password);
-<a name="l00381"></a>00381                         passwordGuard.zeroNow();
-<a name="l00382"></a>00382                         <span class="keywordflow">if</span> (account == NULL) {
-<a name="l00383"></a>00383                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;Invalid username or password.&quot;</span>, NULL);
-<a name="l00384"></a>00384                                 <span class="keywordflow">return</span> AccountPtr();
-<a name="l00385"></a>00385                         } <span class="keywordflow">else</span> {
-<a name="l00386"></a>00386                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;ok&quot;</span>, NULL);
-<a name="l00387"></a>00387                                 <span class="keywordflow">return</span> account;
-<a name="l00388"></a>00388                         }
-<a name="l00389"></a>00389                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;) {
-<a name="l00390"></a>00390                         <span class="keywordflow">return</span> AccountPtr();
-<a name="l00391"></a>00391                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1TimeoutException.html" title="An exception indicating that some timeout expired.">TimeoutException</a> &amp;) {
-<a name="l00392"></a>00392                         <span class="keywordflow">return</span> AccountPtr();
-<a name="l00393"></a>00393                 }
-<a name="l00394"></a>00394         }
-<a name="l00395"></a>00395         
-<a name="l00396"></a>00396         <span class="keywordtype">void</span> broadcastNewClientEvent(CommonClientContext &amp;context,
-<a name="l00397"></a>00397                                      vector&lt;ClientContextPtr&gt; &amp;handlerSpecificContexts) {
-<a name="l00398"></a>00398                 vector&lt;HandlerPtr&gt;::iterator it;
-<a name="l00399"></a>00399                 
-<a name="l00400"></a>00400                 <span class="keywordflow">for</span> (it = <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.begin(); it != <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.end(); it++) {
-<a name="l00401"></a>00401                         handlerSpecificContexts.push_back((*it)-&gt;newClient(context));
-<a name="l00402"></a>00402                 }
-<a name="l00403"></a>00403         }
-<a name="l00404"></a>00404         
-<a name="l00405"></a>00405         <span class="keywordtype">bool</span> processMessage(CommonClientContext &amp;commonContext,
-<a name="l00406"></a>00406                             vector&lt;ClientContextPtr&gt; &amp;handlerSpecificContexts,
-<a name="l00407"></a>00407                             <span class="keyword">const</span> vector&lt;string&gt; &amp;args) {
-<a name="l00408"></a>00408                 vector&lt;HandlerPtr&gt;::iterator handler_iter;
-<a name="l00409"></a>00409                 vector&lt;ClientContextPtr&gt;::iterator context_iter;
-<a name="l00410"></a>00410                 
-<a name="l00411"></a>00411                 <span class="keywordflow">for</span> (handler_iter = <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.begin(), context_iter = handlerSpecificContexts.begin();
-<a name="l00412"></a>00412                      handler_iter != <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.end();
-<a name="l00413"></a>00413                      handler_iter++, context_iter++) {
-<a name="l00414"></a>00414                         <span class="keywordflow">if</span> ((*handler_iter)-&gt;processMessage(commonContext, *context_iter, args)) {
-<a name="l00415"></a>00415                                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-<a name="l00416"></a>00416                         }
-<a name="l00417"></a>00417                 }
-<a name="l00418"></a>00418                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00419"></a>00419         }
-<a name="l00420"></a>00420         
-<a name="l00421"></a>00421         <span class="keywordtype">void</span> processUnknownMessage(CommonClientContext &amp;commonContext, <span class="keyword">const</span> vector&lt;string&gt; &amp;args) {
-<a name="l00422"></a>00422                 TRACE_POINT();
-<a name="l00423"></a>00423                 <span class="keywordtype">string</span> name;
-<a name="l00424"></a>00424                 <span class="keywordflow">if</span> (args.empty()) {
-<a name="l00425"></a>00425                         name = <span class="stringliteral">&quot;(null)&quot;</span>;
-<a name="l00426"></a>00426                 } <span class="keywordflow">else</span> {
-<a name="l00427"></a>00427                         name = args[0];
-<a name="l00428"></a>00428                 }
-<a name="l00429"></a>00429                 P_TRACE(2, <span class="stringliteral">&quot;A MessageServer client sent an invalid command: &quot;</span>
-<a name="l00430"></a>00430                         &lt;&lt; name &lt;&lt; <span class="stringliteral">&quot; (&quot;</span> &lt;&lt; args.size() &lt;&lt; <span class="stringliteral">&quot; elements)&quot;</span>);
-<a name="l00431"></a>00431         }
-<a name="l00432"></a>00432         <span class="comment"></span>
-<a name="l00433"></a>00433 <span class="comment">        /**</span>
-<a name="l00434"></a>00434 <span class="comment">         * The main function for a thread which handles a client.</span>
-<a name="l00435"></a>00435 <span class="comment">         */</span>
-<a name="l00436"></a><a class="code" href="classPassenger_1_1MessageServer.html#ac7d708f90b3a1b1ae5e7b215c688c95e">00436</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#ac7d708f90b3a1b1ae5e7b215c688c95e" title="The main function for a thread which handles a client.">clientHandlingMainLoop</a>(<a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;client) {
-<a name="l00437"></a>00437                 TRACE_POINT();
-<a name="l00438"></a>00438                 vector&lt;string&gt; args;
-<a name="l00439"></a>00439                 
-<a name="l00440"></a>00440                 P_TRACE(4, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; started.&quot;</span>);
-<a name="l00441"></a>00441                 
-<a name="l00442"></a>00442                 <span class="keywordflow">try</span> {
-<a name="l00443"></a>00443                         AccountPtr account(<a class="code" href="classPassenger_1_1MessageServer.html#a6687fdc90ef1c361a69c0fdcde38bb42" title="Authenticate the given client and returns its account information.">authenticate</a>(client));
-<a name="l00444"></a>00444                         <span class="keywordflow">if</span> (account == NULL) {
-<a name="l00445"></a>00445                                 P_TRACE(4, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; exited.&quot;</span>);
-<a name="l00446"></a>00446                                 <span class="keywordflow">return</span>;
-<a name="l00447"></a>00447                         }
-<a name="l00448"></a>00448                         
-<a name="l00449"></a>00449                         <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> commonContext(client, account);
-<a name="l00450"></a>00450                         vector&lt;ClientContextPtr&gt; handlerSpecificContexts;
-<a name="l00451"></a>00451                         broadcastNewClientEvent(commonContext, handlerSpecificContexts);
-<a name="l00452"></a>00452                         <a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a> dguard(<a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>, commonContext, handlerSpecificContexts);
-<a name="l00453"></a>00453                         
-<a name="l00454"></a>00454                         <span class="keywordflow">while</span> (!this_thread::interruption_requested()) {
-<a name="l00455"></a>00455                                 UPDATE_TRACE_POINT();
-<a name="l00456"></a>00456                                 <span class="keywordflow">if</span> (!commonContext.<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
-<a name="l00457"></a>00457                                         <span class="comment">// Client closed connection.</span>
-<a name="l00458"></a>00458                                         <span class="keywordflow">break</span>;
-<a name="l00459"></a>00459                                 }
-<a name="l00460"></a>00460                                 
-<a name="l00461"></a>00461                                 P_TRACE(4, <span class="stringliteral">&quot;MessageServer client &quot;</span> &lt;&lt; commonContext.<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ac7779e4dafe06a54fc3075ddf7e3f25b" title="Returns a string representation for this client context.">name</a>() &lt;&lt;
-<a name="l00462"></a>00462                                         <span class="stringliteral">&quot;: received message: &quot;</span> &lt;&lt; toString(args));
-<a name="l00463"></a>00463                                 
-<a name="l00464"></a>00464                                 UPDATE_TRACE_POINT();
-<a name="l00465"></a>00465                                 <span class="keywordflow">if</span> (!processMessage(commonContext, handlerSpecificContexts, args)) {
-<a name="l00466"></a>00466                                         processUnknownMessage(commonContext, args);
-<a name="l00467"></a>00467                                         <span class="keywordflow">break</span>;
-<a name="l00468"></a>00468                                 }
-<a name="l00469"></a>00469                                 args.clear();
-<a name="l00470"></a>00470                         }
-<a name="l00471"></a>00471                         
-<a name="l00472"></a>00472                         P_TRACE(4, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; exited.&quot;</span>);
-<a name="l00473"></a>00473                         client.<a class="code" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close</a>();
-<a name="l00474"></a>00474                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> boost::thread_interrupted &amp;) {
-<a name="l00475"></a>00475                         P_TRACE(2, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; interrupted.&quot;</span>);
-<a name="l00476"></a>00476                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> tracable_exception &amp;e) {
-<a name="l00477"></a>00477                         P_TRACE(2, <span class="stringliteral">&quot;An error occurred in a MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot;:\n&quot;</span>
-<a name="l00478"></a>00478                                 &lt;&lt; <span class="stringliteral">&quot;   message: &quot;</span> &lt;&lt; toString(args) &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>
-<a name="l00479"></a>00479                                 &lt;&lt; <span class="stringliteral">&quot;   exception: &quot;</span> &lt;&lt; e.what() &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>
-<a name="l00480"></a>00480                                 &lt;&lt; <span class="stringliteral">&quot;   backtrace:\n&quot;</span> &lt;&lt; e.backtrace());
-<a name="l00481"></a>00481                 }
-<a name="l00482"></a>00482         }
-<a name="l00483"></a>00483         
-<a name="l00484"></a>00484 <span class="keyword">public</span>:<span class="comment"></span>
-<a name="l00485"></a>00485 <span class="comment">        /**</span>
-<a name="l00486"></a>00486 <span class="comment">         * Creates a new MessageServer object.</span>
-<a name="l00487"></a>00487 <span class="comment">         * The actual server main loop is not started until you call mainLoop().</span>
-<a name="l00488"></a>00488 <span class="comment">         *</span>
-<a name="l00489"></a>00489 <span class="comment">         * @param socketFilename The socket filename on which this MessageServer</span>
-<a name="l00490"></a>00490 <span class="comment">         *                       should be listening.</span>
-<a name="l00491"></a>00491 <span class="comment">         * @param accountsDatabase An accounts database for this server, used for</span>
-<a name="l00492"></a>00492 <span class="comment">         *                         authenticating clients.</span>
-<a name="l00493"></a>00493 <span class="comment">         * @throws RuntimeException Something went wrong while setting up the server socket.</span>
-<a name="l00494"></a>00494 <span class="comment">         * @throws SystemException Something went wrong while setting up the server socket.</span>
-<a name="l00495"></a>00495 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00496"></a>00496 <span class="comment">         */</span>
-<a name="l00497"></a><a class="code" href="classPassenger_1_1MessageServer.html#a4b6f33e66261116c2ec04b26e651dc18">00497</a>         <a class="code" href="classPassenger_1_1MessageServer.html#a4b6f33e66261116c2ec04b26e651dc18" title="Creates a new MessageServer object.">MessageServer</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>, AccountsDatabasePtr <a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93" title="An accounts database, used for authenticating clients.">accountsDatabase</a>) {
-<a name="l00498"></a>00498                 this-&gt;socketFilename   = socketFilename;
-<a name="l00499"></a>00499                 this-&gt;accountsDatabase = accountsDatabase;
-<a name="l00500"></a>00500                 <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a> = 2000;
-<a name="l00501"></a>00501                 <a class="code" href="classPassenger_1_1MessageServer.html#a86f9ec99fe5dbed5c04d4b9e8f170995" title="Create a server socket and set it up for listening.">startListening</a>();
-<a name="l00502"></a>00502         }
-<a name="l00503"></a>00503         
-<a name="l00504"></a>00504         ~<a class="code" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a>() {
-<a name="l00505"></a>00505                 this_thread::disable_syscall_interruption dsi;
-<a name="l00506"></a>00506                 syscalls::close(<a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a>);
-<a name="l00507"></a>00507                 syscalls::unlink(<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>.c_str());
+<a name="l00299"></a>00299 <span class="comment">        /** The server socket&#39;s file descriptor.</span>
+<a name="l00300"></a>00300 <span class="comment">         * @invariant serverFd &gt;= 0</span>
+<a name="l00301"></a>00301 <span class="comment">         */</span>
+<a name="l00302"></a><a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4">00302</a>         <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a>;
+<a name="l00303"></a>00303         
+<a name="l00304"></a>00304         <span class="comment"></span>
+<a name="l00305"></a>00305 <span class="comment">        /** Calls clientDisconnected() on all handlers when destroyed. */</span>
+<a name="l00306"></a><a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html">00306</a>         <span class="keyword">struct </span><a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a> {
+<a name="l00307"></a>00307                 vector&lt;HandlerPtr&gt; &amp;handlers;
+<a name="l00308"></a>00308                 <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;commonContext;
+<a name="l00309"></a>00309                 vector&lt;ClientContextPtr&gt; &amp;handlerSpecificContexts;
+<a name="l00310"></a>00310                 
+<a name="l00311"></a>00311                 <a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a>(vector&lt;HandlerPtr&gt; &amp;_handlers,
+<a name="l00312"></a>00312                                               <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> &amp;_commonContext,
+<a name="l00313"></a>00313                                               vector&lt;ClientContextPtr&gt; &amp;_handlerSpecificContexts)
+<a name="l00314"></a>00314                 : handlers(_handlers),
+<a name="l00315"></a>00315                   commonContext(_commonContext),
+<a name="l00316"></a>00316                   handlerSpecificContexts(_handlerSpecificContexts)
+<a name="l00317"></a>00317                 { }
+<a name="l00318"></a>00318                 
+<a name="l00319"></a>00319                 ~<a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a>() {
+<a name="l00320"></a>00320                         vector&lt;HandlerPtr&gt;::iterator handler_iter;
+<a name="l00321"></a>00321                         vector&lt;ClientContextPtr&gt;::iterator context_iter;
+<a name="l00322"></a>00322 
+<a name="l00323"></a>00323                         <span class="keywordflow">for</span> (handler_iter = handlers.begin(), context_iter = handlerSpecificContexts.begin();
+<a name="l00324"></a>00324                              handler_iter != handlers.end();
+<a name="l00325"></a>00325                              handler_iter++, context_iter++) {
+<a name="l00326"></a>00326                                 (*handler_iter)-&gt;clientDisconnected(commonContext, *context_iter);
+<a name="l00327"></a>00327                         }
+<a name="l00328"></a>00328                 }
+<a name="l00329"></a>00329         };
+<a name="l00330"></a>00330         
+<a name="l00331"></a>00331         <span class="comment"></span>
+<a name="l00332"></a>00332 <span class="comment">        /**</span>
+<a name="l00333"></a>00333 <span class="comment">         * Create a server socket and set it up for listening. This socket will</span>
+<a name="l00334"></a>00334 <span class="comment">         * be world-writable.</span>
+<a name="l00335"></a>00335 <span class="comment">         *</span>
+<a name="l00336"></a>00336 <span class="comment">         * @throws RuntimeException</span>
+<a name="l00337"></a>00337 <span class="comment">         * @throws SystemException</span>
+<a name="l00338"></a>00338 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00339"></a>00339 <span class="comment">         */</span>
+<a name="l00340"></a><a class="code" href="classPassenger_1_1MessageServer.html#a86f9ec99fe5dbed5c04d4b9e8f170995">00340</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#a86f9ec99fe5dbed5c04d4b9e8f170995" title="Create a server socket and set it up for listening.">startListening</a>() {
+<a name="l00341"></a>00341                 TRACE_POINT();
+<a name="l00342"></a>00342                 <span class="keywordtype">int</span> ret;
+<a name="l00343"></a>00343                 
+<a name="l00344"></a>00344                 <a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a> = createUnixServer(<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>.c_str());
+<a name="l00345"></a>00345                 <span class="keywordflow">do</span> {
+<a name="l00346"></a>00346                         ret = chmod(<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>.c_str(),
+<a name="l00347"></a>00347                                 S_ISVTX |
+<a name="l00348"></a>00348                                 S_IRUSR | S_IWUSR | S_IXUSR |
+<a name="l00349"></a>00349                                 S_IRGRP | S_IWGRP | S_IXGRP |
+<a name="l00350"></a>00350                                 S_IROTH | S_IWOTH | S_IXOTH);
+<a name="l00351"></a>00351                 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00352"></a>00352         }
+<a name="l00353"></a>00353         <span class="comment"></span>
+<a name="l00354"></a>00354 <span class="comment">        /**</span>
+<a name="l00355"></a>00355 <span class="comment">         * Authenticate the given client and returns its account information.</span>
+<a name="l00356"></a>00356 <span class="comment">         *</span>
+<a name="l00357"></a>00357 <span class="comment">         * @return A smart pointer to an Account object, or NULL if authentication failed.</span>
+<a name="l00358"></a>00358 <span class="comment">         */</span>
+<a name="l00359"></a><a class="code" href="classPassenger_1_1MessageServer.html#a6687fdc90ef1c361a69c0fdcde38bb42">00359</a>         AccountPtr <a class="code" href="classPassenger_1_1MessageServer.html#a6687fdc90ef1c361a69c0fdcde38bb42" title="Authenticate the given client and returns its account information.">authenticate</a>(<a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;client) {
+<a name="l00360"></a>00360                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(client);
+<a name="l00361"></a>00361                 <span class="keywordtype">string</span> username, password;
+<a name="l00362"></a>00362                 MemZeroGuard passwordGuard(password);
+<a name="l00363"></a>00363                 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timeout = <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a>;
+<a name="l00364"></a>00364                 
+<a name="l00365"></a>00365                 <span class="keywordflow">try</span> {
+<a name="l00366"></a>00366                         channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;version&quot;</span>, <span class="stringliteral">&quot;1&quot;</span>, NULL);
+<a name="l00367"></a>00367                         
+<a name="l00368"></a>00368                         <span class="keywordflow">try</span> {
+<a name="l00369"></a>00369                                 <span class="keywordflow">if</span> (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(username, MESSAGE_SERVER_MAX_USERNAME_SIZE, &amp;timeout)) {
+<a name="l00370"></a>00370                                         <span class="keywordflow">return</span> AccountPtr();
+<a name="l00371"></a>00371                                 }
+<a name="l00372"></a>00372                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a> &amp;) {
+<a name="l00373"></a>00373                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;The supplied username is too long.&quot;</span>, NULL);
+<a name="l00374"></a>00374                                 <span class="keywordflow">return</span> AccountPtr();
+<a name="l00375"></a>00375                         }
+<a name="l00376"></a>00376                         
+<a name="l00377"></a>00377                         <span class="keywordflow">try</span> {
+<a name="l00378"></a>00378                                 <span class="keywordflow">if</span> (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(password, MESSAGE_SERVER_MAX_PASSWORD_SIZE, &amp;timeout)) {
+<a name="l00379"></a>00379                                         <span class="keywordflow">return</span> AccountPtr();
+<a name="l00380"></a>00380                                 }
+<a name="l00381"></a>00381                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a> &amp;) {
+<a name="l00382"></a>00382                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;The supplied password is too long.&quot;</span>, NULL);
+<a name="l00383"></a>00383                                 <span class="keywordflow">return</span> AccountPtr();
+<a name="l00384"></a>00384                         }
+<a name="l00385"></a>00385                         
+<a name="l00386"></a>00386                         AccountPtr account = <a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93" title="An accounts database, used for authenticating clients.">accountsDatabase</a>-&gt;authenticate(username, password);
+<a name="l00387"></a>00387                         passwordGuard.zeroNow();
+<a name="l00388"></a>00388                         <span class="keywordflow">if</span> (account == NULL) {
+<a name="l00389"></a>00389                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;Invalid username or password.&quot;</span>, NULL);
+<a name="l00390"></a>00390                                 <span class="keywordflow">return</span> AccountPtr();
+<a name="l00391"></a>00391                         } <span class="keywordflow">else</span> {
+<a name="l00392"></a>00392                                 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;ok&quot;</span>, NULL);
+<a name="l00393"></a>00393                                 <span class="keywordflow">return</span> account;
+<a name="l00394"></a>00394                         }
+<a name="l00395"></a>00395                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &amp;) {
+<a name="l00396"></a>00396                         <span class="keywordflow">return</span> AccountPtr();
+<a name="l00397"></a>00397                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> <a class="code" href="classPassenger_1_1TimeoutException.html" title="An exception indicating that some timeout expired.">TimeoutException</a> &amp;) {
+<a name="l00398"></a>00398                         <span class="keywordflow">return</span> AccountPtr();
+<a name="l00399"></a>00399                 }
+<a name="l00400"></a>00400         }
+<a name="l00401"></a>00401         
+<a name="l00402"></a>00402         <span class="keywordtype">void</span> broadcastNewClientEvent(CommonClientContext &amp;context,
+<a name="l00403"></a>00403                                      vector&lt;ClientContextPtr&gt; &amp;handlerSpecificContexts) {
+<a name="l00404"></a>00404                 vector&lt;HandlerPtr&gt;::iterator it;
+<a name="l00405"></a>00405                 
+<a name="l00406"></a>00406                 <span class="keywordflow">for</span> (it = <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.begin(); it != <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.end(); it++) {
+<a name="l00407"></a>00407                         handlerSpecificContexts.push_back((*it)-&gt;newClient(context));
+<a name="l00408"></a>00408                 }
+<a name="l00409"></a>00409         }
+<a name="l00410"></a>00410         
+<a name="l00411"></a>00411         <span class="keywordtype">bool</span> processMessage(CommonClientContext &amp;commonContext,
+<a name="l00412"></a>00412                             vector&lt;ClientContextPtr&gt; &amp;handlerSpecificContexts,
+<a name="l00413"></a>00413                             <span class="keyword">const</span> vector&lt;string&gt; &amp;args) {
+<a name="l00414"></a>00414                 vector&lt;HandlerPtr&gt;::iterator handler_iter;
+<a name="l00415"></a>00415                 vector&lt;ClientContextPtr&gt;::iterator context_iter;
+<a name="l00416"></a>00416                 
+<a name="l00417"></a>00417                 <span class="keywordflow">for</span> (handler_iter = <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.begin(), context_iter = handlerSpecificContexts.begin();
+<a name="l00418"></a>00418                      handler_iter != <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.end();
+<a name="l00419"></a>00419                      handler_iter++, context_iter++) {
+<a name="l00420"></a>00420                         <span class="keywordflow">if</span> ((*handler_iter)-&gt;processMessage(commonContext, *context_iter, args)) {
+<a name="l00421"></a>00421                                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00422"></a>00422                         }
+<a name="l00423"></a>00423                 }
+<a name="l00424"></a>00424                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00425"></a>00425         }
+<a name="l00426"></a>00426         
+<a name="l00427"></a>00427         <span class="keywordtype">void</span> processUnknownMessage(CommonClientContext &amp;commonContext, <span class="keyword">const</span> vector&lt;string&gt; &amp;args) {
+<a name="l00428"></a>00428                 TRACE_POINT();
+<a name="l00429"></a>00429                 <span class="keywordtype">string</span> name;
+<a name="l00430"></a>00430                 <span class="keywordflow">if</span> (args.empty()) {
+<a name="l00431"></a>00431                         name = <span class="stringliteral">&quot;(null)&quot;</span>;
+<a name="l00432"></a>00432                 } <span class="keywordflow">else</span> {
+<a name="l00433"></a>00433                         name = args[0];
+<a name="l00434"></a>00434                 }
+<a name="l00435"></a>00435                 P_TRACE(2, <span class="stringliteral">&quot;A MessageServer client sent an invalid command: &quot;</span>
+<a name="l00436"></a>00436                         &lt;&lt; name &lt;&lt; <span class="stringliteral">&quot; (&quot;</span> &lt;&lt; args.size() &lt;&lt; <span class="stringliteral">&quot; elements)&quot;</span>);
+<a name="l00437"></a>00437         }
+<a name="l00438"></a>00438         <span class="comment"></span>
+<a name="l00439"></a>00439 <span class="comment">        /**</span>
+<a name="l00440"></a>00440 <span class="comment">         * The main function for a thread which handles a client.</span>
+<a name="l00441"></a>00441 <span class="comment">         */</span>
+<a name="l00442"></a><a class="code" href="classPassenger_1_1MessageServer.html#ac7d708f90b3a1b1ae5e7b215c688c95e">00442</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#ac7d708f90b3a1b1ae5e7b215c688c95e" title="The main function for a thread which handles a client.">clientHandlingMainLoop</a>(<a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;client) {
+<a name="l00443"></a>00443                 TRACE_POINT();
+<a name="l00444"></a>00444                 vector&lt;string&gt; args;
+<a name="l00445"></a>00445                 
+<a name="l00446"></a>00446                 P_TRACE(4, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; started.&quot;</span>);
+<a name="l00447"></a>00447                 
+<a name="l00448"></a>00448                 <span class="keywordflow">try</span> {
+<a name="l00449"></a>00449                         AccountPtr account(<a class="code" href="classPassenger_1_1MessageServer.html#a6687fdc90ef1c361a69c0fdcde38bb42" title="Authenticate the given client and returns its account information.">authenticate</a>(client));
+<a name="l00450"></a>00450                         <span class="keywordflow">if</span> (account == NULL) {
+<a name="l00451"></a>00451                                 P_TRACE(4, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; exited.&quot;</span>);
+<a name="l00452"></a>00452                                 <span class="keywordflow">return</span>;
+<a name="l00453"></a>00453                         }
+<a name="l00454"></a>00454                         
+<a name="l00455"></a>00455                         <a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html" title="A common client context, containing client-specific information used by MessageServer...">CommonClientContext</a> commonContext(client, account);
+<a name="l00456"></a>00456                         vector&lt;ClientContextPtr&gt; handlerSpecificContexts;
+<a name="l00457"></a>00457                         broadcastNewClientEvent(commonContext, handlerSpecificContexts);
+<a name="l00458"></a>00458                         <a class="code" href="structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html" title="Calls clientDisconnected() on all handlers when destroyed.">DisconnectEventBroadcastGuard</a> dguard(<a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>, commonContext, handlerSpecificContexts);
+<a name="l00459"></a>00459                         
+<a name="l00460"></a>00460                         <span class="keywordflow">while</span> (!this_thread::interruption_requested()) {
+<a name="l00461"></a>00461                                 UPDATE_TRACE_POINT();
+<a name="l00462"></a>00462                                 <span class="keywordflow">if</span> (!commonContext.<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#a82bbd9638775bff588746fadd63a2ac8" title="The channel that&amp;#39;s associated with the client&amp;#39;s socket.">channel</a>.<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
+<a name="l00463"></a>00463                                         <span class="comment">// Client closed connection.</span>
+<a name="l00464"></a>00464                                         <span class="keywordflow">break</span>;
+<a name="l00465"></a>00465                                 }
+<a name="l00466"></a>00466                                 
+<a name="l00467"></a>00467                                 P_TRACE(4, <span class="stringliteral">&quot;MessageServer client &quot;</span> &lt;&lt; commonContext.<a class="code" href="classPassenger_1_1MessageServer_1_1CommonClientContext.html#ac7779e4dafe06a54fc3075ddf7e3f25b" title="Returns a string representation for this client context.">name</a>() &lt;&lt;
+<a name="l00468"></a>00468                                         <span class="stringliteral">&quot;: received message: &quot;</span> &lt;&lt; toString(args));
+<a name="l00469"></a>00469                                 
+<a name="l00470"></a>00470                                 UPDATE_TRACE_POINT();
+<a name="l00471"></a>00471                                 <span class="keywordflow">if</span> (!processMessage(commonContext, handlerSpecificContexts, args)) {
+<a name="l00472"></a>00472                                         processUnknownMessage(commonContext, args);
+<a name="l00473"></a>00473                                         <span class="keywordflow">break</span>;
+<a name="l00474"></a>00474                                 }
+<a name="l00475"></a>00475                                 args.clear();
+<a name="l00476"></a>00476                         }
+<a name="l00477"></a>00477                         
+<a name="l00478"></a>00478                         P_TRACE(4, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; exited.&quot;</span>);
+<a name="l00479"></a>00479                         client.<a class="code" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close</a>();
+<a name="l00480"></a>00480                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> boost::thread_interrupted &amp;) {
+<a name="l00481"></a>00481                         P_TRACE(2, <span class="stringliteral">&quot;MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot; interrupted.&quot;</span>);
+<a name="l00482"></a>00482                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> tracable_exception &amp;e) {
+<a name="l00483"></a>00483                         P_TRACE(2, <span class="stringliteral">&quot;An error occurred in a MessageServer client thread &quot;</span> &lt;&lt; (<span class="keywordtype">int</span>) client &lt;&lt; <span class="stringliteral">&quot;:\n&quot;</span>
+<a name="l00484"></a>00484                                 &lt;&lt; <span class="stringliteral">&quot;   message: &quot;</span> &lt;&lt; toString(args) &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>
+<a name="l00485"></a>00485                                 &lt;&lt; <span class="stringliteral">&quot;   exception: &quot;</span> &lt;&lt; e.what() &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>
+<a name="l00486"></a>00486                                 &lt;&lt; <span class="stringliteral">&quot;   backtrace:\n&quot;</span> &lt;&lt; e.backtrace());
+<a name="l00487"></a>00487                 }
+<a name="l00488"></a>00488         }
+<a name="l00489"></a>00489         
+<a name="l00490"></a>00490 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00491"></a>00491 <span class="comment">        /**</span>
+<a name="l00492"></a>00492 <span class="comment">         * Creates a new MessageServer object.</span>
+<a name="l00493"></a>00493 <span class="comment">         * The actual server main loop is not started until you call mainLoop().</span>
+<a name="l00494"></a>00494 <span class="comment">         *</span>
+<a name="l00495"></a>00495 <span class="comment">         * @param socketFilename The socket filename on which this MessageServer</span>
+<a name="l00496"></a>00496 <span class="comment">         *                       should be listening.</span>
+<a name="l00497"></a>00497 <span class="comment">         * @param accountsDatabase An accounts database for this server, used for</span>
+<a name="l00498"></a>00498 <span class="comment">         *                         authenticating clients.</span>
+<a name="l00499"></a>00499 <span class="comment">         * @throws RuntimeException Something went wrong while setting up the server socket.</span>
+<a name="l00500"></a>00500 <span class="comment">         * @throws SystemException Something went wrong while setting up the server socket.</span>
+<a name="l00501"></a>00501 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00502"></a>00502 <span class="comment">         */</span>
+<a name="l00503"></a><a class="code" href="classPassenger_1_1MessageServer.html#a4b6f33e66261116c2ec04b26e651dc18">00503</a>         <a class="code" href="classPassenger_1_1MessageServer.html#a4b6f33e66261116c2ec04b26e651dc18" title="Creates a new MessageServer object.">MessageServer</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>, AccountsDatabasePtr <a class="code" href="classPassenger_1_1MessageServer.html#a4705130bf6626dd2201e7d73ead57b93" title="An accounts database, used for authenticating clients.">accountsDatabase</a>) {
+<a name="l00504"></a>00504                 this-&gt;socketFilename   = socketFilename;
+<a name="l00505"></a>00505                 this-&gt;accountsDatabase = accountsDatabase;
+<a name="l00506"></a>00506                 <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a> = 2000;
+<a name="l00507"></a>00507                 <a class="code" href="classPassenger_1_1MessageServer.html#a86f9ec99fe5dbed5c04d4b9e8f170995" title="Create a server socket and set it up for listening.">startListening</a>();
 <a name="l00508"></a>00508         }
 <a name="l00509"></a>00509         
-<a name="l00510"></a>00510         <span class="keywordtype">string</span> getSocketFilename()<span class="keyword"> const </span>{
-<a name="l00511"></a>00511                 <span class="keywordflow">return</span> <a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>;
-<a name="l00512"></a>00512         }
-<a name="l00513"></a>00513         <span class="comment"></span>
-<a name="l00514"></a>00514 <span class="comment">        /**</span>
-<a name="l00515"></a>00515 <span class="comment">         * Starts the server main loop. This method will loop forever until some</span>
-<a name="l00516"></a>00516 <span class="comment">         * other thread interrupts the calling thread, or until an exception is raised.</span>
-<a name="l00517"></a>00517 <span class="comment">         *</span>
-<a name="l00518"></a>00518 <span class="comment">         * @throws SystemException Unable to accept a new connection. If this is a</span>
-<a name="l00519"></a>00519 <span class="comment">         *                         non-fatal error then you may call mainLoop() again</span>
-<a name="l00520"></a>00520 <span class="comment">         *                         to restart the server main loop.</span>
-<a name="l00521"></a>00521 <span class="comment">         * @throws boost::thread_interrupted The calling thread has been interrupted.</span>
-<a name="l00522"></a>00522 <span class="comment">         */</span>
-<a name="l00523"></a><a class="code" href="classPassenger_1_1MessageServer.html#aaf639d8228da241b957c707ef0f04c91">00523</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#aaf639d8228da241b957c707ef0f04c91" title="Starts the server main loop.">mainLoop</a>() {
-<a name="l00524"></a>00524                 TRACE_POINT();
-<a name="l00525"></a>00525                 <span class="keywordflow">while</span> (<span class="keyword">true</span>) {
-<a name="l00526"></a>00526                         this_thread::interruption_point();
-<a name="l00527"></a>00527                         sockaddr_un addr;
-<a name="l00528"></a>00528                         socklen_t len = <span class="keyword">sizeof</span>(addr);
-<a name="l00529"></a>00529                         <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> fd;
-<a name="l00530"></a>00530                         
-<a name="l00531"></a>00531                         UPDATE_TRACE_POINT();
-<a name="l00532"></a>00532                         fd = syscalls::accept(<a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a>, (<span class="keyword">struct</span> sockaddr *) &amp;addr, &amp;len);
-<a name="l00533"></a>00533                         <span class="keywordflow">if</span> (fd == -1) {
-<a name="l00534"></a>00534                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">&quot;Unable to accept a new client&quot;</span>, errno);
-<a name="l00535"></a>00535                         }
+<a name="l00510"></a>00510         ~<a class="code" href="classPassenger_1_1MessageServer.html" title="Simple pluggable request/response messaging server framework.">MessageServer</a>() {
+<a name="l00511"></a>00511                 this_thread::disable_syscall_interruption dsi;
+<a name="l00512"></a>00512                 syscalls::close(<a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a>);
+<a name="l00513"></a>00513                 syscalls::unlink(<a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>.c_str());
+<a name="l00514"></a>00514         }
+<a name="l00515"></a>00515         
+<a name="l00516"></a>00516         <span class="keywordtype">string</span> getSocketFilename()<span class="keyword"> const </span>{
+<a name="l00517"></a>00517                 <span class="keywordflow">return</span> <a class="code" href="classPassenger_1_1MessageServer.html#a18f4966401ab1f1ef245af922b382ce3" title="The filename of the server socket on which this MessageServer is listening.">socketFilename</a>;
+<a name="l00518"></a>00518         }
+<a name="l00519"></a>00519         <span class="comment"></span>
+<a name="l00520"></a>00520 <span class="comment">        /**</span>
+<a name="l00521"></a>00521 <span class="comment">         * Starts the server main loop. This method will loop forever until some</span>
+<a name="l00522"></a>00522 <span class="comment">         * other thread interrupts the calling thread, or until an exception is raised.</span>
+<a name="l00523"></a>00523 <span class="comment">         *</span>
+<a name="l00524"></a>00524 <span class="comment">         * @throws SystemException Unable to accept a new connection. If this is a</span>
+<a name="l00525"></a>00525 <span class="comment">         *                         non-fatal error then you may call mainLoop() again</span>
+<a name="l00526"></a>00526 <span class="comment">         *                         to restart the server main loop.</span>
+<a name="l00527"></a>00527 <span class="comment">         * @throws boost::thread_interrupted The calling thread has been interrupted.</span>
+<a name="l00528"></a>00528 <span class="comment">         */</span>
+<a name="l00529"></a><a class="code" href="classPassenger_1_1MessageServer.html#aaf639d8228da241b957c707ef0f04c91">00529</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#aaf639d8228da241b957c707ef0f04c91" title="Starts the server main loop.">mainLoop</a>() {
+<a name="l00530"></a>00530                 TRACE_POINT();
+<a name="l00531"></a>00531                 <span class="keywordflow">while</span> (<span class="keyword">true</span>) {
+<a name="l00532"></a>00532                         this_thread::interruption_point();
+<a name="l00533"></a>00533                         sockaddr_un addr;
+<a name="l00534"></a>00534                         socklen_t len = <span class="keyword">sizeof</span>(addr);
+<a name="l00535"></a>00535                         <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> fd;
 <a name="l00536"></a>00536                         
 <a name="l00537"></a>00537                         UPDATE_TRACE_POINT();
-<a name="l00538"></a>00538                         this_thread::disable_interruption di;
-<a name="l00539"></a>00539                         this_thread::disable_syscall_interruption dsi;
-<a name="l00540"></a>00540                         
-<a name="l00541"></a>00541                         function&lt;void ()&gt; func(boost::bind(&amp;<a class="code" href="classPassenger_1_1MessageServer.html#ac7d708f90b3a1b1ae5e7b215c688c95e" title="The main function for a thread which handles a client.">MessageServer::clientHandlingMainLoop</a>,
-<a name="l00542"></a>00542                                 <span class="keyword">this</span>, fd));
-<a name="l00543"></a>00543                         <span class="keywordtype">string</span> name = <span class="stringliteral">&quot;MessageServer client thread &quot;</span>;
-<a name="l00544"></a>00544                         name.append(toString(fd));
-<a name="l00545"></a>00545                         <a class="code" href="classPassenger_1_1MessageServer.html#a48ccf2c09c2c8b5dcfe3a0585dba67cf" title="The client threads.">threadGroup</a>.create_thread(func, name, CLIENT_THREAD_STACK_SIZE);
-<a name="l00546"></a>00546                 }
-<a name="l00547"></a>00547         }
-<a name="l00548"></a>00548         <span class="comment"></span>
-<a name="l00549"></a>00549 <span class="comment">        /**</span>
-<a name="l00550"></a>00550 <span class="comment">         * Registers a new handler.</span>
-<a name="l00551"></a>00551 <span class="comment">         * </span>
-<a name="l00552"></a>00552 <span class="comment">         * @pre The main loop isn&#39;t running.</span>
-<a name="l00553"></a>00553 <span class="comment">         */</span>
-<a name="l00554"></a><a class="code" href="classPassenger_1_1MessageServer.html#a8f5df648df67f85ab0b7317be21f643f">00554</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#a8f5df648df67f85ab0b7317be21f643f" title="Registers a new handler.">addHandler</a>(HandlerPtr handler) {
-<a name="l00555"></a>00555                 <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.push_back(handler);
-<a name="l00556"></a>00556         }
-<a name="l00557"></a>00557         <span class="comment"></span>
-<a name="l00558"></a>00558 <span class="comment">        /**</span>
-<a name="l00559"></a>00559 <span class="comment">         * Sets the maximum number of milliseconds that clients may spend on logging in.</span>
-<a name="l00560"></a>00560 <span class="comment">         * Clients that take longer are disconnected.</span>
-<a name="l00561"></a>00561 <span class="comment">         *</span>
-<a name="l00562"></a>00562 <span class="comment">         * @pre timeout != 0</span>
-<a name="l00563"></a>00563 <span class="comment">         * @pre The main loop isn&#39;t running.</span>
-<a name="l00564"></a>00564 <span class="comment">         */</span>
-<a name="l00565"></a><a class="code" href="classPassenger_1_1MessageServer.html#a91571b29a8a88f80bab68f8083f59291">00565</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#a91571b29a8a88f80bab68f8083f59291" title="Sets the maximum number of milliseconds that clients may spend on logging in.">setLoginTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timeout) {
-<a name="l00566"></a>00566                 assert(timeout != 0);
-<a name="l00567"></a>00567                 <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a> = timeout;
-<a name="l00568"></a>00568         }
-<a name="l00569"></a>00569 };
-<a name="l00570"></a>00570 
-<a name="l00571"></a>00571 <span class="keyword">typedef</span> shared_ptr&lt;MessageServer&gt; MessageServerPtr;
-<a name="l00572"></a>00572 
-<a name="l00573"></a>00573 } <span class="comment">// namespace Passenger</span>
-<a name="l00574"></a>00574 
-<a name="l00575"></a>00575 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_SERVER_H_ */</span>
+<a name="l00538"></a>00538                         fd = syscalls::accept(<a class="code" href="classPassenger_1_1MessageServer.html#aef3c642484fbbbfc46b7768c53a5c0d4" title="The server socket&amp;#39;s file descriptor.">serverFd</a>, (<span class="keyword">struct</span> sockaddr *) &amp;addr, &amp;len);
+<a name="l00539"></a>00539                         <span class="keywordflow">if</span> (fd == -1) {
+<a name="l00540"></a>00540                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">&quot;Unable to accept a new client&quot;</span>, errno);
+<a name="l00541"></a>00541                         }
+<a name="l00542"></a>00542                         
+<a name="l00543"></a>00543                         UPDATE_TRACE_POINT();
+<a name="l00544"></a>00544                         this_thread::disable_interruption di;
+<a name="l00545"></a>00545                         this_thread::disable_syscall_interruption dsi;
+<a name="l00546"></a>00546                         
+<a name="l00547"></a>00547                         function&lt;void ()&gt; func(boost::bind(&amp;<a class="code" href="classPassenger_1_1MessageServer.html#ac7d708f90b3a1b1ae5e7b215c688c95e" title="The main function for a thread which handles a client.">MessageServer::clientHandlingMainLoop</a>,
+<a name="l00548"></a>00548                                 <span class="keyword">this</span>, fd));
+<a name="l00549"></a>00549                         <span class="keywordtype">string</span> name = <span class="stringliteral">&quot;MessageServer client thread &quot;</span>;
+<a name="l00550"></a>00550                         name.append(toString(fd));
+<a name="l00551"></a>00551                         <a class="code" href="classPassenger_1_1MessageServer.html#a48ccf2c09c2c8b5dcfe3a0585dba67cf" title="The client threads.">threadGroup</a>.create_thread(func, name, CLIENT_THREAD_STACK_SIZE);
+<a name="l00552"></a>00552                 }
+<a name="l00553"></a>00553         }
+<a name="l00554"></a>00554         <span class="comment"></span>
+<a name="l00555"></a>00555 <span class="comment">        /**</span>
+<a name="l00556"></a>00556 <span class="comment">         * Registers a new handler.</span>
+<a name="l00557"></a>00557 <span class="comment">         * </span>
+<a name="l00558"></a>00558 <span class="comment">         * @pre The main loop isn&#39;t running.</span>
+<a name="l00559"></a>00559 <span class="comment">         */</span>
+<a name="l00560"></a><a class="code" href="classPassenger_1_1MessageServer.html#a8f5df648df67f85ab0b7317be21f643f">00560</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#a8f5df648df67f85ab0b7317be21f643f" title="Registers a new handler.">addHandler</a>(HandlerPtr handler) {
+<a name="l00561"></a>00561                 <a class="code" href="classPassenger_1_1MessageServer.html#abced7a8e542f6ab4a81ac1b11f8d163a" title="The registered message handlers.">handlers</a>.push_back(handler);
+<a name="l00562"></a>00562         }
+<a name="l00563"></a>00563         <span class="comment"></span>
+<a name="l00564"></a>00564 <span class="comment">        /**</span>
+<a name="l00565"></a>00565 <span class="comment">         * Sets the maximum number of milliseconds that clients may spend on logging in.</span>
+<a name="l00566"></a>00566 <span class="comment">         * Clients that take longer are disconnected.</span>
+<a name="l00567"></a>00567 <span class="comment">         *</span>
+<a name="l00568"></a>00568 <span class="comment">         * @pre timeout != 0</span>
+<a name="l00569"></a>00569 <span class="comment">         * @pre The main loop isn&#39;t running.</span>
+<a name="l00570"></a>00570 <span class="comment">         */</span>
+<a name="l00571"></a><a class="code" href="classPassenger_1_1MessageServer.html#a91571b29a8a88f80bab68f8083f59291">00571</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageServer.html#a91571b29a8a88f80bab68f8083f59291" title="Sets the maximum number of milliseconds that clients may spend on logging in.">setLoginTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timeout) {
+<a name="l00572"></a>00572                 assert(timeout != 0);
+<a name="l00573"></a>00573                 <a class="code" href="classPassenger_1_1MessageServer.html#abf5075add15c5f32a60039bdcbe98926" title="The maximum number of milliseconds that client may spend on logging in.">loginTimeout</a> = timeout;
+<a name="l00574"></a>00574         }
+<a name="l00575"></a>00575 };
+<a name="l00576"></a>00576 
+<a name="l00577"></a>00577 <span class="keyword">typedef</span> shared_ptr&lt;MessageServer&gt; MessageServerPtr;
+<a name="l00578"></a>00578 
+<a name="l00579"></a>00579 } <span class="comment">// namespace Passenger</span>
+<a name="l00580"></a>00580 
+<a name="l00581"></a>00581 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_SERVER_H_ */</span>
 </pre></div></div>
 <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
 <a href="http://www.doxygen.org/index.html">