passenger 2.2.11 → 2.2.12

data/doc/cxxapi/MessageChannel_8h-source.html

@@ -415,412 +415,437 @@
 <a name="l00393"></a>00393 <span class="comment">         * @see readFileDescriptor()</span>
 <a name="l00394"></a>00394 <span class="comment">         */</span>
 <a name="l00395"></a><a class="code" href="classPassenger_1_1MessageChannel.html#e0c558e07dcc91900016773b2bec38d8">00395</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#e0c558e07dcc91900016773b2bec38d8" title="Pass a file descriptor.">writeFileDescriptor</a>(<span class="keywordtype">int</span> fileDescriptor, <span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
-<a name="l00396"></a>00396                 <span class="keywordflow">if</span> (negotiate) {
-<a name="l00397"></a>00397                         vector&lt;string&gt; args;
-<a name="l00398"></a>00398                         
-<a name="l00399"></a>00399                         <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
-<a name="l00400"></a>00400                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Unexpected end of stream encountered"</span>);
-<a name="l00401"></a>00401                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">"pass IO"</span>) {
-<a name="l00402"></a>00402                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"FD passing negotiation message expected."</span>);
-<a name="l00403"></a>00403                         }
-<a name="l00404"></a>00404                 }
-<a name="l00405"></a>00405                 
-<a name="l00406"></a>00406                 <span class="keyword">struct </span>msghdr msg;
-<a name="l00407"></a>00407                 <span class="keyword">struct </span>iovec vec;
-<a name="l00408"></a>00408                 <span class="keywordtype">char</span> dummy[1];
-<a name="l00409"></a>00409 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
-<a name="l00410"></a>00410 <span class="preprocessor"></span>                        <span class="keyword">struct </span>{
-<a name="l00411"></a>00411                                 <span class="keyword">struct </span>cmsghdr header;
-<a name="l00412"></a>00412                                 <span class="keywordtype">int</span> fd;
-<a name="l00413"></a>00413                         } control_data;
-<a name="l00414"></a>00414 <span class="preprocessor">                #else</span>
-<a name="l00415"></a>00415 <span class="preprocessor"></span>                        <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
-<a name="l00416"></a>00416 <span class="preprocessor">                #endif</span>
-<a name="l00417"></a>00417 <span class="preprocessor"></span>                <span class="keyword">struct </span>cmsghdr *control_header;
-<a name="l00418"></a>00418                 <span class="keywordtype">int</span> ret;
-<a name="l00419"></a>00419         
-<a name="l00420"></a>00420                 msg.msg_name = NULL;
-<a name="l00421"></a>00421                 msg.msg_namelen = 0;
-<a name="l00422"></a>00422         
-<a name="l00423"></a>00423                 <span class="comment">/* Linux and Solaris require msg_iov to be non-NULL. */</span>
-<a name="l00424"></a>00424                 dummy[0]       = <span class="charliteral">'\0'</span>;
-<a name="l00425"></a>00425                 vec.iov_base   = dummy;
-<a name="l00426"></a>00426                 vec.iov_len    = <span class="keyword">sizeof</span>(dummy);
-<a name="l00427"></a>00427                 msg.msg_iov    = &amp;vec;
-<a name="l00428"></a>00428                 msg.msg_iovlen = 1;
-<a name="l00429"></a>00429         
-<a name="l00430"></a>00430                 msg.msg_control    = (caddr_t) &amp;control_data;
-<a name="l00431"></a>00431                 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
-<a name="l00432"></a>00432                 msg.msg_flags      = 0;
-<a name="l00433"></a>00433                 
-<a name="l00434"></a>00434                 control_header = CMSG_FIRSTHDR(&amp;msg);
-<a name="l00435"></a>00435                 control_header-&gt;cmsg_level = SOL_SOCKET;
-<a name="l00436"></a>00436                 control_header-&gt;cmsg_type  = SCM_RIGHTS;
-<a name="l00437"></a>00437 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
-<a name="l00438"></a>00438 <span class="preprocessor"></span>                        control_header-&gt;cmsg_len = <span class="keyword">sizeof</span>(control_data);
-<a name="l00439"></a>00439                         control_data.fd = fileDescriptor;
-<a name="l00440"></a>00440 <span class="preprocessor">                #else</span>
-<a name="l00441"></a>00441 <span class="preprocessor"></span>                        control_header-&gt;cmsg_len = CMSG_LEN(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
-<a name="l00442"></a>00442                         memcpy(CMSG_DATA(control_header), &amp;fileDescriptor, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
-<a name="l00443"></a>00443 <span class="preprocessor">                #endif</span>
-<a name="l00444"></a>00444 <span class="preprocessor"></span>                
-<a name="l00445"></a>00445                 ret = syscalls::sendmsg(fd, &amp;msg, 0);
-<a name="l00446"></a>00446                 <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00447"></a>00447                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot send file descriptor with sendmsg()"</span>, errno);
-<a name="l00448"></a>00448                 }
-<a name="l00449"></a>00449         }
-<a name="l00450"></a>00450         <span class="comment"></span>
-<a name="l00451"></a>00451 <span class="comment">        /**</span>
-<a name="l00452"></a>00452 <span class="comment">         * Read an array message from the underlying file descriptor.</span>
-<a name="l00453"></a>00453 <span class="comment">         *</span>
-<a name="l00454"></a>00454 <span class="comment">         * @param args The message will be put in this variable.</span>
-<a name="l00455"></a>00455 <span class="comment">         * @return Whether end-of-file has been reached. If so, then the contents</span>
-<a name="l00456"></a>00456 <span class="comment">         *         of &lt;tt&gt;args&lt;/tt&gt; will be undefined.</span>
-<a name="l00457"></a>00457 <span class="comment">         * @throws SystemException If an error occured while receiving the message.</span>
-<a name="l00458"></a>00458 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00459"></a>00459 <span class="comment">         * @see write()</span>
-<a name="l00460"></a>00460 <span class="comment">         */</span>
-<a name="l00461"></a><a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e">00461</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(vector&lt;string&gt; &amp;args) {
-<a name="l00462"></a>00462                 uint16_t size;
-<a name="l00463"></a>00463                 <span class="keywordtype">int</span> ret;
-<a name="l00464"></a>00464                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
-<a name="l00465"></a>00465                 
-<a name="l00466"></a>00466                 <span class="keywordflow">do</span> {
-<a name="l00467"></a>00467                         ret = <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) &amp;size + alreadyRead, <span class="keyword">sizeof</span>(size) - alreadyRead);
-<a name="l00468"></a>00468                         <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00469"></a>00469                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
-<a name="l00470"></a>00470                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
-<a name="l00471"></a>00471                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00472"></a>00472                         }
-<a name="l00473"></a>00473                         alreadyRead += ret;
-<a name="l00474"></a>00474                 } <span class="keywordflow">while</span> (alreadyRead &lt; <span class="keyword">sizeof</span>(size));
-<a name="l00475"></a>00475                 size = ntohs(size);
+<a name="l00396"></a>00396                 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
+<a name="l00397"></a>00397                 <span class="keywordflow">if</span> (negotiate) {
+<a name="l00398"></a>00398                         vector&lt;string&gt; args;
+<a name="l00399"></a>00399                         
+<a name="l00400"></a>00400                         <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
+<a name="l00401"></a>00401                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Unexpected end of stream encountered while pre-negotiating a file descriptor"</span>);
+<a name="l00402"></a>00402                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">"pass IO"</span>) {
+<a name="l00403"></a>00403                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"FD passing pre-negotiation message expected."</span>);
+<a name="l00404"></a>00404                         }
+<a name="l00405"></a>00405                 }
+<a name="l00406"></a>00406                 
+<a name="l00407"></a>00407                 <span class="keyword">struct </span>msghdr msg;
+<a name="l00408"></a>00408                 <span class="keyword">struct </span>iovec vec;
+<a name="l00409"></a>00409                 <span class="keywordtype">char</span> dummy[1];
+<a name="l00410"></a>00410 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
+<a name="l00411"></a>00411 <span class="preprocessor"></span>                        <span class="keyword">struct </span>{
+<a name="l00412"></a>00412                                 <span class="keyword">struct </span>cmsghdr header;
+<a name="l00413"></a>00413                                 <span class="keywordtype">int</span> fd;
+<a name="l00414"></a>00414                         } control_data;
+<a name="l00415"></a>00415 <span class="preprocessor">                #else</span>
+<a name="l00416"></a>00416 <span class="preprocessor"></span>                        <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
+<a name="l00417"></a>00417 <span class="preprocessor">                #endif</span>
+<a name="l00418"></a>00418 <span class="preprocessor"></span>                <span class="keyword">struct </span>cmsghdr *control_header;
+<a name="l00419"></a>00419                 <span class="keywordtype">int</span> ret;
+<a name="l00420"></a>00420         
+<a name="l00421"></a>00421                 msg.msg_name = NULL;
+<a name="l00422"></a>00422                 msg.msg_namelen = 0;
+<a name="l00423"></a>00423         
+<a name="l00424"></a>00424                 <span class="comment">/* Linux and Solaris require msg_iov to be non-NULL. */</span>
+<a name="l00425"></a>00425                 dummy[0]       = <span class="charliteral">'\0'</span>;
+<a name="l00426"></a>00426                 vec.iov_base   = dummy;
+<a name="l00427"></a>00427                 vec.iov_len    = <span class="keyword">sizeof</span>(dummy);
+<a name="l00428"></a>00428                 msg.msg_iov    = &amp;vec;
+<a name="l00429"></a>00429                 msg.msg_iovlen = 1;
+<a name="l00430"></a>00430         
+<a name="l00431"></a>00431                 msg.msg_control    = (caddr_t) &amp;control_data;
+<a name="l00432"></a>00432                 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
+<a name="l00433"></a>00433                 msg.msg_flags      = 0;
+<a name="l00434"></a>00434                 
+<a name="l00435"></a>00435                 control_header = CMSG_FIRSTHDR(&amp;msg);
+<a name="l00436"></a>00436                 control_header-&gt;cmsg_level = SOL_SOCKET;
+<a name="l00437"></a>00437                 control_header-&gt;cmsg_type  = SCM_RIGHTS;
+<a name="l00438"></a>00438 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
+<a name="l00439"></a>00439 <span class="preprocessor"></span>                        control_header-&gt;cmsg_len = <span class="keyword">sizeof</span>(control_data);
+<a name="l00440"></a>00440                         control_data.fd = fileDescriptor;
+<a name="l00441"></a>00441 <span class="preprocessor">                #else</span>
+<a name="l00442"></a>00442 <span class="preprocessor"></span>                        control_header-&gt;cmsg_len = CMSG_LEN(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
+<a name="l00443"></a>00443                         memcpy(CMSG_DATA(control_header), &amp;fileDescriptor, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
+<a name="l00444"></a>00444 <span class="preprocessor">                #endif</span>
+<a name="l00445"></a>00445 <span class="preprocessor"></span>                
+<a name="l00446"></a>00446                 ret = syscalls::sendmsg(fd, &amp;msg, 0);
+<a name="l00447"></a>00447                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00448"></a>00448                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot send file descriptor with sendmsg()"</span>, errno);
+<a name="l00449"></a>00449                 }
+<a name="l00450"></a>00450                 
+<a name="l00451"></a>00451                 <span class="keywordflow">if</span> (negotiate) {
+<a name="l00452"></a>00452                         vector&lt;string&gt; args;
+<a name="l00453"></a>00453                         
+<a name="l00454"></a>00454                         <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
+<a name="l00455"></a>00455                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Unexpected end of stream encountered while post-negotiating a file descriptor"</span>);
+<a name="l00456"></a>00456                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">"got IO"</span>) {
+<a name="l00457"></a>00457                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"FD passing post-negotiation message expected."</span>);
+<a name="l00458"></a>00458                         }
+<a name="l00459"></a>00459                 }
+<a name="l00460"></a>00460         }
+<a name="l00461"></a>00461         <span class="comment"></span>
+<a name="l00462"></a>00462 <span class="comment">        /**</span>
+<a name="l00463"></a>00463 <span class="comment">         * Read an array message from the underlying file descriptor.</span>
+<a name="l00464"></a>00464 <span class="comment">         *</span>
+<a name="l00465"></a>00465 <span class="comment">         * @param args The message will be put in this variable.</span>
+<a name="l00466"></a>00466 <span class="comment">         * @return Whether end-of-file has been reached. If so, then the contents</span>
+<a name="l00467"></a>00467 <span class="comment">         *         of &lt;tt&gt;args&lt;/tt&gt; will be undefined.</span>
+<a name="l00468"></a>00468 <span class="comment">         * @throws SystemException If an error occured while receiving the message.</span>
+<a name="l00469"></a>00469 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00470"></a>00470 <span class="comment">         * @see write()</span>
+<a name="l00471"></a>00471 <span class="comment">         */</span>
+<a name="l00472"></a><a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e">00472</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(vector&lt;string&gt; &amp;args) {
+<a name="l00473"></a>00473                 uint16_t size;
+<a name="l00474"></a>00474                 <span class="keywordtype">int</span> ret;
+<a name="l00475"></a>00475                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
 <a name="l00476"></a>00476                 
