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/MessageClient_8h_source.html ADDED

@@ -0,0 +1,328 @@
+<!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: MessageClient.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>MessageClient.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_MESSAGE_CLIENT_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_MESSAGE_CLIENT_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;string&gt;</span>
+<a name="l00030"></a>00030
+<a name="l00031"></a>00031 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &quot;MessageChannel.h&quot;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &quot;Utils/IOUtils.h&quot;</span>
+<a name="l00035"></a>00035
+<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>std;
+<a name="l00040"></a>00040 <span class="keyword">using namespace </span>boost;
+<a name="l00041"></a>00041
+<a name="l00042"></a>00042 <span class="keyword">class </span>MessageClient {
+<a name="l00043"></a>00043 <span class="keyword">protected</span>:
+<a name="l00044"></a>00044         FileDescriptor fd;
+<a name="l00045"></a>00045         MessageChannel channel;
+<a name="l00046"></a>00046         <span class="keywordtype">bool</span> shouldAutoDisconnect;
+<a name="l00047"></a>00047
+<a name="l00048"></a>00048         <span class="comment">/* sendUsername() and sendPassword() exist and are virtual in order to facilitate unit testing. */</span>
+<a name="l00049"></a>00049
+<a name="l00050"></a>00050         <span class="keyword">virtual</span> <span class="keywordtype">void</span> sendUsername(MessageChannel &amp;channel, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;username) {
+<a name="l00051"></a>00051                 channel.writeScalar(username);
+<a name="l00052"></a>00052         }
+<a name="l00053"></a>00053
+<a name="l00054"></a>00054         <span class="keyword">virtual</span> <span class="keywordtype">void</span> sendPassword(MessageChannel &amp;channel, <span class="keyword">const</span> StaticString &amp;userSuppliedPassword) {
+<a name="l00055"></a>00055                 channel.writeScalar(userSuppliedPassword.c_str(), userSuppliedPassword.size());
+<a name="l00056"></a>00056         }
+<a name="l00057"></a>00057         <span class="comment"></span>
+<a name="l00058"></a>00058 <span class="comment">        /**</span>
+<a name="l00059"></a>00059 <span class="comment">         * Authenticate to the server with the given username and password.</span>
+<a name="l00060"></a>00060 <span class="comment">         *</span>
+<a name="l00061"></a>00061 <span class="comment">         * @throws SystemException An error occurred while reading data from or sending data to the server.</span>
+<a name="l00062"></a>00062 <span class="comment">         * @throws IOException An error occurred while reading data from or sending data to the server.</span>
+<a name="l00063"></a>00063 <span class="comment">         * @throws SecurityException The server denied authentication.</span>
+<a name="l00064"></a>00064 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00065"></a>00065 <span class="comment">         * @pre &lt;tt&gt;channel&lt;/tt&gt; is connected.</span>
+<a name="l00066"></a>00066 <span class="comment">         */</span>
+<a name="l00067"></a>00067         <span class="keywordtype">void</span> authenticate(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;username, <span class="keyword">const</span> StaticString &amp;userSuppliedPassword) {
+<a name="l00068"></a>00068                 vector&lt;string&gt; args;
+<a name="l00069"></a>00069
+<a name="l00070"></a>00070                 sendUsername(channel, username);
+<a name="l00071"></a>00071                 sendPassword(channel, userSuppliedPassword);
+<a name="l00072"></a>00072
+<a name="l00073"></a>00073                 <span class="keywordflow">if</span> (!channel.read(args)) {
+<a name="l00074"></a>00074                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The message server did not send an authentication response.&quot;</span>);
+<a name="l00075"></a>00075                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1) {
+<a name="l00076"></a>00076                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The authentication response that the message server sent is not valid.&quot;</span>);
+<a name="l00077"></a>00077                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args[0] != <span class="stringliteral">&quot;ok&quot;</span>) {
+<a name="l00078"></a>00078                         <span class="keywordflow">throw</span> SecurityException(<span class="stringliteral">&quot;The message server denied authentication: &quot;</span> + args[0]);
+<a name="l00079"></a>00079                 }
+<a name="l00080"></a>00080         }
+<a name="l00081"></a>00081
+<a name="l00082"></a>00082         <span class="keywordtype">void</span> autoDisconnect() {
+<a name="l00083"></a>00083                 <span class="keywordflow">if</span> (shouldAutoDisconnect) {
+<a name="l00084"></a>00084                         <span class="comment">// Closes the connection without throwing close exceptions.</span>
+<a name="l00085"></a>00085                         fd = FileDescriptor();
+<a name="l00086"></a>00086                         channel = MessageChannel();
+<a name="l00087"></a>00087                 }
+<a name="l00088"></a>00088         }
+<a name="l00089"></a>00089
+<a name="l00090"></a>00090 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00091"></a>00091 <span class="comment">        /**</span>
+<a name="l00092"></a>00092 <span class="comment">         * Create a new MessageClient object. It doesn&#39;t actually connect to the server until</span>
+<a name="l00093"></a>00093 <span class="comment">         * you call connect().</span>
+<a name="l00094"></a>00094 <span class="comment">         */</span>
+<a name="l00095"></a>00095         MessageClient() {
+<a name="l00096"></a>00096                 <span class="comment">/* The reason why we don&#39;t connect right away is because we want to make</span>
+<a name="l00097"></a>00097 <span class="comment">                 * certain methods virtual for unit testing purposes. We can&#39;t call</span>
+<a name="l00098"></a>00098 <span class="comment">                 * virtual methods in the constructor. :-(</span>
+<a name="l00099"></a>00099 <span class="comment">                 */</span>
+<a name="l00100"></a>00100                 shouldAutoDisconnect = <span class="keyword">true</span>;
+<a name="l00101"></a>00101         }
+<a name="l00102"></a>00102
+<a name="l00103"></a>00103         <span class="keyword">virtual</span> ~MessageClient() { }
+<a name="l00104"></a>00104         <span class="comment"></span>
+<a name="l00105"></a>00105 <span class="comment">        /**</span>
+<a name="l00106"></a>00106 <span class="comment">         * Connect to the given MessageServer. If a connection was already established,</span>
+<a name="l00107"></a>00107 <span class="comment">         * then the old connection will be closed and a new connection will be established.</span>
+<a name="l00108"></a>00108 <span class="comment">         *</span>
+<a name="l00109"></a>00109 <span class="comment">         * If this MessageClient was in a connected state, and this method throws an exception,</span>
+<a name="l00110"></a>00110 <span class="comment">         * then old connection will be broken.</span>
+<a name="l00111"></a>00111 <span class="comment">         *</span>
+<a name="l00112"></a>00112 <span class="comment">         * @param serverAddress The address of the server to connect to, in the format</span>
+<a name="l00113"></a>00113 <span class="comment">         *                      as specified by getSocketAddressType().</span>
+<a name="l00114"></a>00114 <span class="comment">         * @param username The username to use for authenticating with the server.</span>
+<a name="l00115"></a>00115 <span class="comment">         * @param userSuppliedPassword The password to use for authenticating with the server.</span>
+<a name="l00116"></a>00116 <span class="comment">         * @return this</span>
+<a name="l00117"></a>00117 <span class="comment">         * @throws SystemException Something went wrong while connecting to the server.</span>
+<a name="l00118"></a>00118 <span class="comment">         * @throws IOException Something went wrong while connecting to the server.</span>
+<a name="l00119"></a>00119 <span class="comment">         * @throws RuntimeException Something went wrong.</span>
+<a name="l00120"></a>00120 <span class="comment">         * @throws SecurityException Unable to authenticate to the server with the given username and password.</span>
+<a name="l00121"></a>00121 <span class="comment">         *                           You may call connect() again with a different username/password.</span>
+<a name="l00122"></a>00122 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00123"></a>00123 <span class="comment">         * @post connected()</span>
+<a name="l00124"></a>00124 <span class="comment">         */</span>
+<a name="l00125"></a>00125         MessageClient *connect(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;serverAddress, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;username,
+<a name="l00126"></a>00126                 <span class="keyword">const</span> StaticString &amp;userSuppliedPassword)
+<a name="l00127"></a>00127         {
+<a name="l00128"></a>00128                 TRACE_POINT();
+<a name="l00129"></a>00129                 <span class="keywordflow">try</span> {
+<a name="l00130"></a>00130                         fd = connectToServer(serverAddress.c_str());
+<a name="l00131"></a>00131                         channel = MessageChannel(fd);
+<a name="l00132"></a>00132
+<a name="l00133"></a>00133                         vector&lt;string&gt; args;
+<a name="l00134"></a>00134                         <span class="keywordflow">if</span> (!read(args)) {
+<a name="l00135"></a>00135                                 <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The message server closed the connection before sending a version identifier.&quot;</span>);
+<a name="l00136"></a>00136                         }
+<a name="l00137"></a>00137                         <span class="keywordflow">if</span> (args.size() != 2 || args[0] != <span class="stringliteral">&quot;version&quot;</span>) {
+<a name="l00138"></a>00138                                 <span class="keywordflow">throw</span> IOException(<span class="stringliteral">&quot;The message server didn&#39;t sent a valid version identifier.&quot;</span>);
+<a name="l00139"></a>00139                         }
+<a name="l00140"></a>00140                         <span class="keywordflow">if</span> (args[1] != <span class="stringliteral">&quot;1&quot;</span>) {
+<a name="l00141"></a>00141                                 <span class="keywordtype">string</span> message = string(<span class="stringliteral">&quot;Unsupported message server protocol version &quot;</span>) +
+<a name="l00142"></a>00142                                         args[1] + <span class="stringliteral">&quot;.&quot;</span>;
+<a name="l00143"></a>00143                                 <span class="keywordflow">throw</span> IOException(message);
+<a name="l00144"></a>00144                         }
+<a name="l00145"></a>00145
+<a name="l00146"></a>00146                         authenticate(username, userSuppliedPassword);
+<a name="l00147"></a>00147                         <span class="keywordflow">return</span> <span class="keyword">this</span>;
+<a name="l00148"></a>00148                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> RuntimeException &amp;) {
+<a name="l00149"></a>00149                         autoDisconnect();
+<a name="l00150"></a>00150                         <span class="keywordflow">throw</span>;
+<a name="l00151"></a>00151                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;) {
+<a name="l00152"></a>00152                         autoDisconnect();
+<a name="l00153"></a>00153                         <span class="keywordflow">throw</span>;
+<a name="l00154"></a>00154                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> IOException &amp;) {
+<a name="l00155"></a>00155                         autoDisconnect();
+<a name="l00156"></a>00156                         <span class="keywordflow">throw</span>;
+<a name="l00157"></a>00157                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> boost::thread_interrupted &amp;) {
+<a name="l00158"></a>00158                         autoDisconnect();
+<a name="l00159"></a>00159                         <span class="keywordflow">throw</span>;
+<a name="l00160"></a>00160                 }
+<a name="l00161"></a>00161         }
+<a name="l00162"></a>00162
+<a name="l00163"></a>00163         <span class="keywordtype">void</span> disconnect() {
+<a name="l00164"></a>00164                 fd.close();
+<a name="l00165"></a>00165                 fd = FileDescriptor();
+<a name="l00166"></a>00166                 channel = MessageChannel();
+<a name="l00167"></a>00167         }
+<a name="l00168"></a>00168
+<a name="l00169"></a>00169         <span class="keywordtype">bool</span> connected()<span class="keyword"> const </span>{
+<a name="l00170"></a>00170                 <span class="keywordflow">return</span> fd != -1;
+<a name="l00171"></a>00171         }
+<a name="l00172"></a>00172
+<a name="l00173"></a>00173         <span class="keywordtype">void</span> setAutoDisconnect(<span class="keywordtype">bool</span> value) {
+<a name="l00174"></a>00174                 shouldAutoDisconnect = value;
+<a name="l00175"></a>00175         }
+<a name="l00176"></a>00176
+<a name="l00177"></a>00177         FileDescriptor getConnection()<span class="keyword"> const </span>{
+<a name="l00178"></a>00178                 <span class="keywordflow">return</span> fd;
+<a name="l00179"></a>00179         }
+<a name="l00180"></a>00180         <span class="comment"></span>
+<a name="l00181"></a>00181 <span class="comment">        /**</span>
+<a name="l00182"></a>00182 <span class="comment">         * @throws SystemException</span>
+<a name="l00183"></a>00183 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00184"></a>00184 <span class="comment">         */</span>
+<a name="l00185"></a>00185         <span class="keywordtype">bool</span> read(vector&lt;string&gt; &amp;args) {
+<a name="l00186"></a>00186                 <span class="keywordflow">try</span> {
+<a name="l00187"></a>00187                         <span class="keywordflow">return</span> channel.read(args);
+<a name="l00188"></a>00188                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;e) {
+<a name="l00189"></a>00189                         autoDisconnect();
+<a name="l00190"></a>00190                         <span class="keywordflow">throw</span>;
+<a name="l00191"></a>00191                 }
+<a name="l00192"></a>00192         }
+<a name="l00193"></a>00193         <span class="comment"></span>
+<a name="l00194"></a>00194 <span class="comment">        /**</span>
+<a name="l00195"></a>00195 <span class="comment">         * @throws SystemException</span>
+<a name="l00196"></a>00196 <span class="comment">         * @throws SecurityException</span>
+<a name="l00197"></a>00197 <span class="comment">         * @throws TimeoutException</span>
+<a name="l00198"></a>00198 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00199"></a>00199 <span class="comment">         */</span>
+<a name="l00200"></a>00200         <span class="keywordtype">bool</span> readScalar(<span class="keywordtype">string</span> &amp;output, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
+<a name="l00201"></a>00201                 <span class="keywordflow">try</span> {
+<a name="l00202"></a>00202                         <span class="keywordflow">return</span> channel.readScalar(output, maxSize, timeout);
+<a name="l00203"></a>00203                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;) {
+<a name="l00204"></a>00204                         autoDisconnect();
+<a name="l00205"></a>00205                         <span class="keywordflow">throw</span>;
+<a name="l00206"></a>00206                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SecurityException &amp;) {
+<a name="l00207"></a>00207                         autoDisconnect();
+<a name="l00208"></a>00208                         <span class="keywordflow">throw</span>;
+<a name="l00209"></a>00209                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> TimeoutException &amp;) {
+<a name="l00210"></a>00210                         autoDisconnect();
+<a name="l00211"></a>00211                         <span class="keywordflow">throw</span>;
+<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">         * @throws SystemExeption</span>
+<a name="l00217"></a>00217 <span class="comment">         * @throws IOException</span>
+<a name="l00218"></a>00218 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00219"></a>00219 <span class="comment">         */</span>
+<a name="l00220"></a>00220         <span class="keywordtype">int</span> readFileDescriptor(<span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
+<a name="l00221"></a>00221                 <span class="keywordflow">try</span> {
+<a name="l00222"></a>00222                         <span class="keywordflow">return</span> channel.readFileDescriptor(negotiate);
+<a name="l00223"></a>00223                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;) {
+<a name="l00224"></a>00224                         autoDisconnect();
+<a name="l00225"></a>00225                         <span class="keywordflow">throw</span>;
+<a name="l00226"></a>00226                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> IOException &amp;) {
+<a name="l00227"></a>00227                         autoDisconnect();
+<a name="l00228"></a>00228                         <span class="keywordflow">throw</span>;
+<a name="l00229"></a>00229                 }
+<a name="l00230"></a>00230         }
+<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">         * @throws SystemException</span>
+<a name="l00234"></a>00234 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00235"></a>00235 <span class="comment">         */</span>
+<a name="l00236"></a>00236         <span class="keywordtype">void</span> write(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, ...) {
+<a name="l00237"></a>00237                 va_list ap;
+<a name="l00238"></a>00238                 va_start(ap, name);
+<a name="l00239"></a>00239                 <span class="keywordflow">try</span> {
+<a name="l00240"></a>00240                         <span class="keywordflow">try</span> {
+<a name="l00241"></a>00241                                 channel.write(name, ap);
+<a name="l00242"></a>00242                         } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;) {
+<a name="l00243"></a>00243                                 autoDisconnect();
+<a name="l00244"></a>00244                                 <span class="keywordflow">throw</span>;
+<a name="l00245"></a>00245                         }
+<a name="l00246"></a>00246                         va_end(ap);
+<a name="l00247"></a>00247                 } <span class="keywordflow">catch</span> (...) {
+<a name="l00248"></a>00248                         va_end(ap);
+<a name="l00249"></a>00249                         <span class="keywordflow">throw</span>;
+<a name="l00250"></a>00250                 }
+<a name="l00251"></a>00251         }
+<a name="l00252"></a>00252         <span class="comment"></span>
+<a name="l00253"></a>00253 <span class="comment">        /**</span>
+<a name="l00254"></a>00254 <span class="comment">         * @throws SystemException</span>
+<a name="l00255"></a>00255 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00256"></a>00256 <span class="comment">         */</span>
+<a name="l00257"></a>00257         <span class="keywordtype">void</span> writeScalar(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
+<a name="l00258"></a>00258                 <span class="keywordflow">try</span> {
+<a name="l00259"></a>00259                         channel.writeScalar(data, size);
+<a name="l00260"></a>00260                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;) {
+<a name="l00261"></a>00261                         autoDisconnect();
+<a name="l00262"></a>00262                         <span class="keywordflow">throw</span>;
+<a name="l00263"></a>00263                 }
+<a name="l00264"></a>00264         }
+<a name="l00265"></a>00265         <span class="comment"></span>
+<a name="l00266"></a>00266 <span class="comment">        /**</span>
+<a name="l00267"></a>00267 <span class="comment">         * @throws SystemException</span>
+<a name="l00268"></a>00268 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00269"></a>00269 <span class="comment">         */</span>
+<a name="l00270"></a>00270         <span class="keywordtype">void</span> writeScalar(<span class="keyword">const</span> StaticString &amp;data) {
+<a name="l00271"></a>00271                 <span class="keywordflow">try</span> {
+<a name="l00272"></a>00272                         channel.writeScalar(data.c_str(), data.size());
+<a name="l00273"></a>00273                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;) {
+<a name="l00274"></a>00274                         autoDisconnect();
+<a name="l00275"></a>00275                         <span class="keywordflow">throw</span>;
+<a name="l00276"></a>00276                 }
+<a name="l00277"></a>00277         }
+<a name="l00278"></a>00278         <span class="comment"></span>
+<a name="l00279"></a>00279 <span class="comment">        /**</span>
+<a name="l00280"></a>00280 <span class="comment">         * @throws SystemException</span>
+<a name="l00281"></a>00281 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00282"></a>00282 <span class="comment">         */</span>
+<a name="l00283"></a>00283         <span class="keywordtype">void</span> writeFileDescriptor(<span class="keywordtype">int</span> fileDescriptor, <span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
+<a name="l00284"></a>00284                 <span class="keywordflow">try</span> {
+<a name="l00285"></a>00285                         channel.writeFileDescriptor(fileDescriptor, negotiate);
+<a name="l00286"></a>00286                 } <span class="keywordflow">catch</span> (<span class="keyword">const</span> SystemException &amp;) {
+<a name="l00287"></a>00287                         autoDisconnect();
+<a name="l00288"></a>00288                         <span class="keywordflow">throw</span>;
+<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="keyword">typedef</span> shared_ptr&lt;MessageClient&gt; MessageClientPtr;
+<a name="l00294"></a>00294
+<a name="l00295"></a>00295 } <span class="comment">// namespace Passenger</span>
+<a name="l00296"></a>00296
+<a name="l00297"></a>00297 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_CLIENT_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/MessageReadersWriters_8h_source.html ADDED

@@ -0,0 +1,539 @@
+<!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: MessageReadersWriters.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>MessageReadersWriters.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_MESSAGE_READERS_WRITERS_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_MESSAGE_READERS_WRITERS_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/cstdint.hpp&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;oxt/macros.hpp&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;algorithm&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;vector&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;cstring&gt;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;arpa/inet.h&gt;</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include &quot;Utils/MemZeroGuard.h&quot;</span>
+<a name="l00039"></a>00039 <span class="comment"></span>
+<a name="l00040"></a>00040 <span class="comment">/**</span>
+<a name="l00041"></a>00041 <span class="comment"> * This file provides a bunch of classes for reading and writing messages in the</span>
+<a name="l00042"></a>00042 <span class="comment"> * MessageChannel format. Unlike MessageChannel, whose operations take control over</span>
+<a name="l00043"></a>00043 <span class="comment"> * the I/O handle and may block, these classes act like parsers and data generators.</span>
+<a name="l00044"></a>00044 <span class="comment"> * To read messages one must feed data to them. To write messages one must instruct</span>
+<a name="l00045"></a>00045 <span class="comment"> * the classes to generate a bunch of data. These classes will never block, making</span>
+<a name="l00046"></a>00046 <span class="comment"> * them ideal for use in evented servers.</span>
+<a name="l00047"></a>00047 <span class="comment"> *</span>
+<a name="l00048"></a>00048 <span class="comment"> * &lt;h2&gt;Reading messages&lt;/h2&gt;</span>
+<a name="l00049"></a>00049 <span class="comment"> * To read a single message, one must instantiate a message object and feed network</span>
+<a name="l00050"></a>00050 <span class="comment"> * data to it with the feed() method. This method returns the number of bytes</span>
+<a name="l00051"></a>00051 <span class="comment"> * actually processed by the message object (i.e. the number of bytes that it has</span>
+<a name="l00052"></a>00052 <span class="comment"> * recognized as part of the message).</span>
+<a name="l00053"></a>00053 <span class="comment"> *</span>
+<a name="l00054"></a>00054 <span class="comment"> * When the message object has either successfully parsed the data or encountered</span>
+<a name="l00055"></a>00055 <span class="comment"> * an error, it will indicate so via the done() method. With hasError() one can</span>
+<a name="l00056"></a>00056 <span class="comment"> * check whether an error was encountered or whether the reader succeeded, and</span>
+<a name="l00057"></a>00057 <span class="comment"> * with errorCode() one can obtain the exact error reason. Not all message objects</span>
+<a name="l00058"></a>00058 <span class="comment"> * support hasError() and errorCode() because some of them can never encounter</span>
+<a name="l00059"></a>00059 <span class="comment"> * errors and some of them can only fail for a single reason.</span>
+<a name="l00060"></a>00060 <span class="comment"> *</span>
+<a name="l00061"></a>00061 <span class="comment"> * When successful, the parsed message can be obtained with value(). This method</span>
+<a name="l00062"></a>00062 <span class="comment"> * may only be called when done() is true and there is no error, otherwise the</span>
+<a name="l00063"></a>00063 <span class="comment"> * return value is undefined.</span>
+<a name="l00064"></a>00064 <span class="comment"> *</span>
+<a name="l00065"></a>00065 <span class="comment"> * At this point, the message object cannot process any more data and feed() will</span>
+<a name="l00066"></a>00066 <span class="comment"> * always return 0. To reuse the object for processing another message, one must</span>
+<a name="l00067"></a>00067 <span class="comment"> * reset its state by calling reset().</span>
+<a name="l00068"></a>00068 <span class="comment"> *</span>
+<a name="l00069"></a>00069 <span class="comment"> * The following example demonstrates how to read a continuous stream of 32-bit</span>
+<a name="l00070"></a>00070 <span class="comment"> * integers:</span>
+<a name="l00071"></a>00071 <span class="comment"> * @code</span>
+<a name="l00072"></a>00072 <span class="comment">   Uint32Message intMessage;</span>
+<a name="l00073"></a>00073 <span class="comment">   while (true) {</span>
+<a name="l00074"></a>00074 <span class="comment">       // Read a bunch of network data...</span>
+<a name="l00075"></a>00075 <span class="comment">       char buf[1024];</span>
+<a name="l00076"></a>00076 <span class="comment">       ssize_t size = recv(fd, buf, sizeof(buf));</span>
+<a name="l00077"></a>00077 <span class="comment">       size_t consumed = 0;</span>
+<a name="l00078"></a>00078 <span class="comment">       </span>
+<a name="l00079"></a>00079 <span class="comment">       // ...and process it all. We only feed data to the message object</span>
+<a name="l00080"></a>00080 <span class="comment">       // that hasn&#39;t already been fed.</span>
+<a name="l00081"></a>00081 <span class="comment">       while (consumed &lt; size) {</span>
+<a name="l00082"></a>00082 <span class="comment">           consumed += intReader.feed(buf + consumed, size - consumed);</span>
+<a name="l00083"></a>00083 <span class="comment">           if (intMessage.done()) {</span>
+<a name="l00084"></a>00084 <span class="comment">               printf(&quot;Integer: %d\n&quot;, (int) intMessage.value());</span>
+<a name="l00085"></a>00085 <span class="comment">               // The state must be reset before the reader can be reused.</span>
+<a name="l00086"></a>00086 <span class="comment">               intMessage.reset();</span>
+<a name="l00087"></a>00087 <span class="comment">           }</span>
+<a name="l00088"></a>00088 <span class="comment">       }</span>
+<a name="l00089"></a>00089 <span class="comment">   }</span>
+<a name="l00090"></a>00090 <span class="comment"> * @endcode</span>
+<a name="l00091"></a>00091 <span class="comment"> *</span>
+<a name="l00092"></a>00092 <span class="comment"> * Some message objects return non-primitive values in their value() methods, such as</span>
+<a name="l00093"></a>00093 <span class="comment"> * ArrayMessage and ScalarMessage which return &lt;tt&gt;const vector&lt;StaticString&gt; &amp;&lt;/tt&gt;</span>
+<a name="l00094"></a>00094 <span class="comment"> * and &lt;tt&gt;StaticString&lt;/tt&gt;, respectively. These values are only valid until either</span>
+<a name="l00095"></a>00095 <span class="comment"> * of the following things occur:</span>
+<a name="l00096"></a>00096 <span class="comment"> *</span>
+<a name="l00097"></a>00097 <span class="comment"> * - The buffer containing last the fed data has been destroyed or modified.</span>
+<a name="l00098"></a>00098 <span class="comment"> * - The message object itself has been destroyed.</span>
+<a name="l00099"></a>00099 <span class="comment"> *</span>
+<a name="l00100"></a>00100 <span class="comment"> * This is because the message objects try to apply copy-zero optimizations whenever</span>
+<a name="l00101"></a>00101 <span class="comment"> * possible. For example, in case of ScalarMessage, it&#39;ll check whether the data</span>
+<a name="l00102"></a>00102 <span class="comment"> * that has been fed in the first feed() call already contains a full scalar message.</span>
+<a name="l00103"></a>00103 <span class="comment"> * If so then it&#39;ll just return a StaticString that points to the scalar message</span>
+<a name="l00104"></a>00104 <span class="comment"> * in the fed data; it will not copy the fed data. In this case it is important</span>
+<a name="l00105"></a>00105 <span class="comment"> * that the buffer containing the fed data is not modified or destroyed while the</span>
+<a name="l00106"></a>00106 <span class="comment"> * StaticString is in use.</span>
+<a name="l00107"></a>00107 <span class="comment"> * If the first feed() call does not supply a full scalar message then it will</span>
+<a name="l00108"></a>00108 <span class="comment"> * buffer all fed data until the buffer contains a full scalar message, and the</span>
+<a name="l00109"></a>00109 <span class="comment"> * result will point to this buffer. Because the buffer is owned by the message</span>
+<a name="l00110"></a>00110 <span class="comment"> * object, the result will be invalidated as soon as the message object is destroyed.</span>
+<a name="l00111"></a>00111 <span class="comment"> */</span>
+<a name="l00112"></a>00112
+<a name="l00113"></a>00113 <span class="keyword">namespace </span>Passenger {
+<a name="l00114"></a>00114
+<a name="l00115"></a>00115 <span class="keyword">using namespace </span>std;
+<a name="l00116"></a>00116 <span class="comment"></span>
+<a name="l00117"></a>00117 <span class="comment">/**</span>
+<a name="l00118"></a>00118 <span class="comment"> * For 16-bit big-endian integers.</span>
+<a name="l00119"></a>00119 <span class="comment"> */</span>
+<a name="l00120"></a><a class="code" href="classPassenger_1_1Uint16Message.html">00120</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Uint16Message.html" title="For 16-bit big-endian integers.">Uint16Message</a> {
+<a name="l00121"></a>00121 <span class="keyword">private</span>:
+<a name="l00122"></a>00122         uint16_t val;
+<a name="l00123"></a>00123         uint8_t  consumed;
+<a name="l00124"></a>00124
+<a name="l00125"></a>00125 <span class="keyword">public</span>:
+<a name="l00126"></a>00126         <a class="code" href="classPassenger_1_1Uint16Message.html" title="For 16-bit big-endian integers.">Uint16Message</a>() {
+<a name="l00127"></a>00127                 consumed = 0;
+<a name="l00128"></a>00128         }
+<a name="l00129"></a>00129
+<a name="l00130"></a>00130         <span class="keywordtype">void</span> reset() {
+<a name="l00131"></a>00131                 consumed = 0;
+<a name="l00132"></a>00132         }
+<a name="l00133"></a>00133
+<a name="l00134"></a>00134         <span class="keywordtype">size_t</span> feed(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size) {
+<a name="l00135"></a>00135                 <span class="keywordtype">size_t</span> locallyConsumed;
+<a name="l00136"></a>00136
+<a name="l00137"></a>00137                 locallyConsumed = std::min(size, <span class="keyword">sizeof</span>(uint16_t) - consumed);
+<a name="l00138"></a>00138                 memcpy((<span class="keywordtype">char</span> *) &amp;val + consumed, data, locallyConsumed);
+<a name="l00139"></a>00139                 consumed += locallyConsumed;
+<a name="l00140"></a>00140                 <span class="keywordflow">if</span> (locallyConsumed &gt; 0 &amp;&amp; done()) {
+<a name="l00141"></a>00141                         val = ntohs(val);
+<a name="l00142"></a>00142                 }
+<a name="l00143"></a>00143                 <span class="keywordflow">return</span> locallyConsumed;
+<a name="l00144"></a>00144         }
+<a name="l00145"></a>00145
+<a name="l00146"></a>00146         <span class="keywordtype">bool</span> done()<span class="keyword"> const </span>{
+<a name="l00147"></a>00147                 <span class="keywordflow">return</span> consumed == <span class="keyword">sizeof</span>(uint16_t);
+<a name="l00148"></a>00148         }
+<a name="l00149"></a>00149
+<a name="l00150"></a>00150         uint16_t value()<span class="keyword"> const </span>{
+<a name="l00151"></a>00151                 <span class="keywordflow">return</span> val;
+<a name="l00152"></a>00152         }
+<a name="l00153"></a>00153
+<a name="l00154"></a>00154         <span class="keyword">static</span> <span class="keywordtype">void</span> generate(<span class="keywordtype">void</span> *buf, uint16_t val) {
+<a name="l00155"></a>00155                 val = htons(val);
+<a name="l00156"></a>00156                 memcpy(buf, &amp;val, <span class="keyword">sizeof</span>(val));
+<a name="l00157"></a>00157         }
+<a name="l00158"></a>00158 };
+<a name="l00159"></a>00159 <span class="comment"></span>
+<a name="l00160"></a>00160 <span class="comment">/**</span>
+<a name="l00161"></a>00161 <span class="comment"> * For 32-bit big-endian integers.</span>
+<a name="l00162"></a>00162 <span class="comment"> */</span>
+<a name="l00163"></a><a class="code" href="classPassenger_1_1Uint32Message.html">00163</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Uint32Message.html" title="For 32-bit big-endian integers.">Uint32Message</a> {
+<a name="l00164"></a>00164 <span class="keyword">private</span>:
+<a name="l00165"></a>00165         uint32_t val;
+<a name="l00166"></a>00166         uint8_t  consumed;
+<a name="l00167"></a>00167
+<a name="l00168"></a>00168 <span class="keyword">public</span>:
+<a name="l00169"></a>00169         <a class="code" href="classPassenger_1_1Uint32Message.html" title="For 32-bit big-endian integers.">Uint32Message</a>() {
+<a name="l00170"></a>00170                 consumed = 0;
+<a name="l00171"></a>00171         }
+<a name="l00172"></a>00172
+<a name="l00173"></a>00173         <span class="keywordtype">void</span> reset() {
+<a name="l00174"></a>00174                 consumed = 0;
+<a name="l00175"></a>00175         }
+<a name="l00176"></a>00176
+<a name="l00177"></a>00177         <span class="keywordtype">size_t</span> feed(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size) {
+<a name="l00178"></a>00178                 <span class="keywordtype">size_t</span> locallyConsumed;
+<a name="l00179"></a>00179
+<a name="l00180"></a>00180                 locallyConsumed = std::min(size, <span class="keyword">sizeof</span>(uint32_t) - consumed);
+<a name="l00181"></a>00181                 memcpy((<span class="keywordtype">char</span> *) &amp;val + consumed, data, locallyConsumed);
+<a name="l00182"></a>00182                 consumed += locallyConsumed;
+<a name="l00183"></a>00183                 <span class="keywordflow">if</span> (locallyConsumed &gt; 0 &amp;&amp; done()) {
+<a name="l00184"></a>00184                         val = ntohl(val);
+<a name="l00185"></a>00185                 }
+<a name="l00186"></a>00186                 <span class="keywordflow">return</span> locallyConsumed;
+<a name="l00187"></a>00187         }
+<a name="l00188"></a>00188
+<a name="l00189"></a>00189         <span class="keywordtype">bool</span> done()<span class="keyword"> const </span>{
+<a name="l00190"></a>00190                 <span class="keywordflow">return</span> consumed == <span class="keyword">sizeof</span>(uint32_t);
+<a name="l00191"></a>00191         }
+<a name="l00192"></a>00192
+<a name="l00193"></a>00193         uint32_t value()<span class="keyword"> const </span>{
+<a name="l00194"></a>00194                 <span class="keywordflow">return</span> val;
+<a name="l00195"></a>00195         }
+<a name="l00196"></a>00196
+<a name="l00197"></a>00197         <span class="keyword">static</span> <span class="keywordtype">void</span> generate(<span class="keywordtype">void</span> *buf, uint32_t val) {
+<a name="l00198"></a>00198                 val = htonl(val);
+<a name="l00199"></a>00199                 memcpy(buf, &amp;val, <span class="keyword">sizeof</span>(val));
+<a name="l00200"></a>00200         }
+<a name="l00201"></a>00201 };
+<a name="l00202"></a>00202 <span class="comment"></span>
+<a name="l00203"></a>00203 <span class="comment">/**</span>
+<a name="l00204"></a>00204 <span class="comment"> * For array messages.</span>
+<a name="l00205"></a>00205 <span class="comment"> */</span>
+<a name="l00206"></a><a class="code" href="classPassenger_1_1ArrayMessage.html">00206</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1ArrayMessage.html" title="For array messages.">ArrayMessage</a> {
+<a name="l00207"></a>00207 <span class="keyword">public</span>:
+<a name="l00208"></a>00208         <span class="keyword">enum</span> Error {
+<a name="l00209"></a>00209                 TOO_LARGE
+<a name="l00210"></a>00210         };
+<a name="l00211"></a>00211
+<a name="l00212"></a>00212 <span class="keyword">private</span>:
+<a name="l00213"></a>00213         <span class="keyword">enum</span> State {
+<a name="l00214"></a>00214                 READING_HEADER,
+<a name="l00215"></a>00215                 READING_BODY,
+<a name="l00216"></a>00216                 DONE,
+<a name="l00217"></a>00217                 ERROR
+<a name="l00218"></a>00218         };
+<a name="l00219"></a>00219
+<a name="l00220"></a>00220         uint16_t toReserve;
+<a name="l00221"></a>00221         uint16_t maxSize;
+<a name="l00222"></a>00222         <a class="code" href="classPassenger_1_1Uint16Message.html" title="For 16-bit big-endian integers.">Uint16Message</a> headerReader;
+<a name="l00223"></a>00223         uint8_t state;
+<a name="l00224"></a>00224         uint8_t error;
+<a name="l00225"></a>00225         <span class="keywordtype">string</span> buffer;
+<a name="l00226"></a>00226         vector&lt;StaticString&gt; result;
+<a name="l00227"></a>00227
+<a name="l00228"></a>00228         <span class="keywordtype">void</span> parseBody(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size) {
+<a name="l00229"></a>00229                 <span class="keyword">const</span> <span class="keywordtype">char</span> *start = data;
+<a name="l00230"></a>00230                 <span class="keyword">const</span> <span class="keywordtype">char</span> *terminator;
+<a name="l00231"></a>00231                 <span class="keywordtype">size_t</span> rest = size;
+<a name="l00232"></a>00232
+<a name="l00233"></a>00233                 <span class="keywordflow">while</span> ((terminator = (<span class="keyword">const</span> <span class="keywordtype">char</span> *) memchr(start, <span class="charliteral">&#39;\0&#39;</span>, rest)) != NULL) {
+<a name="l00234"></a>00234                         <span class="keywordtype">size_t</span> len = terminator - start;
+<a name="l00235"></a>00235                         result.push_back(<a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a>(start, len));
+<a name="l00236"></a>00236                         start = terminator + 1;
+<a name="l00237"></a>00237                         rest = size - (start - data);
+<a name="l00238"></a>00238                 }
+<a name="l00239"></a>00239         }
+<a name="l00240"></a>00240
+<a name="l00241"></a>00241 <span class="keyword">public</span>:
+<a name="l00242"></a>00242         <a class="code" href="classPassenger_1_1ArrayMessage.html" title="For array messages.">ArrayMessage</a>() {
+<a name="l00243"></a>00243                 state = READING_HEADER;
+<a name="l00244"></a>00244                 toReserve = 0;
+<a name="l00245"></a>00245                 maxSize = 0;
+<a name="l00246"></a>00246         }
+<a name="l00247"></a>00247
+<a name="l00248"></a>00248         <span class="keywordtype">void</span> reserve(uint16_t size) {
+<a name="l00249"></a>00249                 toReserve = size;
+<a name="l00250"></a>00250                 result.reserve(size);
+<a name="l00251"></a>00251         }
+<a name="l00252"></a>00252
+<a name="l00253"></a>00253         <span class="keywordtype">void</span> setMaxSize(uint16_t size) {
+<a name="l00254"></a>00254                 maxSize = size;
+<a name="l00255"></a>00255         }
+<a name="l00256"></a>00256
+<a name="l00257"></a>00257         <span class="keywordtype">void</span> reset() {
+<a name="l00258"></a>00258                 state = READING_HEADER;
+<a name="l00259"></a>00259                 headerReader.reset();
+<a name="l00260"></a>00260                 buffer.clear();
+<a name="l00261"></a>00261                 result.clear();
+<a name="l00262"></a>00262                 <span class="keywordflow">if</span> (toReserve &gt; 0) {
+<a name="l00263"></a>00263                         result.reserve(toReserve);
+<a name="l00264"></a>00264                 }
+<a name="l00265"></a>00265         }
+<a name="l00266"></a>00266
+<a name="l00267"></a>00267         <span class="keywordtype">size_t</span> feed(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size) {
+<a name="l00268"></a>00268                 <span class="keywordtype">size_t</span> consumed = 0;
+<a name="l00269"></a>00269
+<a name="l00270"></a>00270                 <span class="keywordflow">while</span> (consumed &lt; size &amp;&amp; !done()) {
+<a name="l00271"></a>00271                         <span class="keyword">const</span> <span class="keywordtype">char</span> *current = data + consumed;
+<a name="l00272"></a>00272                         <span class="keywordtype">size_t</span> rest = size - consumed;
+<a name="l00273"></a>00273
+<a name="l00274"></a>00274                         <span class="keywordflow">switch</span> (state) {
+<a name="l00275"></a>00275                         <span class="keywordflow">case</span> READING_HEADER:
+<a name="l00276"></a>00276                                 consumed += headerReader.feed(current, rest);
+<a name="l00277"></a>00277                                 <span class="keywordflow">if</span> (headerReader.done()) {
+<a name="l00278"></a>00278                                         <span class="keywordflow">if</span> (maxSize &gt; 0 &amp;&amp; headerReader.value() &gt; maxSize) {
+<a name="l00279"></a>00279                                                 state = ERROR;
+<a name="l00280"></a>00280                                                 error = TOO_LARGE;
+<a name="l00281"></a>00281                                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (headerReader.value() == 0) {
+<a name="l00282"></a>00282                                                 state = DONE;
+<a name="l00283"></a>00283                                         } <span class="keywordflow">else</span> {
+<a name="l00284"></a>00284                                                 state = READING_BODY;
+<a name="l00285"></a>00285                                         }
+<a name="l00286"></a>00286                                 }
+<a name="l00287"></a>00287                                 <span class="keywordflow">break</span>;
+<a name="l00288"></a>00288                         <span class="keywordflow">case</span> READING_BODY:
+<a name="l00289"></a>00289                                 <span class="keywordflow">if</span> (buffer.empty() &amp;&amp; rest &gt;= headerReader.value()) {
+<a name="l00290"></a>00290                                         parseBody(current, headerReader.value());
+<a name="l00291"></a>00291                                         state = DONE;
+<a name="l00292"></a>00292                                         consumed += headerReader.value();
+<a name="l00293"></a>00293                                 } <span class="keywordflow">else</span> {
+<a name="l00294"></a>00294                                         <span class="keywordtype">size_t</span> toConsume = std::min(rest,
+<a name="l00295"></a>00295                                                 headerReader.value() - buffer.size());
+<a name="l00296"></a>00296                                         <span class="keywordflow">if</span> (buffer.capacity() &lt; headerReader.value()) {
+<a name="l00297"></a>00297                                                 buffer.reserve(headerReader.value());
+<a name="l00298"></a>00298                                         }
+<a name="l00299"></a>00299                                         buffer.append(current, toConsume);
+<a name="l00300"></a>00300                                         consumed += toConsume;
+<a name="l00301"></a>00301                                         <span class="keywordflow">if</span> (buffer.size() == headerReader.value()) {
+<a name="l00302"></a>00302                                                 parseBody(buffer.data(), buffer.size());
+<a name="l00303"></a>00303                                                 state = DONE;
+<a name="l00304"></a>00304                                         }
+<a name="l00305"></a>00305                                 }
+<a name="l00306"></a>00306                                 <span class="keywordflow">break</span>;
+<a name="l00307"></a>00307                         <span class="keywordflow">default</span>:
+<a name="l00308"></a>00308                                 <span class="comment">// Never reached.</span>
+<a name="l00309"></a>00309                                 abort();
+<a name="l00310"></a>00310                         }
+<a name="l00311"></a>00311                 }
+<a name="l00312"></a>00312                 <span class="keywordflow">return</span> consumed;
+<a name="l00313"></a>00313         }
+<a name="l00314"></a>00314
+<a name="l00315"></a>00315         <span class="keywordtype">bool</span> done()<span class="keyword"> const </span>{
+<a name="l00316"></a>00316                 <span class="keywordflow">return</span> state == DONE || state == ERROR;
+<a name="l00317"></a>00317         }
+<a name="l00318"></a>00318
+<a name="l00319"></a>00319         <span class="keywordtype">bool</span> hasError()<span class="keyword"> const </span>{
+<a name="l00320"></a>00320                 <span class="keywordflow">return</span> state == ERROR;
+<a name="l00321"></a>00321         }
+<a name="l00322"></a>00322
+<a name="l00323"></a>00323         Error errorCode()<span class="keyword"> const </span>{
+<a name="l00324"></a>00324                 <span class="keywordflow">return</span> (Error) error;
+<a name="l00325"></a>00325         }
+<a name="l00326"></a>00326
+<a name="l00327"></a>00327         <span class="keyword">const</span> vector&lt;StaticString&gt; &amp;value()<span class="keyword"> const </span>{
+<a name="l00328"></a>00328                 <span class="keywordflow">return</span> result;
+<a name="l00329"></a>00329         }
+<a name="l00330"></a>00330         <span class="comment"></span>
+<a name="l00331"></a>00331 <span class="comment">        /**</span>
+<a name="l00332"></a>00332 <span class="comment">         * Given a bunch of array items, generates an array message. The message is</span>
+<a name="l00333"></a>00333 <span class="comment">         * generated in the form of an array of StaticStrings which must all be written</span>
+<a name="l00334"></a>00334 <span class="comment">         * out (e.g. with writev()) in the given order. These StaticStrings point</span>
+<a name="l00335"></a>00335 <span class="comment">         * to the buffers pointed to by &lt;em&gt;args&lt;/em&gt; as well as &lt;em&gt;headerBuf&lt;/em&gt;,</span>
+<a name="l00336"></a>00336 <span class="comment">         * so &lt;em&gt;args&lt;/em&gt; and &lt;em&gt;headerBuf&lt;/em&gt; must stay valid until the message</span>
+<a name="l00337"></a>00337 <span class="comment">         * has been written out or copied.</span>
+<a name="l00338"></a>00338 <span class="comment">         *</span>
+<a name="l00339"></a>00339 <span class="comment">         * @param args An array of array items to be included in the array message.</span>
+<a name="l00340"></a>00340 <span class="comment">         * @param argsCount The number of items in &lt;em&gt;args&lt;/em&gt;.</span>
+<a name="l00341"></a>00341 <span class="comment">         * @param headerBuf A pointer to a buffer in which the array message header</span>
+<a name="l00342"></a>00342 <span class="comment">         *                  is to be stored.</span>
+<a name="l00343"></a>00343 <span class="comment">         * @param out A pointer to a StaticString array in which the generated array</span>
+<a name="l00344"></a>00344 <span class="comment">         *            message data will be stored. Exactly &lt;tt&gt;outputSize(argsCount)&lt;/tt&gt;</span>
+<a name="l00345"></a>00345 <span class="comment">         *            items will be stored in this array.</span>
+<a name="l00346"></a>00346 <span class="comment">         * @param outCount The number of items in &lt;em&gt;out&lt;/em&gt;.</span>
+<a name="l00347"></a>00347 <span class="comment">         */</span>
+<a name="l00348"></a><a class="code" href="classPassenger_1_1ArrayMessage.html#a25603619576f11f0d76286a17a014a92">00348</a>         <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ArrayMessage.html#a25603619576f11f0d76286a17a014a92" title="Given a bunch of array items, generates an array message.">generate</a>(<a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> args[], <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> argsCount,
+<a name="l00349"></a>00349                 <span class="keywordtype">char</span> headerBuf[<span class="keyword">sizeof</span>(uint16_t)], <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> *out, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> outCount)
+<a name="l00350"></a>00350         {
+<a name="l00351"></a>00351                 <span class="keywordflow">if</span> (OXT_UNLIKELY(outCount &lt; outputSize(argsCount))) {
+<a name="l00352"></a>00352                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1ArgumentException.html" title="Indicates that a specified argument is incorrect or violates a requirement.">ArgumentException</a>(<span class="stringliteral">&quot;outCount too small.&quot;</span>);
+<a name="l00353"></a>00353                 }
+<a name="l00354"></a>00354
+<a name="l00355"></a>00355                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size = 0;
+<a name="l00356"></a>00356                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
+<a name="l00357"></a>00357
+<a name="l00358"></a>00358                 <span class="keywordflow">for</span> (i = 0; i &lt; argsCount; i++) {
+<a name="l00359"></a>00359                         size += args[i].size() + 1;
+<a name="l00360"></a>00360                 }
+<a name="l00361"></a>00361                 <span class="keywordflow">if</span> (OXT_UNLIKELY(size &gt; 0xFFFF)) {
+<a name="l00362"></a>00362                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1ArgumentException.html" title="Indicates that a specified argument is incorrect or violates a requirement.">ArgumentException</a>(<span class="stringliteral">&quot;Data size exceeds maximum size for array messages.&quot;</span>);
+<a name="l00363"></a>00363                 }
+<a name="l00364"></a>00364
+<a name="l00365"></a>00365                 <a class="code" href="classPassenger_1_1ArrayMessage.html#a25603619576f11f0d76286a17a014a92" title="Given a bunch of array items, generates an array message.">Uint16Message::generate</a>(headerBuf, size);
+<a name="l00366"></a>00366                 out[0] = <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a>(headerBuf, <span class="keyword">sizeof</span>(uint16_t));
+<a name="l00367"></a>00367                 <span class="keywordflow">for</span> (i = 0; i &lt; argsCount; i++) {
+<a name="l00368"></a>00368                         out[1 + 2 * i] = args[i];
+<a name="l00369"></a>00369                         out[1 + 2 * i + 1] = <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a>(<span class="stringliteral">&quot;\0&quot;</span>, 1);
+<a name="l00370"></a>00370                 }
+<a name="l00371"></a>00371         }
+<a name="l00372"></a>00372
+<a name="l00373"></a>00373         <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> outputSize(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> argsCount) {
+<a name="l00374"></a>00374                 <span class="keywordflow">return</span> argsCount * 2 + 1;
+<a name="l00375"></a>00375         }
+<a name="l00376"></a>00376 };
+<a name="l00377"></a>00377 <span class="comment"></span>
+<a name="l00378"></a>00378 <span class="comment">/**</span>
+<a name="l00379"></a>00379 <span class="comment"> * Class for reading a scalar message.</span>
+<a name="l00380"></a>00380 <span class="comment"> */</span>
+<a name="l00381"></a><a class="code" href="classPassenger_1_1ScalarMessage.html">00381</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1ScalarMessage.html" title="Class for reading a scalar message.">ScalarMessage</a> {
+<a name="l00382"></a>00382 <span class="keyword">public</span>:
+<a name="l00383"></a>00383         <span class="keyword">enum</span> Error {
+<a name="l00384"></a>00384                 TOO_LARGE
+<a name="l00385"></a>00385         };
+<a name="l00386"></a>00386
+<a name="l00387"></a>00387 <span class="keyword">private</span>:
+<a name="l00388"></a>00388         <span class="keyword">enum</span> State {
+<a name="l00389"></a>00389                 READING_HEADER,
+<a name="l00390"></a>00390                 READING_BODY,
+<a name="l00391"></a>00391                 DONE,
+<a name="l00392"></a>00392                 ERROR
+<a name="l00393"></a>00393         };
+<a name="l00394"></a>00394
+<a name="l00395"></a>00395         uint8_t state;
+<a name="l00396"></a>00396         uint8_t error;
+<a name="l00397"></a>00397         uint32_t maxSize;
+<a name="l00398"></a>00398         <a class="code" href="classPassenger_1_1Uint32Message.html" title="For 32-bit big-endian integers.">Uint32Message</a> headerReader;
+<a name="l00399"></a>00399         <span class="keywordtype">string</span> buffer;
+<a name="l00400"></a>00400         <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> result;
+<a name="l00401"></a>00401
+<a name="l00402"></a>00402 <span class="keyword">public</span>:
+<a name="l00403"></a>00403         <a class="code" href="classPassenger_1_1ScalarMessage.html" title="Class for reading a scalar message.">ScalarMessage</a>(uint32_t maxSize = 0) {
+<a name="l00404"></a>00404                 state = READING_HEADER;
+<a name="l00405"></a>00405                 this-&gt;maxSize = maxSize;
+<a name="l00406"></a>00406         }
+<a name="l00407"></a>00407
+<a name="l00408"></a>00408         <span class="keywordtype">void</span> setMaxSize(uint32_t maxSize) {
+<a name="l00409"></a>00409                 this-&gt;maxSize = maxSize;
+<a name="l00410"></a>00410         }
+<a name="l00411"></a>00411         <span class="comment"></span>
+<a name="l00412"></a>00412 <span class="comment">        /**</span>
+<a name="l00413"></a>00413 <span class="comment">         * Resets the internal state so that this object can be used for processing</span>
+<a name="l00414"></a>00414 <span class="comment">         * another scalar message.</span>
+<a name="l00415"></a>00415 <span class="comment">         *</span>
+<a name="l00416"></a>00416 <span class="comment">         * If &lt;em&gt;zeroBuffer&lt;/em&gt; is true, then the contents of the internal buffer</span>
+<a name="l00417"></a>00417 <span class="comment">         * will be securely filled with zeroes. This is useful if e.g. the buffer</span>
+<a name="l00418"></a>00418 <span class="comment">         * might contain sensitive password data.</span>
+<a name="l00419"></a>00419 <span class="comment">         */</span>
+<a name="l00420"></a><a class="code" href="classPassenger_1_1ScalarMessage.html#aadcc25dfe89d8acbf308bf951cc5bf32">00420</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1ScalarMessage.html#aadcc25dfe89d8acbf308bf951cc5bf32" title="Resets the internal state so that this object can be used for processing another...">reset</a>(<span class="keywordtype">bool</span> zeroBuffer = <span class="keyword">false</span>) {
+<a name="l00421"></a>00421                 state = READING_HEADER;
+<a name="l00422"></a>00422                 <span class="keywordflow">if</span> (zeroBuffer) {
+<a name="l00423"></a>00423                         MemZeroGuard guard(buffer);
+<a name="l00424"></a>00424                 }
+<a name="l00425"></a>00425                 headerReader.reset();
+<a name="l00426"></a>00426                 buffer.clear();
+<a name="l00427"></a>00427         }
+<a name="l00428"></a>00428
+<a name="l00429"></a>00429         <span class="keywordtype">size_t</span> feed(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size) {
+<a name="l00430"></a>00430                 <span class="keywordtype">size_t</span> consumed = 0;
+<a name="l00431"></a>00431
+<a name="l00432"></a>00432                 <span class="keywordflow">while</span> (consumed &lt; size &amp;&amp; !done()) {
+<a name="l00433"></a>00433                         <span class="keyword">const</span> <span class="keywordtype">char</span> *current = data + consumed;
+<a name="l00434"></a>00434                         <span class="keywordtype">size_t</span> rest = size - consumed;
+<a name="l00435"></a>00435
+<a name="l00436"></a>00436                         <span class="keywordflow">switch</span> (state) {
+<a name="l00437"></a>00437                         <span class="keywordflow">case</span> READING_HEADER:
+<a name="l00438"></a>00438                                 consumed += headerReader.feed(current, rest);
+<a name="l00439"></a>00439                                 <span class="keywordflow">if</span> (headerReader.done()) {
+<a name="l00440"></a>00440                                         <span class="keywordflow">if</span> (maxSize &gt; 0 &amp;&amp; headerReader.value() &gt; maxSize) {
+<a name="l00441"></a>00441                                                 state = ERROR;
+<a name="l00442"></a>00442                                                 error = TOO_LARGE;
+<a name="l00443"></a>00443                                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (headerReader.value() == 0) {
+<a name="l00444"></a>00444                                                 state = DONE;
+<a name="l00445"></a>00445                                         } <span class="keywordflow">else</span> {
+<a name="l00446"></a>00446                                                 state = READING_BODY;
+<a name="l00447"></a>00447                                         }
+<a name="l00448"></a>00448                                 }
+<a name="l00449"></a>00449                                 <span class="keywordflow">break</span>;
+<a name="l00450"></a>00450                         <span class="keywordflow">case</span> READING_BODY:
+<a name="l00451"></a>00451                                 <span class="keywordflow">if</span> (buffer.empty() &amp;&amp; rest &gt;= headerReader.value()) {
+<a name="l00452"></a>00452                                         result = StaticString(current, headerReader.value());
+<a name="l00453"></a>00453                                         state = DONE;
+<a name="l00454"></a>00454                                         consumed += headerReader.value();
+<a name="l00455"></a>00455                                 } <span class="keywordflow">else</span> {
+<a name="l00456"></a>00456                                         <span class="keywordtype">size_t</span> toConsume = std::min(rest,
+<a name="l00457"></a>00457                                                 headerReader.value() - buffer.size());
+<a name="l00458"></a>00458                                         <span class="keywordflow">if</span> (buffer.capacity() &lt; headerReader.value()) {
+<a name="l00459"></a>00459                                                 buffer.reserve(headerReader.value());
+<a name="l00460"></a>00460                                         }
+<a name="l00461"></a>00461                                         buffer.append(current, toConsume);
+<a name="l00462"></a>00462                                         consumed += toConsume;
+<a name="l00463"></a>00463                                         <span class="keywordflow">if</span> (buffer.size() == headerReader.value()) {
+<a name="l00464"></a>00464                                                 result = StaticString(buffer);
+<a name="l00465"></a>00465                                                 state = DONE;
+<a name="l00466"></a>00466                                         }
+<a name="l00467"></a>00467                                 }
+<a name="l00468"></a>00468                                 <span class="keywordflow">break</span>;
+<a name="l00469"></a>00469                         <span class="keywordflow">default</span>:
+<a name="l00470"></a>00470                                 <span class="comment">// Never reached.</span>
+<a name="l00471"></a>00471                                 abort();
+<a name="l00472"></a>00472                         };
+<a name="l00473"></a>00473                 }
+<a name="l00474"></a>00474                 <span class="keywordflow">return</span> consumed;
+<a name="l00475"></a>00475         }
+<a name="l00476"></a>00476
+<a name="l00477"></a>00477         <span class="keywordtype">bool</span> done()<span class="keyword"> const </span>{
+<a name="l00478"></a>00478                 <span class="keywordflow">return</span> state == DONE || state == ERROR;
+<a name="l00479"></a>00479         }
+<a name="l00480"></a>00480
+<a name="l00481"></a>00481         <span class="keywordtype">bool</span> hasError()<span class="keyword"> const </span>{
+<a name="l00482"></a>00482                 <span class="keywordflow">return</span> state == ERROR;
+<a name="l00483"></a>00483         }
+<a name="l00484"></a>00484
+<a name="l00485"></a>00485         Error errorCode()<span class="keyword"> const </span>{
+<a name="l00486"></a>00486                 <span class="keywordflow">return</span> (Error) error;
+<a name="l00487"></a>00487         }
+<a name="l00488"></a>00488
+<a name="l00489"></a>00489         <span class="keyword">const</span> StaticString &amp;value()<span class="keyword"> const </span>{
+<a name="l00490"></a>00490                 <span class="keywordflow">return</span> result;
+<a name="l00491"></a>00491         }
+<a name="l00492"></a>00492
+<a name="l00493"></a>00493         <span class="keyword">static</span> <span class="keywordtype">void</span> generate(<span class="keyword">const</span> StaticString &amp;data, <span class="keywordtype">char</span> headerBuf[<span class="keyword">sizeof</span>(uint32_t)],
+<a name="l00494"></a>00494                 StaticString output[2])
+<a name="l00495"></a>00495         {
+<a name="l00496"></a>00496                 <span class="keywordflow">if</span> (OXT_UNLIKELY(data.size() &gt; 0xFFFFFFFF)) {
+<a name="l00497"></a>00497                         <span class="keywordflow">throw</span> ArgumentException(<span class="stringliteral">&quot;Data size exceeds maximum size for scalar messages.&quot;</span>);
+<a name="l00498"></a>00498                 }
+<a name="l00499"></a>00499
+<a name="l00500"></a>00500                 Uint32Message::generate(headerBuf, data.size());
+<a name="l00501"></a>00501                 output[0] = StaticString(headerBuf, <span class="keyword">sizeof</span>(uint32_t));
+<a name="l00502"></a>00502                 output[1] = data;
+<a name="l00503"></a>00503         }
+<a name="l00504"></a>00504 };
+<a name="l00505"></a>00505
+<a name="l00506"></a>00506 } <span class="comment">// namespace Passenger</span>
+<a name="l00507"></a>00507
+<a name="l00508"></a>00508 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_READERS_WRITERS_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>