RubyGems - passenger - Versions diffs - 3.0.4 → 3.0.5 - Mend

passenger 3.0.4 → 3.0.5

Potentially problematic release.

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

Files changed (571) hide show

data/doc/cxxapi/EventedMessageServer_8h_source.html ADDED

@@ -0,0 +1,358 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: EventedMessageServer.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>EventedMessageServer.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00006"></a>00006 <span class="comment"> *</span>
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_EVENTED_MESSAGE_SERVER_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_EVENTED_MESSAGE_SERVER_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;ev++.h&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;cstdarg&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &quot;EventedServer.h&quot;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &quot;MessageReadersWriters.h&quot;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;AccountsDatabase.h&quot;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &quot;Constants.h&quot;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &quot;Utils.h&quot;</span>
+<a name="l00036"></a>00036
+<a name="l00037"></a>00037 <span class="keyword">namespace </span>Passenger {
+<a name="l00038"></a>00038
+<a name="l00039"></a>00039 <span class="keyword">using namespace </span>boost;
+<a name="l00040"></a>00040
+<a name="l00041"></a>00041 <span class="comment">/* This source file follows the security guidelines written in Account.h. */</span>
+<a name="l00042"></a>00042
+<a name="l00043"></a>00043 <span class="keyword">struct </span>EventedMessageClientContext {
+<a name="l00044"></a>00044         <span class="keyword">enum</span> State {
+<a name="l00045"></a>00045                 MS_READING_USERNAME,
+<a name="l00046"></a>00046                 MS_READING_PASSWORD,
+<a name="l00047"></a>00047                 MS_READING_MESSAGE,
+<a name="l00048"></a>00048                 MS_PROCESSING_MESSAGE
+<a name="l00049"></a>00049         };
+<a name="l00050"></a>00050
+<a name="l00051"></a>00051         State state;
+<a name="l00052"></a>00052         AccountPtr account;
+<a name="l00053"></a>00053
+<a name="l00054"></a>00054         ev::timer authenticationTimer;
+<a name="l00055"></a>00055         ScalarMessage scalarReader;
+<a name="l00056"></a>00056         ArrayMessage arrayReader;
+<a name="l00057"></a>00057         <span class="keywordtype">string</span> username;
+<a name="l00058"></a>00058
+<a name="l00059"></a>00059         EventedMessageClientContext() {
+<a name="l00060"></a>00060                 state = MS_READING_USERNAME;
+<a name="l00061"></a>00061         }
+<a name="l00062"></a>00062
+<a name="l00063"></a>00063         ~EventedMessageClientContext() {
+<a name="l00064"></a>00064                 <span class="comment">/* Its buffer might contain password data so make sure</span>
+<a name="l00065"></a>00065 <span class="comment">                 * it&#39;s properly zeroed out. */</span>
+<a name="l00066"></a>00066                 scalarReader.reset(<span class="keyword">true</span>);
+<a name="l00067"></a>00067         }
+<a name="l00068"></a>00068 };
+<a name="l00069"></a>00069
+<a name="l00070"></a>00070 <span class="keyword">class </span>EventedMessageClient: <span class="keyword">public</span> EventedClient {
+<a name="l00071"></a>00071 <span class="keyword">public</span>:
+<a name="l00072"></a>00072         EventedMessageClientContext messageServer;
+<a name="l00073"></a>00073
+<a name="l00074"></a>00074         EventedMessageClient(<span class="keyword">struct</span> ev_loop *loop, <span class="keyword">const</span> FileDescriptor &amp;fd)
+<a name="l00075"></a>00075                 : <a class="code" href="classPassenger_1_1EventedClient.html#ac3c45bfa7ac30b6d59ef08dc296f3c4e" title="Creates a new EventedClient with the given libev loop and file descriptor.">EventedClient</a>(loop, fd)
+<a name="l00076"></a>00076         {
+<a name="l00077"></a>00077                 messageServer.authenticationTimer.set(loop);
+<a name="l00078"></a>00078         }
+<a name="l00079"></a>00079
+<a name="l00080"></a>00080         <span class="keywordtype">void</span> writeArrayMessage(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, ...) {
+<a name="l00081"></a>00081                 va_list ap;
+<a name="l00082"></a>00082                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count = 0;
+<a name="l00083"></a>00083
+<a name="l00084"></a>00084                 va_start(ap, name);
+<a name="l00085"></a>00085                 <span class="keywordflow">while</span> (va_arg(ap, <span class="keyword">const</span> <span class="keywordtype">char</span> *) != NULL) {
+<a name="l00086"></a>00086                         count++;
+<a name="l00087"></a>00087                 }
+<a name="l00088"></a>00088                 va_end(ap);
+<a name="l00089"></a>00089
+<a name="l00090"></a>00090                 StaticString args[count + 1];
+<a name="l00091"></a>00091                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 1;
+<a name="l00092"></a>00092
+<a name="l00093"></a>00093                 args[0] = name;
+<a name="l00094"></a>00094                 va_start(ap, name);
+<a name="l00095"></a>00095                 <span class="keywordflow">while</span> (<span class="keyword">true</span>) {
+<a name="l00096"></a>00096                         <span class="keyword">const</span> <span class="keywordtype">char</span> *arg = va_arg(ap, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
+<a name="l00097"></a>00097                         <span class="keywordflow">if</span> (arg != NULL) {
+<a name="l00098"></a>00098                                 args[i] = arg;
+<a name="l00099"></a>00099                                 i++;
+<a name="l00100"></a>00100                         } <span class="keywordflow">else</span> {
+<a name="l00101"></a>00101                                 <span class="keywordflow">break</span>;
+<a name="l00102"></a>00102                         }
+<a name="l00103"></a>00103                 }
+<a name="l00104"></a>00104                 va_end(ap);
+<a name="l00105"></a>00105
+<a name="l00106"></a>00106                 writeArrayMessage(args, count + 1);
+<a name="l00107"></a>00107         }
+<a name="l00108"></a>00108
+<a name="l00109"></a>00109         <span class="keywordtype">void</span> writeArrayMessage(StaticString args[], <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count) {
+<a name="l00110"></a>00110                 <span class="keywordtype">char</span> headerBuf[<span class="keyword">sizeof</span>(uint16_t)];
+<a name="l00111"></a>00111                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> outSize = ArrayMessage::outputSize(count);
+<a name="l00112"></a>00112                 StaticString out[outSize];
+<a name="l00113"></a>00113
+<a name="l00114"></a>00114                 <a class="code" href="classPassenger_1_1ArrayMessage.html#a25603619576f11f0d76286a17a014a92" title="Given a bunch of array items, generates an array message.">ArrayMessage::generate</a>(args, count, headerBuf, out, outSize);
+<a name="l00115"></a>00115                 write(out, outSize);
+<a name="l00116"></a>00116         }
+<a name="l00117"></a>00117 };
+<a name="l00118"></a>00118 <span class="comment"></span>
+<a name="l00119"></a>00119 <span class="comment">/**</span>
+<a name="l00120"></a><a class="code" href="classPassenger_1_1EventedMessageServer.html">00120</a> <span class="comment"> * Note when overriding onNewClient: call the parent method first! It does</span>
+<a name="l00121"></a>00121 <span class="comment"> * some initialization but might disconnect the client if that initialization</span>
+<a name="l00122"></a>00122 <span class="comment"> * fails. The override should check for this.</span>
+<a name="l00123"></a>00123 <span class="comment"> */</span>
+<a name="l00124"></a>00124 <span class="keyword">class </span><a class="code" href="classPassenger_1_1EventedMessageServer.html" title="Note when overriding onNewClient: call the parent method first! It does some initialization...">EventedMessageServer</a>: <span class="keyword">public</span> <a class="code" href="classPassenger_1_1EventedServer.html" title="A base class for writing single-threaded, evented servers that use non-blocking I/O...">EventedServer</a> {
+<a name="l00125"></a>00125 <span class="keyword">protected</span>:
+<a name="l00126"></a>00126         AccountsDatabasePtr accountsDatabase;
+<a name="l00127"></a>00127
+<a name="l00128"></a>00128
+<a name="l00129"></a>00129         <span class="comment">/******** Overrided hooks and methods ********/</span>
+<a name="l00130"></a>00130
+<a name="l00131"></a>00131         <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *createClient(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;fd) {
+<a name="l00132"></a>00132                 <span class="keywordflow">return</span> <span class="keyword">new</span> EventedMessageClient(getLoop(), fd);
+<a name="l00133"></a>00133         }
+<a name="l00134"></a>00134
+<a name="l00135"></a>00135         <span class="keyword">virtual</span> <span class="keywordtype">void</span> onNewClient(<a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *_client) {
+<a name="l00136"></a>00136                 EventedMessageClient *client = (EventedMessageClient *) _client;
+<a name="l00137"></a>00137                 EventedMessageClientContext *context = &amp;client-&gt;messageServer;
+<a name="l00138"></a>00138
+<a name="l00139"></a>00139                 context-&gt;authenticationTimer.set
+<a name="l00140"></a>00140                         &lt;&amp;EventedMessageServer::onAuthenticationTimeout&gt;(client);
+<a name="l00141"></a>00141                 context-&gt;authenticationTimer.start(10);
+<a name="l00142"></a>00142
+<a name="l00143"></a>00143                 context-&gt;arrayReader.reserve(5);
+<a name="l00144"></a>00144                 context-&gt;scalarReader.setMaxSize(MESSAGE_SERVER_MAX_USERNAME_SIZE);
+<a name="l00145"></a>00145
+<a name="l00146"></a>00146                 client-&gt;writeArrayMessage(<span class="stringliteral">&quot;version&quot;</span>, protocolVersion(), NULL);
+<a name="l00147"></a>00147         }
+<a name="l00148"></a>00148
+<a name="l00149"></a>00149         <span class="keyword">virtual</span> <span class="keywordtype">void</span> onClientReadable(<a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *_client) {
+<a name="l00150"></a>00150                 EventedMessageClient *client = (EventedMessageClient *) _client;
+<a name="l00151"></a>00151                 this_thread::disable_syscall_interruption dsi;
+<a name="l00152"></a>00152                 <span class="keywordtype">int</span> i = 0;
+<a name="l00153"></a>00153                 <span class="keywordtype">bool</span> done = <span class="keyword">false</span>;
+<a name="l00154"></a>00154
+<a name="l00155"></a>00155                 <span class="comment">// read() from the client at most 10 times on every read readiness event</span>
+<a name="l00156"></a>00156                 <span class="comment">// in order to give other events the chance to be processed.</span>
+<a name="l00157"></a>00157                 <span class="keywordflow">while</span> (i &lt; 10 &amp;&amp; !done) {
+<a name="l00158"></a>00158                         <span class="keywordtype">char</span> buf[1024 * 8];
+<a name="l00159"></a>00159                         ssize_t ret;
+<a name="l00160"></a>00160
+<a name="l00161"></a>00161                         ret = syscalls::read(client-&gt;fd, buf, <span class="keyword">sizeof</span>(buf));
+<a name="l00162"></a>00162                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00163"></a>00163                                 <span class="keywordflow">if</span> (errno != EAGAIN) {
+<a name="l00164"></a>00164                                         <span class="keywordtype">int</span> e = errno;
+<a name="l00165"></a>00165                                         client-&gt;disconnect(<span class="keyword">true</span>);
+<a name="l00166"></a>00166                                         logSystemError(client, <span class="stringliteral">&quot;Cannot read data from client&quot;</span>, e);
+<a name="l00167"></a>00167                                 }
+<a name="l00168"></a>00168                                 done = <span class="keyword">true</span>;
+<a name="l00169"></a>00169                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
+<a name="l00170"></a>00170                                 done = <span class="keyword">true</span>;
+<a name="l00171"></a>00171                                 ScopeGuard guard(boost::bind(&amp;<a class="code" href="classPassenger_1_1EventedClient.html#a5b1a3011165ea9a47f6fe668a5010a20" title="Disconnects the client.">EventedClient::disconnect</a>,
+<a name="l00172"></a>00172                                         client, <span class="keyword">false</span>));
+<a name="l00173"></a>00173                                 onEndOfStream(client);
+<a name="l00174"></a>00174                         } <span class="keywordflow">else</span> {
+<a name="l00175"></a>00175                                 onDataReceived(client, buf, ret);
+<a name="l00176"></a>00176                         }
+<a name="l00177"></a>00177                         i++;
+<a name="l00178"></a>00178                         done = done || !client-&gt;ioAllowed();
+<a name="l00179"></a>00179                 }
+<a name="l00180"></a>00180         }
+<a name="l00181"></a>00181
+<a name="l00182"></a>00182
+<a name="l00183"></a>00183         <span class="comment">/******** New EventedMessageServer overridable hooks and API methods ********/</span>
+<a name="l00184"></a>00184
+<a name="l00185"></a>00185         <span class="keyword">virtual</span> <span class="keywordtype">void</span> onClientAuthenticated(EventedMessageClient *client) {
+<a name="l00186"></a>00186                 <span class="comment">// Do nothing.</span>
+<a name="l00187"></a>00187         }
+<a name="l00188"></a>00188
+<a name="l00189"></a>00189         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> onMessageReceived(EventedMessageClient *client, <span class="keyword">const</span> vector&lt;StaticString&gt; &amp;args) {
+<a name="l00190"></a>00190                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00191"></a>00191         }
+<a name="l00192"></a>00192
+<a name="l00193"></a>00193         <span class="keyword">virtual</span> <span class="keywordtype">void</span> onEndOfStream(EventedMessageClient *client) {
+<a name="l00194"></a>00194                 <span class="comment">// Do nothing.</span>
+<a name="l00195"></a>00195         }
+<a name="l00196"></a>00196
+<a name="l00197"></a>00197         <span class="keyword">virtual</span> pair&lt;size_t, bool&gt; onOtherDataReceived(EventedMessageClient *client,
+<a name="l00198"></a>00198                 <span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size)
+<a name="l00199"></a>00199         {
+<a name="l00200"></a>00200                 abort();
+<a name="l00201"></a>00201         }
+<a name="l00202"></a>00202
+<a name="l00203"></a>00203         <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *protocolVersion()<span class="keyword"> const </span>{
+<a name="l00204"></a>00204                 <span class="keywordflow">return</span> <span class="stringliteral">&quot;1&quot;</span>;
+<a name="l00205"></a>00205         }
+<a name="l00206"></a>00206
+<a name="l00207"></a>00207         <span class="keywordtype">void</span> discardReadData() {
+<a name="l00208"></a>00208                 readDataDiscarded = <span class="keyword">true</span>;
+<a name="l00209"></a>00209         }
+<a name="l00210"></a>00210
+<a name="l00211"></a>00211 <span class="keyword">private</span>:
+<a name="l00212"></a>00212         <span class="keywordtype">bool</span> readDataDiscarded;
+<a name="l00213"></a>00213
+<a name="l00214"></a>00214         <span class="keyword">static</span> <span class="keywordtype">void</span> onAuthenticationTimeout(ev::timer &amp;t, <span class="keywordtype">int</span> revents) {
+<a name="l00215"></a>00215                 EventedMessageClient *client = (EventedMessageClient *) t.data;
+<a name="l00216"></a>00216                 client-&gt;disconnect();
+<a name="l00217"></a>00217         }
+<a name="l00218"></a>00218
+<a name="l00219"></a>00219         <span class="keywordtype">void</span> onDataReceived(EventedMessageClient *client, <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size) {
+<a name="l00220"></a>00220                 EventedMessageClientContext *context = &amp;client-&gt;messageServer;
+<a name="l00221"></a>00221                 <span class="keywordtype">size_t</span> consumed = 0;
+<a name="l00222"></a>00222
+<a name="l00223"></a>00223                 readDataDiscarded = <span class="keyword">false</span>;
+<a name="l00224"></a>00224                 <span class="keywordflow">while</span> (consumed &lt; size &amp;&amp; client-&gt;ioAllowed() &amp;&amp; !readDataDiscarded) {
+<a name="l00225"></a>00225                         <span class="keywordtype">char</span> *current = data + consumed;
+<a name="l00226"></a>00226                         <span class="keywordtype">size_t</span> rest = size - consumed;
+<a name="l00227"></a>00227
+<a name="l00228"></a>00228                         <span class="keywordflow">switch</span> (context-&gt;state) {
+<a name="l00229"></a>00229                         <span class="keywordflow">case</span> EventedMessageClientContext::MS_READING_USERNAME:
+<a name="l00230"></a>00230                                 consumed += context-&gt;scalarReader.feed(current, rest);
+<a name="l00231"></a>00231                                 <span class="keywordflow">if</span> (context-&gt;scalarReader.hasError()) {
+<a name="l00232"></a>00232                                         client-&gt;writeArrayMessage(
+<a name="l00233"></a>00233                                                 <span class="stringliteral">&quot;The supplied username is too long.&quot;</span>,
+<a name="l00234"></a>00234                                                 NULL);
+<a name="l00235"></a>00235                                         client-&gt;disconnect();
+<a name="l00236"></a>00236                                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (context-&gt;scalarReader.done()) {
+<a name="l00237"></a>00237                                         context-&gt;username = context-&gt;scalarReader.value();
+<a name="l00238"></a>00238                                         context-&gt;scalarReader.reset();
+<a name="l00239"></a>00239                                         context-&gt;scalarReader.setMaxSize(MESSAGE_SERVER_MAX_PASSWORD_SIZE);
+<a name="l00240"></a>00240                                         context-&gt;state = EventedMessageClientContext::MS_READING_PASSWORD;
+<a name="l00241"></a>00241                                 }
+<a name="l00242"></a>00242                                 <span class="keywordflow">break</span>;
+<a name="l00243"></a>00243
+<a name="l00244"></a>00244                         <span class="keywordflow">case</span> EventedMessageClientContext::MS_READING_PASSWORD: {
+<a name="l00245"></a>00245                                 <span class="keywordtype">size_t</span> locallyConsumed;
+<a name="l00246"></a>00246
+<a name="l00247"></a>00247                                 locallyConsumed = context-&gt;scalarReader.feed(current, rest);
+<a name="l00248"></a>00248                                 consumed += locallyConsumed;
+<a name="l00249"></a>00249
+<a name="l00250"></a>00250                                 <span class="comment">// The buffer contains password data so make sure we zero</span>
+<a name="l00251"></a>00251                                 <span class="comment">// it out when we&#39;re done.</span>
+<a name="l00252"></a>00252                                 MemZeroGuard passwordGuard(current, locallyConsumed);
+<a name="l00253"></a>00253
+<a name="l00254"></a>00254                                 <span class="keywordflow">if</span> (context-&gt;scalarReader.hasError()) {
+<a name="l00255"></a>00255                                         context-&gt;scalarReader.reset(<span class="keyword">true</span>);
+<a name="l00256"></a>00256                                         client-&gt;writeArrayMessage(
+<a name="l00257"></a>00257                                                 <span class="stringliteral">&quot;The supplied password is too long.&quot;</span>,
+<a name="l00258"></a>00258                                                 NULL);
+<a name="l00259"></a>00259                                         client-&gt;disconnect();
+<a name="l00260"></a>00260                                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (context-&gt;scalarReader.done()) {
+<a name="l00261"></a>00261                                         context-&gt;authenticationTimer.stop();
+<a name="l00262"></a>00262                                         context-&gt;account = accountsDatabase-&gt;authenticate(
+<a name="l00263"></a>00263                                                 context-&gt;username, context-&gt;scalarReader.value());
+<a name="l00264"></a>00264                                         passwordGuard.zeroNow();
+<a name="l00265"></a>00265                                         context-&gt;username.clear();
+<a name="l00266"></a>00266                                         <span class="keywordflow">if</span> (context-&gt;account) {
+<a name="l00267"></a>00267                                                 context-&gt;scalarReader.reset(<span class="keyword">true</span>);
+<a name="l00268"></a>00268                                                 context-&gt;state = EventedMessageClientContext::MS_READING_MESSAGE;
+<a name="l00269"></a>00269                                                 client-&gt;writeArrayMessage(<span class="stringliteral">&quot;ok&quot;</span>, NULL);
+<a name="l00270"></a>00270                                                 onClientAuthenticated(client);
+<a name="l00271"></a>00271                                         } <span class="keywordflow">else</span> {
+<a name="l00272"></a>00272                                                 context-&gt;scalarReader.reset(<span class="keyword">true</span>);
+<a name="l00273"></a>00273                                                 client-&gt;writeArrayMessage(
+<a name="l00274"></a>00274                                                         <span class="stringliteral">&quot;Invalid username or password.&quot;</span>,
+<a name="l00275"></a>00275                                                         NULL);
+<a name="l00276"></a>00276                                                 client-&gt;disconnect();
+<a name="l00277"></a>00277                                         }
+<a name="l00278"></a>00278                                 }
+<a name="l00279"></a>00279                                 <span class="keywordflow">break</span>;
+<a name="l00280"></a>00280                         }
+<a name="l00281"></a>00281
+<a name="l00282"></a>00282                         <span class="keywordflow">case</span> EventedMessageClientContext::MS_READING_MESSAGE:
+<a name="l00283"></a>00283                                 consumed += context-&gt;arrayReader.feed(current, rest);
+<a name="l00284"></a>00284                                 <span class="keywordflow">if</span> (context-&gt;arrayReader.hasError()) {
+<a name="l00285"></a>00285                                         client-&gt;disconnect();
+<a name="l00286"></a>00286                                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (context-&gt;arrayReader.done()) {
+<a name="l00287"></a>00287                                         context-&gt;state = EventedMessageClientContext::MS_PROCESSING_MESSAGE;
+<a name="l00288"></a>00288                                         <span class="keywordflow">if</span> (context-&gt;arrayReader.value().empty()) {
+<a name="l00289"></a>00289                                                 logError(client, <span class="stringliteral">&quot;Client sent an empty message.&quot;</span>);
+<a name="l00290"></a>00290                                                 client-&gt;disconnect();
+<a name="l00291"></a>00291                                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (onMessageReceived(client, context-&gt;arrayReader.value())
+<a name="l00292"></a>00292                                            &amp;&amp; context-&gt;state == EventedMessageClientContext::MS_PROCESSING_MESSAGE) {
+<a name="l00293"></a>00293                                                 context-&gt;state = EventedMessageClientContext::MS_READING_MESSAGE;
+<a name="l00294"></a>00294                                         }
+<a name="l00295"></a>00295                                         context-&gt;arrayReader.reset();
+<a name="l00296"></a>00296                                 }
+<a name="l00297"></a>00297                                 <span class="keywordflow">break</span>;
+<a name="l00298"></a>00298
+<a name="l00299"></a>00299                         <span class="keywordflow">case</span> EventedMessageClientContext::MS_PROCESSING_MESSAGE: {
+<a name="l00300"></a>00300                                 pair&lt;size_t, bool&gt; ret = onOtherDataReceived(client, current, rest);
+<a name="l00301"></a>00301                                 consumed += ret.first;
+<a name="l00302"></a>00302                                 <span class="keywordflow">if</span> (ret.second &amp;&amp; context-&gt;state == EventedMessageClientContext::MS_PROCESSING_MESSAGE) {
+<a name="l00303"></a>00303                                         context-&gt;state = EventedMessageClientContext::MS_READING_MESSAGE;
+<a name="l00304"></a>00304                                 }
+<a name="l00305"></a>00305                                 <span class="keywordflow">break</span>;
+<a name="l00306"></a>00306                         }
+<a name="l00307"></a>00307
+<a name="l00308"></a>00308                         <span class="keywordflow">default</span>:
+<a name="l00309"></a>00309                                 <span class="comment">// Never reached.</span>
+<a name="l00310"></a>00310                                 abort();
+<a name="l00311"></a>00311                         }
+<a name="l00312"></a>00312                 }
+<a name="l00313"></a>00313         }
+<a name="l00314"></a>00314
+<a name="l00315"></a>00315 <span class="keyword">public</span>:
+<a name="l00316"></a>00316         <a class="code" href="classPassenger_1_1EventedMessageServer.html" title="Note when overriding onNewClient: call the parent method first! It does some initialization...">EventedMessageServer</a>(<span class="keyword">struct</span> ev_loop *loop, <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> fd,
+<a name="l00317"></a>00317                 <span class="keyword">const</span> AccountsDatabasePtr &amp;accountsDatabase)
+<a name="l00318"></a>00318                 : <a class="code" href="classPassenger_1_1EventedServer.html" title="A base class for writing single-threaded, evented servers that use non-blocking I/O...">EventedServer</a>(loop, fd)
+<a name="l00319"></a>00319         {
+<a name="l00320"></a>00320                 this-&gt;accountsDatabase = accountsDatabase;
+<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">// namespace Passenger</span>
+<a name="l00326"></a>00326
+<a name="l00327"></a>00327 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_EVENTED_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">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>

data/doc/cxxapi/EventedServer_8h_source.html ADDED

@@ -0,0 +1,326 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Passenger: EventedServer.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>EventedServer.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00006"></a>00006 <span class="comment"> *</span>
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_EVENTED_SERVER_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_EVENTED_SERVER_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;ev++.h&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;boost/enable_shared_from_this.hpp&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;oxt/system_calls.hpp&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;oxt/macros.hpp&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;algorithm&gt;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;set&gt;</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;sys/un.h&gt;</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include &lt;sys/uio.h&gt;</span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;netinet/in.h&gt;</span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;cerrno&gt;</span>
+<a name="l00042"></a>00042 <span class="preprocessor">#include &quot;EventedClient.h&quot;</span>
+<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;FileDescriptor.h&quot;</span>
+<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
+<a name="l00045"></a>00045 <span class="preprocessor">#include &quot;Logging.h&quot;</span>
+<a name="l00046"></a>00046 <span class="preprocessor">#include &quot;Utils/ScopeGuard.h&quot;</span>
+<a name="l00047"></a>00047 <span class="preprocessor">#include &quot;Utils/StrIntUtils.h&quot;</span>
+<a name="l00048"></a>00048
+<a name="l00049"></a>00049 <span class="keyword">namespace </span>Passenger {
+<a name="l00050"></a>00050
+<a name="l00051"></a>00051 <span class="keyword">using namespace </span>std;
+<a name="l00052"></a>00052 <span class="keyword">using namespace </span>boost;
+<a name="l00053"></a>00053 <span class="keyword">using namespace </span>oxt;
+<a name="l00054"></a>00054
+<a name="l00055"></a>00055 <span class="comment"></span>
+<a name="l00056"></a>00056 <span class="comment">/**</span>
+<a name="l00057"></a>00057 <span class="comment"> * A base class for writing single-threaded, evented servers that use non-blocking I/O.</span>
+<a name="l00058"></a>00058 <span class="comment"> * It uses libev for its event loop. EventedServer handles much of the situps regarding</span>
+<a name="l00059"></a>00059 <span class="comment"> * client connection management and output buffering and tries to make it easy to</span>
+<a name="l00060"></a>00060 <span class="comment"> * implement a zero-copy architecture.</span>
+<a name="l00061"></a>00061 <span class="comment"> *</span>
+<a name="l00062"></a>00062 <span class="comment"> * &lt;h2&gt;Basic usage&lt;/h2&gt;</span>
+<a name="l00063"></a>00063 <span class="comment"> * Derived classes can override the onClientReadable() method, which is called every time</span>
+<a name="l00064"></a>00064 <span class="comment"> * a specific client becomes readable. It is passed a Client object which contains information</span>
+<a name="l00065"></a>00065 <span class="comment"> * about the client, such as its file descriptor. One can use the read() system call in</span>
+<a name="l00066"></a>00066 <span class="comment"> * that method to receive data from the client. Please note that client file descriptors</span>
+<a name="l00067"></a>00067 <span class="comment"> * are always set to non-blocking mode so you need to handle this gracefully.</span>
+<a name="l00068"></a>00068 <span class="comment"> *</span>
+<a name="l00069"></a>00069 <span class="comment"> * EventedServer provides the write() method for sending data to the client. This method</span>
+<a name="l00070"></a>00070 <span class="comment"> * will attempt to send the data to the client immediately; if it fails with EAGAIN then</span>
+<a name="l00071"></a>00071 <span class="comment"> * EventedServer will take care of scheduling the send at a later time when the client</span>
+<a name="l00072"></a>00072 <span class="comment"> * is ready again to receive data.</span>
+<a name="l00073"></a>00073 <span class="comment"> *</span>
+<a name="l00074"></a>00074 <span class="comment"> * To disconnect the client, call disconnect(). The connection might not be actually</span>
+<a name="l00075"></a>00075 <span class="comment"> * closed until all pending outgoing data have been sent out, but all the gory details</span>
+<a name="l00076"></a>00076 <span class="comment"> * is taken care of for you.</span>
+<a name="l00077"></a>00077 <span class="comment"> *</span>
+<a name="l00078"></a>00078 <span class="comment"> * &lt;h2&gt;Keeping per-client information&lt;/h2&gt;</span>
+<a name="l00079"></a>00079 <span class="comment"> * If you need to keep per-client information then you can override the createClient()</span>
+<a name="l00080"></a>00080 <span class="comment"> * method and make it return an object that&#39;s a subclass of EventedServer::Client. This</span>
+<a name="l00081"></a>00081 <span class="comment"> * object is passed to onClientReadable(), so in there you can just cast the client object</span>
+<a name="l00082"></a>00082 <span class="comment"> * to your subclass.</span>
+<a name="l00083"></a>00083 <span class="comment"> *</span>
+<a name="l00084"></a>00084 <span class="comment"> * &lt;h2&gt;Client object life times&lt;/h2&gt;</span>
+<a name="l00085"></a>00085 <span class="comment"> * All client objects are destroyed along with the EventedServer. Disconnecting</span>
+<a name="l00086"></a>00086 <span class="comment"> * a client also causes it to be destroyed after the current event handler has</span>
+<a name="l00087"></a>00087 <span class="comment"> * run or a short period of time after that.</span>
+<a name="l00088"></a>00088 <span class="comment"> */</span>
+<a name="l00089"></a><a class="code" href="classPassenger_1_1EventedServer.html">00089</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1EventedServer.html" title="A base class for writing single-threaded, evented servers that use non-blocking I/O...">EventedServer</a> {
+<a name="l00090"></a>00090 <span class="keyword">protected</span>:
+<a name="l00091"></a>00091         <span class="keyword">typedef</span> set&lt;EventedClient *&gt; ClientSet;
+<a name="l00092"></a>00092
+<a name="l00093"></a>00093         <span class="keyword">const</span> ClientSet &amp;getClients()<span class="keyword"> const </span>{
+<a name="l00094"></a>00094                 <span class="keywordflow">return</span> clients;
+<a name="l00095"></a>00095         }
+<a name="l00096"></a>00096
+<a name="l00097"></a>00097         <span class="keywordtype">string</span> getClientName(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *client)<span class="keyword"> const </span>{
+<a name="l00098"></a>00098                 <span class="keywordflow">return</span> toString(client);
+<a name="l00099"></a>00099         }
+<a name="l00100"></a>00100
+<a name="l00101"></a>00101         <span class="keywordtype">void</span> logError(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *client, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;message) {
+<a name="l00102"></a>00102                 P_ERROR(<span class="stringliteral">&quot;Error in client &quot;</span> &lt;&lt; getClientName(client) &lt;&lt; <span class="stringliteral">&quot;: &quot;</span> &lt;&lt; message);
+<a name="l00103"></a>00103         }
+<a name="l00104"></a>00104
+<a name="l00105"></a>00105         <span class="keywordtype">void</span> logSystemError(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *client, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;message, <span class="keywordtype">int</span> errorCode) {
+<a name="l00106"></a>00106                 P_ERROR(<span class="stringliteral">&quot;Error in client &quot;</span> &lt;&lt; getClientName(client) &lt;&lt; <span class="stringliteral">&quot;: &quot;</span> &lt;&lt;
+<a name="l00107"></a>00107                         message &lt;&lt; <span class="stringliteral">&quot;: &quot;</span> &lt;&lt; strerror(errorCode) &lt;&lt; <span class="stringliteral">&quot; (&quot;</span> &lt;&lt; errorCode &lt;&lt; <span class="stringliteral">&quot;)&quot;</span>);
+<a name="l00108"></a>00108         }
+<a name="l00109"></a>00109
+<a name="l00110"></a>00110         <span class="keywordtype">void</span> logSystemError(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;message, <span class="keywordtype">int</span> errorCode) {
+<a name="l00111"></a>00111                 P_ERROR(message &lt;&lt; <span class="stringliteral">&quot;: &quot;</span> &lt;&lt; strerror(errorCode) &lt;&lt; <span class="stringliteral">&quot; (&quot;</span> &lt;&lt; errorCode &lt;&lt; <span class="stringliteral">&quot;)&quot;</span>);
+<a name="l00112"></a>00112         }
+<a name="l00113"></a>00113
+<a name="l00114"></a>00114         <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *createClient(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &amp;fd) {
+<a name="l00115"></a>00115                 <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a>(loop, fd);
+<a name="l00116"></a>00116         }
+<a name="l00117"></a>00117
+<a name="l00118"></a>00118         <span class="keyword">virtual</span> <span class="keywordtype">void</span> onNewClient(<a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *client) { }
+<a name="l00119"></a>00119         <span class="keyword">virtual</span> <span class="keywordtype">void</span> onClientReadable(<a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *client) { }
+<a name="l00120"></a>00120         <span class="comment"></span>
+<a name="l00121"></a>00121 <span class="comment">        /**</span>
+<a name="l00122"></a>00122 <span class="comment">         * Called when a client has been disconnected. This may either be triggered</span>
+<a name="l00123"></a>00123 <span class="comment">         * immediately by disconnect() or triggered after pending data has been sent</span>
+<a name="l00124"></a>00124 <span class="comment">         * out. This means that if you call disconnect() from onClientReadable() you</span>
+<a name="l00125"></a>00125 <span class="comment">         * need take care of the possibility that control returns to onClientReadable()</span>
+<a name="l00126"></a>00126 <span class="comment">         * after this method is done.</span>
+<a name="l00127"></a>00127 <span class="comment">         *</span>
+<a name="l00128"></a>00128 <span class="comment">         * Please note that when EventedServer is being destroyed,</span>
+<a name="l00129"></a>00129 <span class="comment">         * onClientDisconnected() is *not* triggered.</span>
+<a name="l00130"></a>00130 <span class="comment">         */</span>
+<a name="l00131"></a><a class="code" href="classPassenger_1_1EventedServer.html#a7db4c8d0ad8aa77bcb40344e53319f11">00131</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1EventedServer.html#a7db4c8d0ad8aa77bcb40344e53319f11" title="Called when a client has been disconnected.">onClientDisconnected</a>(<a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *client) { }
+<a name="l00132"></a>00132
+<a name="l00133"></a>00133 <span class="keyword">private</span>:
+<a name="l00134"></a>00134         <span class="keyword">struct </span>ev_loop *loop;
+<a name="l00135"></a>00135         <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> fd;
+<a name="l00136"></a>00136         ev::io acceptWatcher;
+<a name="l00137"></a>00137         ClientSet clients;
+<a name="l00138"></a>00138
+<a name="l00139"></a>00139         <span class="keywordtype">void</span> removeClient(<a class="code" href="classPassenger_1_1EventedClient.html" title="A utility class for making I/O handling in non-blocking libev evented servers much...">EventedClient</a> *client) {
+<a name="l00140"></a>00140                 clients.erase(client);
+<a name="l00141"></a>00141         }
+<a name="l00142"></a>00142
+<a name="l00143"></a>00143         <span class="keywordtype">void</span> freeAllClients() {
+<a name="l00144"></a>00144                 ClientSet::iterator it;
+<a name="l00145"></a>00145                 ClientSet::iterator end = clients.end();
+<a name="l00146"></a>00146
+<a name="l00147"></a>00147                 <span class="keywordflow">for</span> (it = clients.begin(); it != clients.end(); it++) {
+<a name="l00148"></a>00148                         (*it)-&gt;unref();
+<a name="l00149"></a>00149                 }
+<a name="l00150"></a>00150                 clients.clear();
+<a name="l00151"></a>00151         }
+<a name="l00152"></a>00152
+<a name="l00153"></a>00153         <span class="keyword">static</span> <span class="keywordtype">void</span> _onReadable(EventedClient *client) {
+<a name="l00154"></a>00154                 EventedServer *server = (EventedServer *) client-&gt;userData;
+<a name="l00155"></a>00155                 client-&gt;ref();
+<a name="l00156"></a>00156                 ScopeGuard guard(boost::bind(&amp;<a class="code" href="classPassenger_1_1EventedClient.html#a1e480f15dfd339ff781f8daedc5b8190" title="Decrease reference count.">EventedClient::unref</a>, client));
+<a name="l00157"></a>00157                 server-&gt;onClientReadable((EventedClient *) client);
+<a name="l00158"></a>00158         }
+<a name="l00159"></a>00159
+<a name="l00160"></a>00160         <span class="keyword">static</span> <span class="keywordtype">void</span> _onDisconnect(EventedClient *client) {
+<a name="l00161"></a>00161                 EventedServer *server = (EventedServer *) client-&gt;userData;
+<a name="l00162"></a>00162                 ScopeGuard guard1(boost::bind(&amp;<a class="code" href="classPassenger_1_1EventedClient.html#a1e480f15dfd339ff781f8daedc5b8190" title="Decrease reference count.">EventedClient::unref</a>, client));
+<a name="l00163"></a>00163
+<a name="l00164"></a>00164                 client-&gt;ref();
+<a name="l00165"></a>00165                 ScopeGuard guard2(boost::bind(&amp;<a class="code" href="classPassenger_1_1EventedClient.html#a1e480f15dfd339ff781f8daedc5b8190" title="Decrease reference count.">EventedClient::unref</a>, client));
+<a name="l00166"></a>00166
+<a name="l00167"></a>00167                 server-&gt;removeClient(client);
+<a name="l00168"></a>00168                 server-&gt;onClientDisconnected((EventedClient *) client);
+<a name="l00169"></a>00169         }
+<a name="l00170"></a>00170
+<a name="l00171"></a>00171         <span class="keyword">static</span> <span class="keywordtype">void</span> _onDetach(EventedClient *client) {
+<a name="l00172"></a>00172                 EventedServer *server = (EventedServer *) client-&gt;userData;
+<a name="l00173"></a>00173                 ScopeGuard guard1(boost::bind(&amp;<a class="code" href="classPassenger_1_1EventedClient.html#a1e480f15dfd339ff781f8daedc5b8190" title="Decrease reference count.">EventedClient::unref</a>, client));
+<a name="l00174"></a>00174
+<a name="l00175"></a>00175                 client-&gt;ref();
+<a name="l00176"></a>00176                 ScopeGuard guard2(boost::bind(&amp;<a class="code" href="classPassenger_1_1EventedClient.html#a1e480f15dfd339ff781f8daedc5b8190" title="Decrease reference count.">EventedClient::unref</a>, client));
+<a name="l00177"></a>00177
+<a name="l00178"></a>00178                 server-&gt;removeClient(client);
+<a name="l00179"></a>00179         }
+<a name="l00180"></a>00180
+<a name="l00181"></a>00181         <span class="keyword">static</span> <span class="keywordtype">void</span> _onSystemError(EventedClient *client, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;message, <span class="keywordtype">int</span> code) {
+<a name="l00182"></a>00182                 EventedServer *server = (EventedServer *) client-&gt;userData;
+<a name="l00183"></a>00183                 server-&gt;logSystemError(client, message, code);
+<a name="l00184"></a>00184         }
+<a name="l00185"></a>00185
+<a name="l00186"></a>00186         <span class="keywordtype">void</span> exceptionThrownWhileInitializingClient(EventedClient *client, ClientSet::iterator it) {
+<a name="l00187"></a>00187                 <span class="keywordflow">if</span> (!client-&gt;ioAllowed()) {
+<a name="l00188"></a>00188                         <span class="comment">// onNewClient() disconnected or detached the</span>
+<a name="l00189"></a>00189                         <span class="comment">// client, so client refcount == 1</span>
+<a name="l00190"></a>00190                         client-&gt;unref();
+<a name="l00191"></a>00191                 } <span class="keywordflow">else</span> {
+<a name="l00192"></a>00192                         <span class="comment">// client refcount == 2</span>
+<a name="l00193"></a>00193                         client-&gt;unref();
+<a name="l00194"></a>00194                         client-&gt;unref();
+<a name="l00195"></a>00195                         clients.erase(it);
+<a name="l00196"></a>00196                 }
+<a name="l00197"></a>00197                 <span class="comment">// Now client refcount == 0</span>
+<a name="l00198"></a>00198         }
+<a name="l00199"></a>00199
+<a name="l00200"></a>00200         <span class="keywordtype">void</span> onAcceptable(ev::io &amp;w, <span class="keywordtype">int</span> revents) {
+<a name="l00201"></a>00201                 this_thread::disable_syscall_interruption dsi;
+<a name="l00202"></a>00202                 <span class="keywordtype">int</span> i = 0;
+<a name="l00203"></a>00203                 <span class="keywordtype">bool</span> done = <span class="keyword">false</span>;
+<a name="l00204"></a>00204
+<a name="l00205"></a>00205                 <span class="comment">// Accept at most 10 connections on every accept readiness event</span>
+<a name="l00206"></a>00206                 <span class="comment">// in order to give other events the chance to be processed.</span>
+<a name="l00207"></a>00207                 <span class="keywordflow">while</span> (i &lt; 10 &amp;&amp; !done) {
+<a name="l00208"></a>00208                         <span class="comment">// Reserve enough space to hold both a Unix domain socket</span>
+<a name="l00209"></a>00209                         <span class="comment">// address and an IP socket address.</span>
+<a name="l00210"></a>00210                         <span class="keyword">union </span>{
+<a name="l00211"></a>00211                                 <span class="keyword">struct </span>sockaddr_un local;
+<a name="l00212"></a>00212                                 <span class="keyword">struct </span>sockaddr_in inet;
+<a name="l00213"></a>00213                         } addr;
+<a name="l00214"></a>00214                         socklen_t len = <span class="keyword">sizeof</span>(addr);
+<a name="l00215"></a>00215
+<a name="l00216"></a>00216                         <span class="keywordtype">int</span> clientfd = syscalls::accept(fd, (<span class="keyword">struct</span> sockaddr *) &amp;addr, &amp;len);
+<a name="l00217"></a>00217                         <span class="keywordflow">if</span> (clientfd == -1) {
+<a name="l00218"></a>00218                                 <span class="keywordflow">if</span> (errno != EAGAIN &amp;&amp; errno != EWOULDBLOCK) {
+<a name="l00219"></a>00219                                         <span class="keywordtype">int</span> e = errno;
+<a name="l00220"></a>00220                                         logSystemError(<span class="stringliteral">&quot;Cannot accept new client&quot;</span>, e);
+<a name="l00221"></a>00221                                 }
+<a name="l00222"></a>00222                                 done = <span class="keyword">true</span>;
+<a name="l00223"></a>00223                         } <span class="keywordflow">else</span> {
+<a name="l00224"></a>00224                                 FileDescriptor clientfdGuard = clientfd;
+<a name="l00225"></a>00225                                 <span class="keywordtype">int</span> optval = 1;
+<a name="l00226"></a>00226
+<a name="l00227"></a>00227                                 setNonBlocking(clientfdGuard);
+<a name="l00228"></a>00228                                 syscalls::setsockopt(clientfd, SOL_SOCKET, SO_KEEPALIVE,
+<a name="l00229"></a>00229                                         &amp;optval, <span class="keyword">sizeof</span>(optval));
+<a name="l00230"></a>00230
+<a name="l00231"></a>00231                                 EventedClient *client = createClient(clientfdGuard);
+<a name="l00232"></a>00232                                 client-&gt;onReadable    = _onReadable;
+<a name="l00233"></a>00233                                 client-&gt;onDisconnect  = _onDisconnect;
+<a name="l00234"></a>00234                                 client-&gt;onDetach      = _onDetach;
+<a name="l00235"></a>00235                                 client-&gt;onSystemError = _onSystemError;
+<a name="l00236"></a>00236                                 client-&gt;userData      = <span class="keyword">this</span>;
+<a name="l00237"></a>00237                                 client-&gt;notifyReads(<span class="keyword">true</span>);
+<a name="l00238"></a>00238
+<a name="l00239"></a>00239                                 pair&lt;ClientSet::iterator, bool&gt; p = clients.insert(client);
+<a name="l00240"></a>00240
+<a name="l00241"></a>00241                                 client-&gt;ref();
+<a name="l00242"></a>00242                                 <span class="comment">// client refcount == 2</span>
+<a name="l00243"></a>00243                                 {
+<a name="l00244"></a>00244                                         ScopeGuard g(boost::bind(
+<a name="l00245"></a>00245                                                 &amp;EventedServer::exceptionThrownWhileInitializingClient,
+<a name="l00246"></a>00246                                                 <span class="keyword">this</span>,
+<a name="l00247"></a>00247                                                 client,
+<a name="l00248"></a>00248                                                 p.first));
+<a name="l00249"></a>00249                                         onNewClient(client);
+<a name="l00250"></a>00250                                         g.clear();
+<a name="l00251"></a>00251                                         <span class="comment">// If exception occurred: client refcount == 0</span>
+<a name="l00252"></a>00252                                 }
+<a name="l00253"></a>00253
+<a name="l00254"></a>00254                                 <span class="comment">/* No exception occured.</span>
+<a name="l00255"></a>00255 <span class="comment">                                 * If onNewClient() disconnected or detached the client:</span>
+<a name="l00256"></a>00256 <span class="comment">                                 *     client refcount == 1</span>
+<a name="l00257"></a>00257 <span class="comment">                                 *     We want the refcount to become 0.</span>
+<a name="l00258"></a>00258 <span class="comment">                                 * If not:</span>
+<a name="l00259"></a>00259 <span class="comment">                                 *     client refcount == 2</span>
+<a name="l00260"></a>00260 <span class="comment">                                 *     We want the refcount to become 1.</span>
+<a name="l00261"></a>00261 <span class="comment">                                 */</span>
+<a name="l00262"></a>00262                                 client-&gt;unref();
+<a name="l00263"></a>00263                         }
+<a name="l00264"></a>00264                         i++;
+<a name="l00265"></a>00265                 }
+<a name="l00266"></a>00266         }
+<a name="l00267"></a>00267
+<a name="l00268"></a>00268 <span class="keyword">public</span>:
+<a name="l00269"></a>00269         EventedServer(<span class="keyword">struct</span> ev_loop *_loop, FileDescriptor serverFd)
+<a name="l00270"></a>00270                 : loop(_loop),
+<a name="l00271"></a>00271                   acceptWatcher(_loop)
+<a name="l00272"></a>00272         {
+<a name="l00273"></a>00273                 fd = serverFd;
+<a name="l00274"></a>00274                 setNonBlocking(serverFd);
+<a name="l00275"></a>00275                 acceptWatcher.set&lt;EventedServer, &amp;EventedServer::onAcceptable&gt;(<span class="keyword">this</span>);
+<a name="l00276"></a>00276                 acceptWatcher.start(fd, ev::READ);
+<a name="l00277"></a>00277         }
+<a name="l00278"></a>00278
+<a name="l00279"></a>00279         <span class="keyword">virtual</span> ~EventedServer() {
+<a name="l00280"></a>00280                 freeAllClients();
+<a name="l00281"></a>00281         }
+<a name="l00282"></a>00282
+<a name="l00283"></a>00283         <span class="keyword">struct </span>ev_loop *getLoop()<span class="keyword"> const </span>{
+<a name="l00284"></a>00284                 <span class="keywordflow">return</span> loop;
+<a name="l00285"></a>00285         }
+<a name="l00286"></a>00286
+<a name="l00287"></a>00287         FileDescriptor getServerFd()<span class="keyword"> const </span>{
+<a name="l00288"></a>00288                 <span class="keywordflow">return</span> fd;
+<a name="l00289"></a>00289         }
+<a name="l00290"></a>00290 };
+<a name="l00291"></a>00291
+<a name="l00292"></a>00292
+<a name="l00293"></a>00293 } <span class="comment">// namespace Passenger</span>
+<a name="l00294"></a>00294
+<a name="l00295"></a>00295 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_EVENTED_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">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>