-<a name="l00477"></a>00477                 <span class="keywordtype">string</span> buffer;
-<a name="l00478"></a>00478                 args.clear();
-<a name="l00479"></a>00479                 buffer.reserve(size);
-<a name="l00480"></a>00480                 <span class="keywordflow">while</span> (buffer.size() &lt; size) {
-<a name="l00481"></a>00481                         <span class="keywordtype">char</span> tmp[1024 * 8];
-<a name="l00482"></a>00482                         ret = <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, tmp, min(size - buffer.size(), <span class="keyword">sizeof</span>(tmp)));
-<a name="l00483"></a>00483                         <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00484"></a>00484                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
-<a name="l00485"></a>00485                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
-<a name="l00486"></a>00486                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00487"></a>00487                         }
-<a name="l00488"></a>00488                         buffer.append(tmp, ret);
-<a name="l00489"></a>00489                 }
-<a name="l00490"></a>00490                 
-<a name="l00491"></a>00491                 <span class="keywordflow">if</span> (!buffer.empty()) {
-<a name="l00492"></a>00492                         string::size_type start = 0, pos;
-<a name="l00493"></a>00493                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;const_buffer(buffer);
-<a name="l00494"></a>00494                         <span class="keywordflow">while</span> ((pos = const_buffer.find(<span class="charliteral">'\0'</span>, start)) != string::npos) {
-<a name="l00495"></a>00495                                 args.push_back(const_buffer.substr(start, pos - start));
-<a name="l00496"></a>00496                                 start = pos + 1;
-<a name="l00497"></a>00497                         }
-<a name="l00498"></a>00498                 }
-<a name="l00499"></a>00499                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-<a name="l00500"></a>00500         }
-<a name="l00501"></a>00501         <span class="comment"></span>
-<a name="l00502"></a>00502 <span class="comment">        /**</span>
-<a name="l00503"></a>00503 <span class="comment">         * Read a 32-bit big-endian unsigned integer from the underlying file descriptor.</span>
-<a name="l00504"></a>00504 <span class="comment">         *</span>
-<a name="l00505"></a>00505 <span class="comment">         * @param value Upon success, the read value will be stored in here.</span>
-<a name="l00506"></a>00506 <span class="comment">         * @param timeout A pointer to an integer, representing the maximum number of</span>
-<a name="l00507"></a>00507 <span class="comment">         *                milliseconds to spend on reading the entire integer.</span>
-<a name="l00508"></a>00508 <span class="comment">         *                A TimeoutException will be thrown if the timeout expires.</span>
-<a name="l00509"></a>00509 <span class="comment">         *                If no exception is thrown, the the amount of time spent on waiting</span>
-<a name="l00510"></a>00510 <span class="comment">         *                will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
-<a name="l00511"></a>00511 <span class="comment">         *                Pass NULL if you do not want to enforce any time limits.</span>
-<a name="l00512"></a>00512 <span class="comment">         * @return True if a value was read, false if EOF was reached before all data can be</span>
-<a name="l00513"></a>00513 <span class="comment">         *         read.</span>
-<a name="l00514"></a>00514 <span class="comment">         * @throws SystemException An error occurred while reading data from the file descriptor.</span>
-<a name="l00515"></a>00515 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00516"></a>00516 <span class="comment">         */</span>
-<a name="l00517"></a><a class="code" href="classPassenger_1_1MessageChannel.html#7b0c67852ea8ab455af75b1037c7f8b6">00517</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;value, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
-<a name="l00518"></a>00518                 uint32_t temp;
-<a name="l00519"></a>00519                 
-<a name="l00520"></a>00520                 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(&amp;temp, <span class="keyword">sizeof</span>(uint32_t), timeout)) {
-<a name="l00521"></a>00521                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00522"></a>00522                 } <span class="keywordflow">else</span> {
-<a name="l00523"></a>00523                         value = ntohl(temp);
-<a name="l00524"></a>00524                         <span class="keywordflow">return</span> <span class="keyword">true</span>;
-<a name="l00525"></a>00525                 }
-<a name="l00526"></a>00526         }
-<a name="l00527"></a>00527         <span class="comment"></span>
-<a name="l00528"></a>00528 <span class="comment">        /**</span>
-<a name="l00529"></a>00529 <span class="comment">         * Read a scalar message from the underlying file descriptor.</span>
-<a name="l00530"></a>00530 <span class="comment">         *</span>
-<a name="l00531"></a>00531 <span class="comment">         * @param output The message will be put in here.</span>
-<a name="l00532"></a>00532 <span class="comment">         * @param maxSize The maximum number of bytes that may be read. If the</span>
-<a name="l00533"></a>00533 <span class="comment">         *                scalar to read is larger than this, then a SecurityException</span>
-<a name="l00534"></a>00534 <span class="comment">         *                will be thrown. Set to 0 for no size limit.</span>
-<a name="l00535"></a>00535 <span class="comment">         * @param timeout A pointer to an integer, representing the maximum number of</span>
-<a name="l00536"></a>00536 <span class="comment">         *                milliseconds to spend on reading the entire scalar.</span>
-<a name="l00537"></a>00537 <span class="comment">         *                A TimeoutException will be thrown if unable to read the entire</span>
-<a name="l00538"></a>00538 <span class="comment">         *                scalar within this time period.</span>
-<a name="l00539"></a>00539 <span class="comment">         *                If no exception is thrown, the the amount of time spent on waiting</span>
-<a name="l00540"></a>00540 <span class="comment">         *                will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
-<a name="l00541"></a>00541 <span class="comment">         *                Pass NULL if you do not want to enforce any time limits.</span>
-<a name="l00542"></a>00542 <span class="comment">         * @returns Whether end-of-file was reached during reading.</span>
-<a name="l00543"></a>00543 <span class="comment">         * @throws SystemException An error occured while reading data from the file descriptor.</span>
-<a name="l00544"></a>00544 <span class="comment">         * @throws SecurityException There is more data to read than allowed by maxSize.</span>
-<a name="l00545"></a>00545 <span class="comment">         * @throws TimeoutException Unable to read the entire scalar within &lt;tt&gt;timeout&lt;/tt&gt;</span>
-<a name="l00546"></a>00546 <span class="comment">         *                          milliseconds.</span>
-<a name="l00547"></a>00547 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00548"></a>00548 <span class="comment">         * @see writeScalar()</span>
-<a name="l00549"></a>00549 <span class="comment">         */</span>
-<a name="l00550"></a><a class="code" href="classPassenger_1_1MessageChannel.html#1f3cf672b566166ed920c2bba4d19604">00550</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(<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="l00551"></a>00551                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
-<a name="l00552"></a>00552                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> remaining;
-<a name="l00553"></a>00553                 
-<a name="l00554"></a>00554                 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(size, timeout)) {
-<a name="l00555"></a>00555                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00556"></a>00556                 }
-<a name="l00557"></a>00557                 
-<a name="l00558"></a>00558                 <span class="keywordflow">if</span> (maxSize != 0 &amp;&amp; size &gt; maxSize) {
-<a name="l00559"></a>00559                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a>(<span class="stringliteral">"There is more data available than is allowed by the size limit."</span>);
-<a name="l00560"></a>00560                 }
-<a name="l00561"></a>00561                 
-<a name="l00562"></a>00562                 output.clear();
-<a name="l00563"></a>00563                 output.reserve(size);
-<a name="l00564"></a>00564                 remaining = size;
-<a name="l00565"></a>00565                 <span class="keywordflow">if</span> (OXT_LIKELY(remaining &gt; 0)) {
-<a name="l00566"></a>00566                         <span class="keywordtype">char</span> buf[1024 * 32];
-<a name="l00567"></a>00567                         <span class="comment">// Wipe the buffer when we're done; it might contain sensitive data.</span>
-<a name="l00568"></a>00568                         <a class="code" href="classPassenger_1_1MemZeroGuard.html" title="Fills the given memory space or string with zeroes when a MemoryZeroGuard object...">MemZeroGuard</a> g(buf, <span class="keyword">sizeof</span>(buf));
-<a name="l00569"></a>00569                         
-<a name="l00570"></a>00570                         <span class="keywordflow">while</span> (remaining &gt; 0) {
-<a name="l00571"></a>00571                                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize = min((<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) <span class="keyword">sizeof</span>(buf), remaining);
-<a name="l00572"></a>00572                                 
-<a name="l00573"></a>00573                                 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(buf, blockSize, timeout)) {
-<a name="l00574"></a>00574                                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00575"></a>00575                                 }
-<a name="l00576"></a>00576                                 output.append(buf, blockSize);
-<a name="l00577"></a>00577                                 remaining -= blockSize;
-<a name="l00578"></a>00578                         }
-<a name="l00579"></a>00579                 }
-<a name="l00580"></a>00580                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-<a name="l00581"></a>00581         }
-<a name="l00582"></a>00582         <span class="comment"></span>
-<a name="l00583"></a>00583 <span class="comment">        /**</span>
-<a name="l00584"></a>00584 <span class="comment">         * Read exactly &lt;tt&gt;size&lt;/tt&gt; bytes of data from the underlying file descriptor,</span>
-<a name="l00585"></a>00585 <span class="comment">         * and put the result in &lt;tt&gt;buf&lt;/tt&gt;. If end-of-file has been reached, or if</span>
-<a name="l00586"></a>00586 <span class="comment">         * end-of-file was encountered before &lt;tt&gt;size&lt;/tt&gt; bytes have been read, then</span>
-<a name="l00587"></a>00587 <span class="comment">         * &lt;tt&gt;false&lt;/tt&gt; will be returned. Otherwise (i.e. if the read was successful),</span>
-<a name="l00588"></a>00588 <span class="comment">         * &lt;tt&gt;true&lt;/tt&gt; will be returned.</span>
-<a name="l00589"></a>00589 <span class="comment">         *</span>
-<a name="l00590"></a>00590 <span class="comment">         * @param buf The buffer to place the read data in. This buffer must be at least</span>
-<a name="l00591"></a>00591 <span class="comment">         *            &lt;tt&gt;size&lt;/tt&gt; bytes long.</span>
-<a name="l00592"></a>00592 <span class="comment">         * @param size The number of bytes to read.</span>
-<a name="l00593"></a>00593 <span class="comment">         * @param timeout A pointer to an integer, which specifies the maximum number of</span>
-<a name="l00594"></a>00594 <span class="comment">         *                milliseconds that may be spent on reading the &lt;tt&gt;size&lt;/tt&gt; bytes</span>
-<a name="l00595"></a>00595 <span class="comment">         *                of data. If the timeout expired then TimeoutException will be</span>
-<a name="l00596"></a>00596 <span class="comment">         *                thrown.</span>
-<a name="l00597"></a>00597 <span class="comment">         *                If this function returns without throwing an exception, then the</span>
-<a name="l00598"></a>00598 <span class="comment">         *                total number of milliseconds spent on reading will be deducted</span>
-<a name="l00599"></a>00599 <span class="comment">         *                from &lt;tt&gt;timeout&lt;/tt&gt;.</span>
-<a name="l00600"></a>00600 <span class="comment">         *                Pass NULL if you do not want to enforce a timeout.</span>
-<a name="l00601"></a>00601 <span class="comment">         * @return Whether reading was successful or whether EOF was reached.</span>
-<a name="l00602"></a>00602 <span class="comment">         * @pre buf != NULL</span>
-<a name="l00603"></a>00603 <span class="comment">         * @throws SystemException Something went wrong during reading.</span>
-<a name="l00604"></a>00604 <span class="comment">         * @throws TimeoutException Unable to read &lt;tt&gt;size&lt;/tt&gt; bytes of data within</span>
-<a name="l00605"></a>00605 <span class="comment">         *                          &lt;tt&gt;timeout&lt;/tt&gt; milliseconds.</span>
-<a name="l00606"></a>00606 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00607"></a>00607 <span class="comment">         * @see writeRaw()</span>
-<a name="l00608"></a>00608 <span class="comment">         */</span>
-<a name="l00609"></a><a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a">00609</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
-<a name="l00610"></a>00610                 ssize_t ret;
-<a name="l00611"></a>00611                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
-<a name="l00612"></a>00612                 
-<a name="l00613"></a>00613                 <span class="keywordflow">while</span> (alreadyRead &lt; size) {
-<a name="l00614"></a>00614                         <span class="keywordflow">if</span> (timeout != NULL &amp;&amp; !<a class="code" href="classPassenger_1_1MessageChannel.html#c2407ed109785b49794989507c570149" title="Waits at most *timeout milliseconds for the file descriptor to become readable.">waitUntilReadable</a>(timeout)) {
-<a name="l00615"></a>00615                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1TimeoutException.html" title="An exception indicating that some timeout expired.">TimeoutException</a>(<span class="stringliteral">"Cannot read enough data within the specified timeout."</span>);
-<a name="l00616"></a>00616                         }
-<a name="l00617"></a>00617                         ret = <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) buf + alreadyRead, size - alreadyRead);
-<a name="l00618"></a>00618                         <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00619"></a>00619                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
-<a name="l00620"></a>00620                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
-<a name="l00621"></a>00621                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
-<a name="l00622"></a>00622                         } <span class="keywordflow">else</span> {
-<a name="l00623"></a>00623                                 alreadyRead += ret;
-<a name="l00624"></a>00624                         }
-<a name="l00625"></a>00625                 }
-<a name="l00626"></a>00626                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-<a name="l00627"></a>00627         }
-<a name="l00628"></a>00628         <span class="comment"></span>
-<a name="l00629"></a>00629 <span class="comment">        /**</span>
-<a name="l00630"></a>00630 <span class="comment">         * Waits at most &lt;tt&gt;*timeout&lt;/tt&gt; milliseconds for the file descriptor to become readable.</span>
-<a name="l00631"></a>00631 <span class="comment">         * Returns true if it become readable within the timeout, false if the timeout expired.</span>
-<a name="l00632"></a>00632 <span class="comment">         *</span>
-<a name="l00633"></a>00633 <span class="comment">         * &lt;tt&gt;*timeout&lt;/tt&gt; may be 0, in which case this method will check whether the file</span>
-<a name="l00634"></a>00634 <span class="comment">         * descriptor is readable, and immediately returns without waiting.</span>
-<a name="l00635"></a>00635 <span class="comment">         *</span>
-<a name="l00636"></a>00636 <span class="comment">         * If no exception is thrown, this method deducts the number of milliseconds that has</span>
-<a name="l00637"></a>00637 <span class="comment">         * passed from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
-<a name="l00638"></a>00638 <span class="comment">         *</span>
-<a name="l00639"></a>00639 <span class="comment">         * @throws SystemException</span>
-<a name="l00640"></a>00640 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00641"></a>00641 <span class="comment">         */</span>
-<a name="l00642"></a><a class="code" href="classPassenger_1_1MessageChannel.html#c2407ed109785b49794989507c570149">00642</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#c2407ed109785b49794989507c570149" title="Waits at most *timeout milliseconds for the file descriptor to become readable.">waitUntilReadable</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout) {
-<a name="l00643"></a>00643                 fd_set fds;
-<a name="l00644"></a>00644                 <span class="keyword">struct </span>timeval tv;
-<a name="l00645"></a>00645                 <span class="keywordtype">int</span> ret;
-<a name="l00646"></a>00646                 
-<a name="l00647"></a>00647                 FD_ZERO(&amp;fds);
-<a name="l00648"></a>00648                 FD_SET(fd, &amp;fds);
-<a name="l00649"></a>00649                 tv.tv_sec  = *timeout / 1000;
-<a name="l00650"></a>00650                 tv.tv_usec = *timeout % 1000 * 1000;
-<a name="l00651"></a>00651                 
-<a name="l00652"></a>00652                 Timer timer;
-<a name="l00653"></a>00653                 ret = syscalls::select(fd + 1, &amp;fds, NULL, NULL, &amp;tv);
-<a name="l00654"></a>00654                 <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00655"></a>00655                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"select() failed"</span>, errno);
-<a name="l00656"></a>00656                 } <span class="keywordflow">else</span> {
-<a name="l00657"></a>00657                         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> elapsed = timer.elapsed();
-<a name="l00658"></a>00658                         <span class="keywordflow">if</span> (elapsed &gt; *timeout) {
-<a name="l00659"></a>00659                                 *timeout = 0;
-<a name="l00660"></a>00660                         } <span class="keywordflow">else</span> {
-<a name="l00661"></a>00661                                 *timeout -= elapsed;
-<a name="l00662"></a>00662                         }
-<a name="l00663"></a>00663                         <span class="keywordflow">return</span> ret != 0;
-<a name="l00664"></a>00664                 }
-<a name="l00665"></a>00665         }
-<a name="l00666"></a>00666         <span class="comment"></span>
-<a name="l00667"></a>00667 <span class="comment">        /**</span>
-<a name="l00668"></a>00668 <span class="comment">         * Receive a file descriptor, which had been passed over the underlying</span>
-<a name="l00669"></a>00669 <span class="comment">         * file descriptor.</span>
-<a name="l00670"></a>00670 <span class="comment">         *</span>
-<a name="l00671"></a>00671 <span class="comment">         * @param negotiate See Ruby's MessageChannel#send_io method's comments.</span>
-<a name="l00672"></a>00672 <span class="comment">         * @return The passed file descriptor.</span>
-<a name="l00673"></a>00673 <span class="comment">         * @throws SystemException If something went wrong during the</span>
-<a name="l00674"></a>00674 <span class="comment">         *            receiving of a file descriptor. Perhaps the underlying</span>
-<a name="l00675"></a>00675 <span class="comment">         *            file descriptor isn't a Unix socket.</span>
-<a name="l00676"></a>00676 <span class="comment">         * @throws IOException Whatever was received doesn't seem to be a</span>
-<a name="l00677"></a>00677 <span class="comment">         *            file descriptor.</span>
-<a name="l00678"></a>00678 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00679"></a>00679 <span class="comment">         */</span>
-<a name="l00680"></a><a class="code" href="classPassenger_1_1MessageChannel.html#1a28ba9d078f38f2831673092ac9dcbc">00680</a>         <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#1a28ba9d078f38f2831673092ac9dcbc" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(<span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
-<a name="l00681"></a>00681                 <span class="keywordflow">if</span> (negotiate) {
-<a name="l00682"></a>00682                         <a class="code" href="classPassenger_1_1MessageChannel.html#150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">"pass IO"</span>, NULL);
-<a name="l00683"></a>00683                 }
-<a name="l00684"></a>00684                 
-<a name="l00685"></a>00685                 <span class="keyword">struct </span>msghdr msg;
-<a name="l00686"></a>00686                 <span class="keyword">struct </span>iovec vec;
-<a name="l00687"></a>00687                 <span class="keywordtype">char</span> dummy[1];
-<a name="l00688"></a>00688 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
-<a name="l00689"></a>00689 <span class="preprocessor"></span>                        <span class="comment">// File descriptor passing macros (CMSG_*) seem to be broken</span>
-<a name="l00690"></a>00690                         <span class="comment">// on 64-bit MacOS X. This structure works around the problem.</span>
-<a name="l00691"></a>00691                         <span class="keyword">struct </span>{
-<a name="l00692"></a>00692                                 <span class="keyword">struct </span>cmsghdr header;
-<a name="l00693"></a>00693                                 <span class="keywordtype">int</span> fd;
-<a name="l00694"></a>00694                         } control_data;
-<a name="l00695"></a>00695 <span class="preprocessor">                        #define EXPECTED_CMSG_LEN sizeof(control_data)</span>
-<a name="l00696"></a>00696 <span class="preprocessor"></span><span class="preprocessor">                #else</span>
-<a name="l00697"></a>00697 <span class="preprocessor"></span>                        <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
-<a name="l00698"></a>00698 <span class="preprocessor">                        #define EXPECTED_CMSG_LEN CMSG_LEN(sizeof(int))</span>
-<a name="l00699"></a>00699 <span class="preprocessor"></span><span class="preprocessor">                #endif</span>
-<a name="l00700"></a>00700 <span class="preprocessor"></span>                <span class="keyword">struct </span>cmsghdr *control_header;
-<a name="l00701"></a>00701                 <span class="keywordtype">int</span> ret;
-<a name="l00702"></a>00702 
-<a name="l00703"></a>00703                 msg.msg_name    = NULL;
-<a name="l00704"></a>00704                 msg.msg_namelen = 0;
-<a name="l00705"></a>00705                 
-<a name="l00706"></a>00706                 dummy[0]       = <span class="charliteral">'\0'</span>;
-<a name="l00707"></a>00707                 vec.iov_base   = dummy;
-<a name="l00708"></a>00708                 vec.iov_len    = <span class="keyword">sizeof</span>(dummy);
-<a name="l00709"></a>00709                 msg.msg_iov    = &amp;vec;
-<a name="l00710"></a>00710                 msg.msg_iovlen = 1;
-<a name="l00711"></a>00711 
-<a name="l00712"></a>00712                 msg.msg_control    = (caddr_t) &amp;control_data;
-<a name="l00713"></a>00713                 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
-<a name="l00714"></a>00714                 msg.msg_flags      = 0;
-<a name="l00715"></a>00715                 
-<a name="l00716"></a>00716                 ret = syscalls::recvmsg(fd, &amp;msg, 0);
-<a name="l00717"></a>00717                 <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00718"></a>00718                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot read file descriptor with recvmsg()"</span>, errno);
-<a name="l00719"></a>00719                 }
-<a name="l00720"></a>00720                 
-<a name="l00721"></a>00721                 control_header = CMSG_FIRSTHDR(&amp;msg);
-<a name="l00722"></a>00722                 <span class="keywordflow">if</span> (control_header == NULL) {
-<a name="l00723"></a>00723                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"No valid file descriptor received."</span>);
-<a name="l00724"></a>00724                 }
-<a name="l00725"></a>00725                 <span class="keywordflow">if</span> (control_header-&gt;cmsg_len   != EXPECTED_CMSG_LEN
-<a name="l00726"></a>00726                  || control_header-&gt;cmsg_level != SOL_SOCKET
-<a name="l00727"></a>00727                  || control_header-&gt;cmsg_type  != SCM_RIGHTS) {
-<a name="l00728"></a>00728                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"No valid file descriptor received."</span>);
-<a name="l00729"></a>00729                 }
-<a name="l00730"></a>00730 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
-<a name="l00731"></a>00731 <span class="preprocessor"></span>                        <span class="keywordflow">return</span> control_data.fd;
-<a name="l00732"></a>00732 <span class="preprocessor">                #else</span>
-<a name="l00733"></a>00733 <span class="preprocessor"></span>                        <span class="keywordflow">return</span> *((<span class="keywordtype">int</span> *) CMSG_DATA(control_header));
-<a name="l00734"></a>00734 <span class="preprocessor">                #endif</span>
-<a name="l00735"></a>00735 <span class="preprocessor"></span>        }
-<a name="l00736"></a>00736         <span class="comment"></span>
-<a name="l00737"></a>00737 <span class="comment">        /**</span>
-<a name="l00738"></a>00738 <span class="comment">         * Set the timeout value for reading data from this channel.</span>
-<a name="l00739"></a>00739 <span class="comment">         * If no data can be read within the timeout period, then a</span>
-<a name="l00740"></a>00740 <span class="comment">         * SystemException will be thrown by one of the read methods,</span>
-<a name="l00741"></a>00741 <span class="comment">         * with error code EAGAIN or EWOULDBLOCK.</span>
-<a name="l00742"></a>00742 <span class="comment">         *</span>
-<a name="l00743"></a>00743 <span class="comment">         * @param msec The timeout, in milliseconds. If 0 is given,</span>
-<a name="l00744"></a>00744 <span class="comment">         *             there will be no timeout.</span>
-<a name="l00745"></a>00745 <span class="comment">         * @throws SystemException Cannot set the timeout.</span>
-<a name="l00746"></a>00746 <span class="comment">         */</span>
-<a name="l00747"></a><a class="code" href="classPassenger_1_1MessageChannel.html#eb69bffbbb148c9bc8662e20b416c4e2">00747</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#eb69bffbbb148c9bc8662e20b416c4e2" title="Set the timeout value for reading data from this channel.">setReadTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
-<a name="l00748"></a>00748                 <span class="comment">// See the comment for setWriteTimeout().</span>
-<a name="l00749"></a>00749                 <span class="keyword">struct </span>timeval tv;
-<a name="l00750"></a>00750                 <span class="keywordtype">int</span> ret;
-<a name="l00751"></a>00751                 
-<a name="l00752"></a>00752                 tv.tv_sec = msec / 1000;
-<a name="l00753"></a>00753                 tv.tv_usec = msec % 1000 * 1000;
-<a name="l00754"></a>00754                 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO,
-<a name="l00755"></a>00755                         &amp;tv, <span class="keyword">sizeof</span>(tv));
-<a name="l00756"></a>00756 <span class="preprocessor">                #ifndef __SOLARIS__</span>
-<a name="l00757"></a>00757 <span class="preprocessor"></span>                        <span class="comment">// SO_RCVTIMEO is unimplemented and returns an error on Solaris</span>
-<a name="l00758"></a>00758                         <span class="comment">// 9 and 10 SPARC.  Seems to work okay without it.</span>
-<a name="l00759"></a>00759                         <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00760"></a>00760                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot set read timeout for socket"</span>, errno);
-<a name="l00761"></a>00761                         }
-<a name="l00762"></a>00762 <span class="preprocessor">                #endif</span>
-<a name="l00763"></a>00763 <span class="preprocessor"></span>        }
-<a name="l00764"></a>00764         <span class="comment"></span>
-<a name="l00765"></a>00765 <span class="comment">        /**</span>
-<a name="l00766"></a>00766 <span class="comment">         * Set the timeout value for writing data to this channel.</span>
-<a name="l00767"></a>00767 <span class="comment">         * If no data can be written within the timeout period, then a</span>
-<a name="l00768"></a>00768 <span class="comment">         * SystemException will be thrown, with error code EAGAIN or</span>
-<a name="l00769"></a>00769 <span class="comment">         * EWOULDBLOCK.</span>
-<a name="l00770"></a>00770 <span class="comment">         *</span>
-<a name="l00771"></a>00771 <span class="comment">         * @param msec The timeout, in milliseconds. If 0 is given,</span>
-<a name="l00772"></a>00772 <span class="comment">         *             there will be no timeout.</span>
-<a name="l00773"></a>00773 <span class="comment">         * @throws SystemException Cannot set the timeout.</span>
-<a name="l00774"></a>00774 <span class="comment">         */</span>
-<a name="l00775"></a><a class="code" href="classPassenger_1_1MessageChannel.html#77c5d7c47f387cf43992ebeb14e3c6c7">00775</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#77c5d7c47f387cf43992ebeb14e3c6c7" title="Set the timeout value for writing data to this channel.">setWriteTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
-<a name="l00776"></a>00776                 <span class="comment">// People say that SO_RCVTIMEO/SO_SNDTIMEO are unreliable and</span>
-<a name="l00777"></a>00777                 <span class="comment">// not well-implemented on all platforms.</span>
-<a name="l00778"></a>00778                 <span class="comment">// http://www.developerweb.net/forum/archive/index.php/t-3439.html</span>
-<a name="l00779"></a>00779                 <span class="comment">// That's why we use APR's timeout facilities as well (see Hooks.cpp).</span>
-<a name="l00780"></a>00780                 <span class="keyword">struct </span>timeval tv;
-<a name="l00781"></a>00781                 <span class="keywordtype">int</span> ret;
-<a name="l00782"></a>00782                 
-<a name="l00783"></a>00783                 tv.tv_sec = msec / 1000;
-<a name="l00784"></a>00784                 tv.tv_usec = msec % 1000 * 1000;
-<a name="l00785"></a>00785                 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO,
-<a name="l00786"></a>00786                         &amp;tv, <span class="keyword">sizeof</span>(tv));
-<a name="l00787"></a>00787 <span class="preprocessor">                #ifndef __SOLARIS__</span>
-<a name="l00788"></a>00788 <span class="preprocessor"></span>                        <span class="comment">// SO_SNDTIMEO is unimplemented and returns an error on Solaris</span>
-<a name="l00789"></a>00789                         <span class="comment">// 9 and 10 SPARC.  Seems to work okay without it.</span>
-<a name="l00790"></a>00790                         <span class="keywordflow">if</span> (ret == -1) {
-<a name="l00791"></a>00791                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot set read timeout for socket"</span>, errno);
-<a name="l00792"></a>00792                         }
-<a name="l00793"></a>00793 <span class="preprocessor">                #endif</span>
-<a name="l00794"></a>00794 <span class="preprocessor"></span>        }
-<a name="l00795"></a>00795 };
-<a name="l00796"></a>00796 
-<a name="l00797"></a>00797 } <span class="comment">// namespace Passenger</span>
-<a name="l00798"></a>00798 
-<a name="l00799"></a>00799 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_CHANNEL_H_ */</span>
+<a name="l00477"></a>00477                 <span class="keywordflow">do</span> {
+<a name="l00478"></a>00478                         ret = <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) &amp;size + alreadyRead, <span class="keyword">sizeof</span>(size) - alreadyRead);
+<a name="l00479"></a>00479                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00480"></a>00480                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
+<a name="l00481"></a>00481                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
+<a name="l00482"></a>00482                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00483"></a>00483                         }
+<a name="l00484"></a>00484                         alreadyRead += ret;
+<a name="l00485"></a>00485                 } <span class="keywordflow">while</span> (alreadyRead &lt; <span class="keyword">sizeof</span>(size));
+<a name="l00486"></a>00486                 size = ntohs(size);
+<a name="l00487"></a>00487                 
+<a name="l00488"></a>00488                 <span class="keywordtype">string</span> buffer;
+<a name="l00489"></a>00489                 args.clear();
+<a name="l00490"></a>00490                 buffer.reserve(size);
+<a name="l00491"></a>00491                 <span class="keywordflow">while</span> (buffer.size() &lt; size) {
+<a name="l00492"></a>00492                         <span class="keywordtype">char</span> tmp[1024 * 8];
+<a name="l00493"></a>00493                         ret = <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, tmp, min(size - buffer.size(), <span class="keyword">sizeof</span>(tmp)));
+<a name="l00494"></a>00494                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00495"></a>00495                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
+<a name="l00496"></a>00496                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
+<a name="l00497"></a>00497                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00498"></a>00498                         }
+<a name="l00499"></a>00499                         buffer.append(tmp, ret);
+<a name="l00500"></a>00500                 }
+<a name="l00501"></a>00501                 
+<a name="l00502"></a>00502                 <span class="keywordflow">if</span> (!buffer.empty()) {
+<a name="l00503"></a>00503                         string::size_type start = 0, pos;
+<a name="l00504"></a>00504                         <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;const_buffer(buffer);
+<a name="l00505"></a>00505                         <span class="keywordflow">while</span> ((pos = const_buffer.find(<span class="charliteral">'\0'</span>, start)) != string::npos) {
+<a name="l00506"></a>00506                                 args.push_back(const_buffer.substr(start, pos - start));
+<a name="l00507"></a>00507                                 start = pos + 1;
+<a name="l00508"></a>00508                         }
+<a name="l00509"></a>00509                 }
+<a name="l00510"></a>00510                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00511"></a>00511         }
+<a name="l00512"></a>00512         <span class="comment"></span>
+<a name="l00513"></a>00513 <span class="comment">        /**</span>
+<a name="l00514"></a>00514 <span class="comment">         * Read a 32-bit big-endian unsigned integer from the underlying file descriptor.</span>
+<a name="l00515"></a>00515 <span class="comment">         *</span>
+<a name="l00516"></a>00516 <span class="comment">         * @param value Upon success, the read value will be stored in here.</span>
+<a name="l00517"></a>00517 <span class="comment">         * @param timeout A pointer to an integer, representing the maximum number of</span>
+<a name="l00518"></a>00518 <span class="comment">         *                milliseconds to spend on reading the entire integer.</span>
+<a name="l00519"></a>00519 <span class="comment">         *                A TimeoutException will be thrown if the timeout expires.</span>
+<a name="l00520"></a>00520 <span class="comment">         *                If no exception is thrown, the the amount of time spent on waiting</span>
+<a name="l00521"></a>00521 <span class="comment">         *                will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
+<a name="l00522"></a>00522 <span class="comment">         *                Pass NULL if you do not want to enforce any time limits.</span>
+<a name="l00523"></a>00523 <span class="comment">         * @return True if a value was read, false if EOF was reached before all data can be</span>
+<a name="l00524"></a>00524 <span class="comment">         *         read.</span>
+<a name="l00525"></a>00525 <span class="comment">         * @throws SystemException An error occurred while reading data from the file descriptor.</span>
+<a name="l00526"></a>00526 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00527"></a>00527 <span class="comment">         */</span>
+<a name="l00528"></a><a class="code" href="classPassenger_1_1MessageChannel.html#7b0c67852ea8ab455af75b1037c7f8b6">00528</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;value, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
+<a name="l00529"></a>00529                 uint32_t temp;
+<a name="l00530"></a>00530                 
+<a name="l00531"></a>00531                 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(&amp;temp, <span class="keyword">sizeof</span>(uint32_t), timeout)) {
+<a name="l00532"></a>00532                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00533"></a>00533                 } <span class="keywordflow">else</span> {
+<a name="l00534"></a>00534                         value = ntohl(temp);
+<a name="l00535"></a>00535                         <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00536"></a>00536                 }
+<a name="l00537"></a>00537         }
+<a name="l00538"></a>00538         <span class="comment"></span>
+<a name="l00539"></a>00539 <span class="comment">        /**</span>
+<a name="l00540"></a>00540 <span class="comment">         * Read a scalar message from the underlying file descriptor.</span>
+<a name="l00541"></a>00541 <span class="comment">         *</span>
+<a name="l00542"></a>00542 <span class="comment">         * @param output The message will be put in here.</span>
+<a name="l00543"></a>00543 <span class="comment">         * @param maxSize The maximum number of bytes that may be read. If the</span>
+<a name="l00544"></a>00544 <span class="comment">         *                scalar to read is larger than this, then a SecurityException</span>
+<a name="l00545"></a>00545 <span class="comment">         *                will be thrown. Set to 0 for no size limit.</span>
+<a name="l00546"></a>00546 <span class="comment">         * @param timeout A pointer to an integer, representing the maximum number of</span>
+<a name="l00547"></a>00547 <span class="comment">         *                milliseconds to spend on reading the entire scalar.</span>
+<a name="l00548"></a>00548 <span class="comment">         *                A TimeoutException will be thrown if unable to read the entire</span>
+<a name="l00549"></a>00549 <span class="comment">         *                scalar within this time period.</span>
+<a name="l00550"></a>00550 <span class="comment">         *                If no exception is thrown, the the amount of time spent on waiting</span>
+<a name="l00551"></a>00551 <span class="comment">         *                will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
+<a name="l00552"></a>00552 <span class="comment">         *                Pass NULL if you do not want to enforce any time limits.</span>
+<a name="l00553"></a>00553 <span class="comment">         * @returns Whether end-of-file was reached during reading.</span>
+<a name="l00554"></a>00554 <span class="comment">         * @throws SystemException An error occured while reading data from the file descriptor.</span>
+<a name="l00555"></a>00555 <span class="comment">         * @throws SecurityException There is more data to read than allowed by maxSize.</span>
+<a name="l00556"></a>00556 <span class="comment">         * @throws TimeoutException Unable to read the entire scalar within &lt;tt&gt;timeout&lt;/tt&gt;</span>
+<a name="l00557"></a>00557 <span class="comment">         *                          milliseconds.</span>
+<a name="l00558"></a>00558 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00559"></a>00559 <span class="comment">         * @see writeScalar()</span>
+<a name="l00560"></a>00560 <span class="comment">         */</span>
+<a name="l00561"></a><a class="code" href="classPassenger_1_1MessageChannel.html#1f3cf672b566166ed920c2bba4d19604">00561</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(<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="l00562"></a>00562                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
+<a name="l00563"></a>00563                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> remaining;
+<a name="l00564"></a>00564                 
+<a name="l00565"></a>00565                 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(size, timeout)) {
+<a name="l00566"></a>00566                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00567"></a>00567                 }
+<a name="l00568"></a>00568                 
+<a name="l00569"></a>00569                 <span class="keywordflow">if</span> (maxSize != 0 &amp;&amp; size &gt; maxSize) {
+<a name="l00570"></a>00570                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a>(<span class="stringliteral">"There is more data available than is allowed by the size limit."</span>);
+<a name="l00571"></a>00571                 }
+<a name="l00572"></a>00572                 
+<a name="l00573"></a>00573                 output.clear();
+<a name="l00574"></a>00574                 output.reserve(size);
+<a name="l00575"></a>00575                 remaining = size;
+<a name="l00576"></a>00576                 <span class="keywordflow">if</span> (OXT_LIKELY(remaining &gt; 0)) {
+<a name="l00577"></a>00577                         <span class="keywordtype">char</span> buf[1024 * 32];
+<a name="l00578"></a>00578                         <span class="comment">// Wipe the buffer when we're done; it might contain sensitive data.</span>
+<a name="l00579"></a>00579                         <a class="code" href="classPassenger_1_1MemZeroGuard.html" title="Fills the given memory space or string with zeroes when a MemoryZeroGuard object...">MemZeroGuard</a> g(buf, <span class="keyword">sizeof</span>(buf));
+<a name="l00580"></a>00580                         
+<a name="l00581"></a>00581                         <span class="keywordflow">while</span> (remaining &gt; 0) {
+<a name="l00582"></a>00582                                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize = min((<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) <span class="keyword">sizeof</span>(buf), remaining);
+<a name="l00583"></a>00583                                 
+<a name="l00584"></a>00584                                 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(buf, blockSize, timeout)) {
+<a name="l00585"></a>00585                                         <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00586"></a>00586                                 }
+<a name="l00587"></a>00587                                 output.append(buf, blockSize);
+<a name="l00588"></a>00588                                 remaining -= blockSize;
+<a name="l00589"></a>00589                         }
+<a name="l00590"></a>00590                 }
+<a name="l00591"></a>00591                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00592"></a>00592         }
+<a name="l00593"></a>00593         <span class="comment"></span>
+<a name="l00594"></a>00594 <span class="comment">        /**</span>
+<a name="l00595"></a>00595 <span class="comment">         * Read exactly &lt;tt&gt;size&lt;/tt&gt; bytes of data from the underlying file descriptor,</span>
+<a name="l00596"></a>00596 <span class="comment">         * and put the result in &lt;tt&gt;buf&lt;/tt&gt;. If end-of-file has been reached, or if</span>
+<a name="l00597"></a>00597 <span class="comment">         * end-of-file was encountered before &lt;tt&gt;size&lt;/tt&gt; bytes have been read, then</span>
+<a name="l00598"></a>00598 <span class="comment">         * &lt;tt&gt;false&lt;/tt&gt; will be returned. Otherwise (i.e. if the read was successful),</span>
+<a name="l00599"></a>00599 <span class="comment">         * &lt;tt&gt;true&lt;/tt&gt; will be returned.</span>
+<a name="l00600"></a>00600 <span class="comment">         *</span>
+<a name="l00601"></a>00601 <span class="comment">         * @param buf The buffer to place the read data in. This buffer must be at least</span>
+<a name="l00602"></a>00602 <span class="comment">         *            &lt;tt&gt;size&lt;/tt&gt; bytes long.</span>
+<a name="l00603"></a>00603 <span class="comment">         * @param size The number of bytes to read.</span>
+<a name="l00604"></a>00604 <span class="comment">         * @param timeout A pointer to an integer, which specifies the maximum number of</span>
+<a name="l00605"></a>00605 <span class="comment">         *                milliseconds that may be spent on reading the &lt;tt&gt;size&lt;/tt&gt; bytes</span>
+<a name="l00606"></a>00606 <span class="comment">         *                of data. If the timeout expired then TimeoutException will be</span>
+<a name="l00607"></a>00607 <span class="comment">         *                thrown.</span>
+<a name="l00608"></a>00608 <span class="comment">         *                If this function returns without throwing an exception, then the</span>
+<a name="l00609"></a>00609 <span class="comment">         *                total number of milliseconds spent on reading will be deducted</span>
+<a name="l00610"></a>00610 <span class="comment">         *                from &lt;tt&gt;timeout&lt;/tt&gt;.</span>
+<a name="l00611"></a>00611 <span class="comment">         *                Pass NULL if you do not want to enforce a timeout.</span>
+<a name="l00612"></a>00612 <span class="comment">         * @return Whether reading was successful or whether EOF was reached.</span>
+<a name="l00613"></a>00613 <span class="comment">         * @pre buf != NULL</span>
+<a name="l00614"></a>00614 <span class="comment">         * @throws SystemException Something went wrong during reading.</span>
+<a name="l00615"></a>00615 <span class="comment">         * @throws TimeoutException Unable to read &lt;tt&gt;size&lt;/tt&gt; bytes of data within</span>
+<a name="l00616"></a>00616 <span class="comment">         *                          &lt;tt&gt;timeout&lt;/tt&gt; milliseconds.</span>
+<a name="l00617"></a>00617 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00618"></a>00618 <span class="comment">         * @see writeRaw()</span>
+<a name="l00619"></a>00619 <span class="comment">         */</span>
+<a name="l00620"></a><a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a">00620</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#b471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
+<a name="l00621"></a>00621                 ssize_t ret;
+<a name="l00622"></a>00622                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
+<a name="l00623"></a>00623                 
+<a name="l00624"></a>00624                 <span class="keywordflow">while</span> (alreadyRead &lt; size) {
+<a name="l00625"></a>00625                         <span class="keywordflow">if</span> (timeout != NULL &amp;&amp; !<a class="code" href="classPassenger_1_1MessageChannel.html#c2407ed109785b49794989507c570149" title="Waits at most *timeout milliseconds for the file descriptor to become readable.">waitUntilReadable</a>(timeout)) {
+<a name="l00626"></a>00626                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1TimeoutException.html" title="An exception indicating that some timeout expired.">TimeoutException</a>(<span class="stringliteral">"Cannot read enough data within the specified timeout."</span>);
+<a name="l00627"></a>00627                         }
+<a name="l00628"></a>00628                         ret = <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) buf + alreadyRead, size - alreadyRead);
+<a name="l00629"></a>00629                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00630"></a>00630                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"read() failed"</span>, errno);
+<a name="l00631"></a>00631                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
+<a name="l00632"></a>00632                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00633"></a>00633                         } <span class="keywordflow">else</span> {
+<a name="l00634"></a>00634                                 alreadyRead += ret;
+<a name="l00635"></a>00635                         }
+<a name="l00636"></a>00636                 }
+<a name="l00637"></a>00637                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00638"></a>00638         }
+<a name="l00639"></a>00639         <span class="comment"></span>
+<a name="l00640"></a>00640 <span class="comment">        /**</span>
+<a name="l00641"></a>00641 <span class="comment">         * Waits at most &lt;tt&gt;*timeout&lt;/tt&gt; milliseconds for the file descriptor to become readable.</span>
+<a name="l00642"></a>00642 <span class="comment">         * Returns true if it become readable within the timeout, false if the timeout expired.</span>
+<a name="l00643"></a>00643 <span class="comment">         *</span>
+<a name="l00644"></a>00644 <span class="comment">         * &lt;tt&gt;*timeout&lt;/tt&gt; may be 0, in which case this method will check whether the file</span>
+<a name="l00645"></a>00645 <span class="comment">         * descriptor is readable, and immediately returns without waiting.</span>
+<a name="l00646"></a>00646 <span class="comment">         *</span>
+<a name="l00647"></a>00647 <span class="comment">         * If no exception is thrown, this method deducts the number of milliseconds that has</span>
+<a name="l00648"></a>00648 <span class="comment">         * passed from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
+<a name="l00649"></a>00649 <span class="comment">         *</span>
+<a name="l00650"></a>00650 <span class="comment">         * @throws SystemException</span>
+<a name="l00651"></a>00651 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00652"></a>00652 <span class="comment">         */</span>
+<a name="l00653"></a><a class="code" href="classPassenger_1_1MessageChannel.html#c2407ed109785b49794989507c570149">00653</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#c2407ed109785b49794989507c570149" title="Waits at most *timeout milliseconds for the file descriptor to become readable.">waitUntilReadable</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout) {
+<a name="l00654"></a>00654                 fd_set fds;
+<a name="l00655"></a>00655                 <span class="keyword">struct </span>timeval tv;
+<a name="l00656"></a>00656                 <span class="keywordtype">int</span> ret;
+<a name="l00657"></a>00657                 
+<a name="l00658"></a>00658                 FD_ZERO(&amp;fds);
+<a name="l00659"></a>00659                 FD_SET(fd, &amp;fds);
+<a name="l00660"></a>00660                 tv.tv_sec  = *timeout / 1000;
+<a name="l00661"></a>00661                 tv.tv_usec = *timeout % 1000 * 1000;
+<a name="l00662"></a>00662                 
+<a name="l00663"></a>00663                 Timer timer;
+<a name="l00664"></a>00664                 ret = syscalls::select(fd + 1, &amp;fds, NULL, NULL, &amp;tv);
+<a name="l00665"></a>00665                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00666"></a>00666                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"select() failed"</span>, errno);
+<a name="l00667"></a>00667                 } <span class="keywordflow">else</span> {
+<a name="l00668"></a>00668                         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> elapsed = timer.elapsed();
+<a name="l00669"></a>00669                         <span class="keywordflow">if</span> (elapsed &gt; *timeout) {
+<a name="l00670"></a>00670                                 *timeout = 0;
+<a name="l00671"></a>00671                         } <span class="keywordflow">else</span> {
+<a name="l00672"></a>00672                                 *timeout -= elapsed;
+<a name="l00673"></a>00673                         }
+<a name="l00674"></a>00674                         <span class="keywordflow">return</span> ret != 0;
+<a name="l00675"></a>00675                 }
+<a name="l00676"></a>00676         }
+<a name="l00677"></a>00677         <span class="comment"></span>
+<a name="l00678"></a>00678 <span class="comment">        /**</span>
+<a name="l00679"></a>00679 <span class="comment">         * Receive a file descriptor, which had been passed over the underlying</span>
+<a name="l00680"></a>00680 <span class="comment">         * file descriptor.</span>
+<a name="l00681"></a>00681 <span class="comment">         *</span>
+<a name="l00682"></a>00682 <span class="comment">         * @param negotiate See Ruby's MessageChannel#send_io method's comments.</span>
+<a name="l00683"></a>00683 <span class="comment">         * @return The passed file descriptor.</span>
+<a name="l00684"></a>00684 <span class="comment">         * @throws SystemException If something went wrong during the</span>
+<a name="l00685"></a>00685 <span class="comment">         *            receiving of a file descriptor. Perhaps the underlying</span>
+<a name="l00686"></a>00686 <span class="comment">         *            file descriptor isn't a Unix socket.</span>
+<a name="l00687"></a>00687 <span class="comment">         * @throws IOException Whatever was received doesn't seem to be a</span>
+<a name="l00688"></a>00688 <span class="comment">         *            file descriptor.</span>
+<a name="l00689"></a>00689 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00690"></a>00690 <span class="comment">         */</span>
+<a name="l00691"></a><a class="code" href="classPassenger_1_1MessageChannel.html#1a28ba9d078f38f2831673092ac9dcbc">00691</a>         <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#1a28ba9d078f38f2831673092ac9dcbc" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(<span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
+<a name="l00692"></a>00692                 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
+<a name="l00693"></a>00693                 <span class="keywordflow">if</span> (negotiate) {
+<a name="l00694"></a>00694                         <a class="code" href="classPassenger_1_1MessageChannel.html#150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">"pass IO"</span>, NULL);
+<a name="l00695"></a>00695                 }
+<a name="l00696"></a>00696                 
+<a name="l00697"></a>00697                 <span class="keyword">struct </span>msghdr msg;
+<a name="l00698"></a>00698                 <span class="keyword">struct </span>iovec vec;
+<a name="l00699"></a>00699                 <span class="keywordtype">char</span> dummy[1];
+<a name="l00700"></a>00700 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
+<a name="l00701"></a>00701 <span class="preprocessor"></span>                        <span class="comment">// File descriptor passing macros (CMSG_*) seem to be broken</span>
+<a name="l00702"></a>00702                         <span class="comment">// on 64-bit MacOS X. This structure works around the problem.</span>
+<a name="l00703"></a>00703                         <span class="keyword">struct </span>{
+<a name="l00704"></a>00704                                 <span class="keyword">struct </span>cmsghdr header;
+<a name="l00705"></a>00705                                 <span class="keywordtype">int</span> fd;
+<a name="l00706"></a>00706                         } control_data;
+<a name="l00707"></a>00707 <span class="preprocessor">                        #define EXPECTED_CMSG_LEN sizeof(control_data)</span>
+<a name="l00708"></a>00708 <span class="preprocessor"></span><span class="preprocessor">                #else</span>
+<a name="l00709"></a>00709 <span class="preprocessor"></span>                        <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
+<a name="l00710"></a>00710 <span class="preprocessor">                        #define EXPECTED_CMSG_LEN CMSG_LEN(sizeof(int))</span>
+<a name="l00711"></a>00711 <span class="preprocessor"></span><span class="preprocessor">                #endif</span>
+<a name="l00712"></a>00712 <span class="preprocessor"></span>                <span class="keyword">struct </span>cmsghdr *control_header;
+<a name="l00713"></a>00713                 <span class="keywordtype">int</span> ret;
+<a name="l00714"></a>00714 
+<a name="l00715"></a>00715                 msg.msg_name    = NULL;
+<a name="l00716"></a>00716                 msg.msg_namelen = 0;
+<a name="l00717"></a>00717                 
+<a name="l00718"></a>00718                 dummy[0]       = <span class="charliteral">'\0'</span>;
+<a name="l00719"></a>00719                 vec.iov_base   = dummy;
+<a name="l00720"></a>00720                 vec.iov_len    = <span class="keyword">sizeof</span>(dummy);
+<a name="l00721"></a>00721                 msg.msg_iov    = &amp;vec;
+<a name="l00722"></a>00722                 msg.msg_iovlen = 1;
+<a name="l00723"></a>00723 
+<a name="l00724"></a>00724                 msg.msg_control    = (caddr_t) &amp;control_data;
+<a name="l00725"></a>00725                 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
+<a name="l00726"></a>00726                 msg.msg_flags      = 0;
+<a name="l00727"></a>00727                 
+<a name="l00728"></a>00728                 ret = syscalls::recvmsg(fd, &amp;msg, 0);
+<a name="l00729"></a>00729                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00730"></a>00730                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot read file descriptor with recvmsg()"</span>, errno);
+<a name="l00731"></a>00731                 }
+<a name="l00732"></a>00732                 
+<a name="l00733"></a>00733                 control_header = CMSG_FIRSTHDR(&amp;msg);
+<a name="l00734"></a>00734                 <span class="keywordflow">if</span> (control_header == NULL) {
+<a name="l00735"></a>00735                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"No valid file descriptor received."</span>);
+<a name="l00736"></a>00736                 }
+<a name="l00737"></a>00737                 <span class="keywordflow">if</span> (control_header-&gt;cmsg_len   != EXPECTED_CMSG_LEN
+<a name="l00738"></a>00738                  || control_header-&gt;cmsg_level != SOL_SOCKET
+<a name="l00739"></a>00739                  || control_header-&gt;cmsg_type  != SCM_RIGHTS) {
+<a name="l00740"></a>00740                         <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"No valid file descriptor received."</span>);
+<a name="l00741"></a>00741                 }
+<a name="l00742"></a>00742                 
+<a name="l00743"></a>00743 <span class="preprocessor">                #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
+<a name="l00744"></a>00744 <span class="preprocessor"></span>                        <span class="keywordtype">int</span> fd = control_data.fd;
+<a name="l00745"></a>00745 <span class="preprocessor">                #else</span>
+<a name="l00746"></a>00746 <span class="preprocessor"></span>                        <span class="keywordtype">int</span> fd = *((<span class="keywordtype">int</span> *) CMSG_DATA(control_header));
+<a name="l00747"></a>00747 <span class="preprocessor">                #endif</span>
+<a name="l00748"></a>00748 <span class="preprocessor"></span>                
+<a name="l00749"></a>00749                 <span class="keywordflow">if</span> (negotiate) {
+<a name="l00750"></a>00750                         <span class="keywordflow">try</span> {
+<a name="l00751"></a>00751                                 <a class="code" href="classPassenger_1_1MessageChannel.html#150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">"got IO"</span>, NULL);
+<a name="l00752"></a>00752                         } <span class="keywordflow">catch</span> (...) {
+<a name="l00753"></a>00753                                 this_thread::disable_syscall_interruption dsi;
+<a name="l00754"></a>00754                                 <a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
+<a name="l00755"></a>00755                                 <span class="keywordflow">throw</span>;
+<a name="l00756"></a>00756                         }
+<a name="l00757"></a>00757                 }
+<a name="l00758"></a>00758                 
+<a name="l00759"></a>00759                 <span class="keywordflow">return</span> fd;
+<a name="l00760"></a>00760         }
+<a name="l00761"></a>00761         <span class="comment"></span>
+<a name="l00762"></a>00762 <span class="comment">        /**</span>
+<a name="l00763"></a>00763 <span class="comment">         * Set the timeout value for reading data from this channel.</span>
+<a name="l00764"></a>00764 <span class="comment">         * If no data can be read within the timeout period, then a</span>
+<a name="l00765"></a>00765 <span class="comment">         * SystemException will be thrown by one of the read methods,</span>
+<a name="l00766"></a>00766 <span class="comment">         * with error code EAGAIN or EWOULDBLOCK.</span>
+<a name="l00767"></a>00767 <span class="comment">         *</span>
+<a name="l00768"></a>00768 <span class="comment">         * @param msec The timeout, in milliseconds. If 0 is given,</span>
+<a name="l00769"></a>00769 <span class="comment">         *             there will be no timeout.</span>
+<a name="l00770"></a>00770 <span class="comment">         * @throws SystemException Cannot set the timeout.</span>
+<a name="l00771"></a>00771 <span class="comment">         */</span>
+<a name="l00772"></a><a class="code" href="classPassenger_1_1MessageChannel.html#eb69bffbbb148c9bc8662e20b416c4e2">00772</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#eb69bffbbb148c9bc8662e20b416c4e2" title="Set the timeout value for reading data from this channel.">setReadTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
+<a name="l00773"></a>00773                 <span class="comment">// See the comment for setWriteTimeout().</span>
+<a name="l00774"></a>00774                 <span class="keyword">struct </span>timeval tv;
+<a name="l00775"></a>00775                 <span class="keywordtype">int</span> ret;
+<a name="l00776"></a>00776                 
+<a name="l00777"></a>00777                 tv.tv_sec = msec / 1000;
+<a name="l00778"></a>00778                 tv.tv_usec = msec % 1000 * 1000;
+<a name="l00779"></a>00779                 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO,
+<a name="l00780"></a>00780                         &amp;tv, <span class="keyword">sizeof</span>(tv));
+<a name="l00781"></a>00781 <span class="preprocessor">                #ifndef __SOLARIS__</span>
+<a name="l00782"></a>00782 <span class="preprocessor"></span>                        <span class="comment">// SO_RCVTIMEO is unimplemented and returns an error on Solaris</span>
+<a name="l00783"></a>00783                         <span class="comment">// 9 and 10 SPARC.  Seems to work okay without it.</span>
+<a name="l00784"></a>00784                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00785"></a>00785                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot set read timeout for socket"</span>, errno);
+<a name="l00786"></a>00786                         }
+<a name="l00787"></a>00787 <span class="preprocessor">                #endif</span>
+<a name="l00788"></a>00788 <span class="preprocessor"></span>        }
+<a name="l00789"></a>00789         <span class="comment"></span>
+<a name="l00790"></a>00790 <span class="comment">        /**</span>
+<a name="l00791"></a>00791 <span class="comment">         * Set the timeout value for writing data to this channel.</span>
+<a name="l00792"></a>00792 <span class="comment">         * If no data can be written within the timeout period, then a</span>
+<a name="l00793"></a>00793 <span class="comment">         * SystemException will be thrown, with error code EAGAIN or</span>
+<a name="l00794"></a>00794 <span class="comment">         * EWOULDBLOCK.</span>
+<a name="l00795"></a>00795 <span class="comment">         *</span>
+<a name="l00796"></a>00796 <span class="comment">         * @param msec The timeout, in milliseconds. If 0 is given,</span>
+<a name="l00797"></a>00797 <span class="comment">         *             there will be no timeout.</span>
+<a name="l00798"></a>00798 <span class="comment">         * @throws SystemException Cannot set the timeout.</span>
+<a name="l00799"></a>00799 <span class="comment">         */</span>
+<a name="l00800"></a><a class="code" href="classPassenger_1_1MessageChannel.html#77c5d7c47f387cf43992ebeb14e3c6c7">00800</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#77c5d7c47f387cf43992ebeb14e3c6c7" title="Set the timeout value for writing data to this channel.">setWriteTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
+<a name="l00801"></a>00801                 <span class="comment">// People say that SO_RCVTIMEO/SO_SNDTIMEO are unreliable and</span>
+<a name="l00802"></a>00802                 <span class="comment">// not well-implemented on all platforms.</span>
+<a name="l00803"></a>00803                 <span class="comment">// http://www.developerweb.net/forum/archive/index.php/t-3439.html</span>
+<a name="l00804"></a>00804                 <span class="comment">// That's why we use APR's timeout facilities as well (see Hooks.cpp).</span>
+<a name="l00805"></a>00805                 <span class="keyword">struct </span>timeval tv;
+<a name="l00806"></a>00806                 <span class="keywordtype">int</span> ret;
+<a name="l00807"></a>00807                 
+<a name="l00808"></a>00808                 tv.tv_sec = msec / 1000;
+<a name="l00809"></a>00809                 tv.tv_usec = msec % 1000 * 1000;
+<a name="l00810"></a>00810                 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO,
+<a name="l00811"></a>00811                         &amp;tv, <span class="keyword">sizeof</span>(tv));
+<a name="l00812"></a>00812 <span class="preprocessor">                #ifndef __SOLARIS__</span>
+<a name="l00813"></a>00813 <span class="preprocessor"></span>                        <span class="comment">// SO_SNDTIMEO is unimplemented and returns an error on Solaris</span>
+<a name="l00814"></a>00814                         <span class="comment">// 9 and 10 SPARC.  Seems to work okay without it.</span>
+<a name="l00815"></a>00815                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00816"></a>00816                                 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot set read timeout for socket"</span>, errno);
+<a name="l00817"></a>00817                         }
+<a name="l00818"></a>00818 <span class="preprocessor">                #endif</span>
+<a name="l00819"></a>00819 <span class="preprocessor"></span>        }
+<a name="l00820"></a>00820 };
+<a name="l00821"></a>00821 
+<a name="l00822"></a>00822 } <span class="comment">// namespace Passenger</span>
+<a name="l00823"></a>00823 
+<a name="l00824"></a>00824 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_CHANNEL_H_ */</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:45 2010 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 for Passenger by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
 </body>