RubyGems - passenger - Versions diffs - 2.2.9 → 2.2.10 - Mend

passenger 2.2.9 → 2.2.10

Potentially problematic release.

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

Files changed (435) hide show

data/doc/cxxapi/FileChangeChecker_8h-source.html ADDED

@@ -0,0 +1,237 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Passenger: FileChangeChecker.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>FileChangeChecker.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  "Phusion Passenger" is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00006"></a>00006 <span class="comment"> *</span>
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the "Software"), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_CHANGE_FILE_CHECKER_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_CHANGE_FILE_CHECKER_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00029"></a>00029
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;boost/thread.hpp&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;errno.h&gt;</span>
+<a name="l00032"></a>00032
+<a name="l00033"></a>00033 <span class="preprocessor">#include "CachedFileStat.hpp"</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include "SystemTime.h"</span>
+<a name="l00035"></a>00035
+<a name="l00036"></a>00036 <span class="keyword">namespace </span>Passenger {
+<a name="l00037"></a>00037
+<a name="l00038"></a>00038 <span class="keyword">using namespace </span>std;
+<a name="l00039"></a>00039 <span class="keyword">using namespace </span>oxt;
+<a name="l00040"></a>00040 <span class="comment"></span>
+<a name="l00041"></a>00041 <span class="comment">/**</span>
+<a name="l00042"></a>00042 <span class="comment"> * A utility class for checking for file changes. Example:</span>
+<a name="l00043"></a>00043 <span class="comment"> *</span>
+<a name="l00044"></a>00044 <span class="comment"> * @code</span>
+<a name="l00045"></a>00045 <span class="comment"> * FileChangeChecker checker;</span>
+<a name="l00046"></a>00046 <span class="comment"> * checker.changed("foo.txt");   // false</span>
+<a name="l00047"></a>00047 <span class="comment"> * writeToFile("foo.txt");</span>
+<a name="l00048"></a>00048 <span class="comment"> * checker.changed("foo.txt");   // true</span>
+<a name="l00049"></a>00049 <span class="comment"> * checker.changed("foo.txt");   // false</span>
+<a name="l00050"></a>00050 <span class="comment"> * @endcode</span>
+<a name="l00051"></a>00051 <span class="comment"> *</span>
+<a name="l00052"></a>00052 <span class="comment"> * FileChangeChecker uses stat() to retrieve file information. It also</span>
+<a name="l00053"></a>00053 <span class="comment"> * supports throttling in order to limit the number of actual stat() calls.</span>
+<a name="l00054"></a>00054 <span class="comment"> * This can improve performance on systems where disk I/O is a problem.</span>
+<a name="l00055"></a>00055 <span class="comment"> */</span>
+<a name="l00056"></a><a class="code" href="classPassenger_1_1FileChangeChecker.html">00056</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1FileChangeChecker.html" title="A utility class for checking for file changes.">FileChangeChecker</a> {
+<a name="l00057"></a>00057 <span class="keyword">private</span>:
+<a name="l00058"></a>00058         <span class="keyword">struct </span>Entry {
+<a name="l00059"></a>00059                 <span class="keywordtype">string</span> filename;
+<a name="l00060"></a>00060                 time_t lastMtime;
+<a name="l00061"></a>00061                 time_t lastCtime;
+<a name="l00062"></a>00062
+<a name="l00063"></a>00063                 Entry(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;filename) {
+<a name="l00064"></a>00064                         this-&gt;filename  = filename;
+<a name="l00065"></a>00065                         this-&gt;lastMtime = 0;
+<a name="l00066"></a>00066                         this-&gt;lastCtime = 0;
+<a name="l00067"></a>00067                 }
+<a name="l00068"></a>00068         };
+<a name="l00069"></a>00069
+<a name="l00070"></a>00070         <span class="keyword">typedef</span> shared_ptr&lt;Entry&gt; EntryPtr;
+<a name="l00071"></a>00071         <span class="keyword">typedef</span> list&lt;EntryPtr&gt; EntryList;
+<a name="l00072"></a>00072         <span class="keyword">typedef</span> map&lt;string, EntryList::iterator&gt; EntryMap;
+<a name="l00073"></a>00073
+<a name="l00074"></a>00074         CachedFileStat cstat;
+<a name="l00075"></a>00075         <span class="keyword">mutable</span> boost::mutex lock;
+<a name="l00076"></a>00076         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize;
+<a name="l00077"></a>00077         EntryList entries;
+<a name="l00078"></a>00078         EntryMap fileToEntry;
+<a name="l00079"></a>00079
+<a name="l00080"></a>00080 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00081"></a>00081 <span class="comment">        /**</span>
+<a name="l00082"></a>00082 <span class="comment">         * Create a FileChangeChecker object.</span>
+<a name="l00083"></a>00083 <span class="comment">         *</span>
+<a name="l00084"></a>00084 <span class="comment">         * @param maxSize The maximum size of the internal file list. A size of 0 means unlimited.</span>
+<a name="l00085"></a>00085 <span class="comment">         */</span>
+<a name="l00086"></a><a class="code" href="classPassenger_1_1FileChangeChecker.html#cedaa0a0ed0be509dbbd79abaec25f26">00086</a>         <a class="code" href="classPassenger_1_1FileChangeChecker.html#cedaa0a0ed0be509dbbd79abaec25f26" title="Create a FileChangeChecker object.">FileChangeChecker</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize = 0)
+<a name="l00087"></a>00087                 : cstat(maxSize)
+<a name="l00088"></a>00088         {
+<a name="l00089"></a>00089                 this-&gt;maxSize = maxSize;
+<a name="l00090"></a>00090         }
+<a name="l00091"></a>00091         <span class="comment"></span>
+<a name="l00092"></a>00092 <span class="comment">        /**</span>
+<a name="l00093"></a>00093 <span class="comment">         * Checks whether, since the last call to changed() with this filename,</span>
+<a name="l00094"></a>00094 <span class="comment">         * the file's timestamp has changed or whether the file has been created</span>
+<a name="l00095"></a>00095 <span class="comment">         * or removed. If the stat() call fails for any other reason (e.g. the</span>
+<a name="l00096"></a>00096 <span class="comment">         * directory is not readable) then this method will return false.</span>
+<a name="l00097"></a>00097 <span class="comment">         *</span>
+<a name="l00098"></a>00098 <span class="comment">         * If this method was called with this filename for the first time, or if</span>
+<a name="l00099"></a>00099 <span class="comment">         * information about this file has since been removed from the internal</span>
+<a name="l00100"></a>00100 <span class="comment">         * file list, then this method will return whether the file is stat()-able.</span>
+<a name="l00101"></a>00101 <span class="comment">         * That is, if the file doesn't exist then it will return false, but if</span>
+<a name="l00102"></a>00102 <span class="comment">         * the directory is not readable then it will also return false.</span>
+<a name="l00103"></a>00103 <span class="comment">         *</span>
+<a name="l00104"></a>00104 <span class="comment">         * @param filename The file to check. Note that two different filename</span>
+<a name="l00105"></a>00105 <span class="comment">         *                 strings are treated as two different files, so you should</span>
+<a name="l00106"></a>00106 <span class="comment">         *                 use absolute filenames if you change working directory</span>
+<a name="l00107"></a>00107 <span class="comment">         *                 often.</span>
+<a name="l00108"></a>00108 <span class="comment">         * @param throttleRate When set to a non-zero value, throttling will be</span>
+<a name="l00109"></a>00109 <span class="comment">         *                     enabled. stat() will be called at most once per</span>
+<a name="l00110"></a>00110 <span class="comment">         *                     throttleRate seconds.</span>
+<a name="l00111"></a>00111 <span class="comment">         * @throws TimeRetrievalException Something went wrong while retrieving the</span>
+<a name="l00112"></a>00112 <span class="comment">         *         system time.</span>
+<a name="l00113"></a>00113 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00114"></a>00114 <span class="comment">         */</span>
+<a name="l00115"></a><a class="code" href="classPassenger_1_1FileChangeChecker.html#52837a877522fb64d70ee1ba965e9135">00115</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1FileChangeChecker.html#52837a877522fb64d70ee1ba965e9135" title="Checks whether, since the last call to changed() with this filename, the file&amp;#39;s...">changed</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;filename, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0) {
+<a name="l00116"></a>00116                 boost::unique_lock&lt;boost::mutex&gt; l(lock);
+<a name="l00117"></a>00117                 EntryMap::iterator it(fileToEntry.find(filename));
+<a name="l00118"></a>00118                 EntryPtr entry;
+<a name="l00119"></a>00119                 <span class="keyword">struct </span>stat buf;
+<a name="l00120"></a>00120                 <span class="keywordtype">bool</span> result, newEntry = <span class="keyword">false</span>;
+<a name="l00121"></a>00121                 <span class="keywordtype">int</span> ret;
+<a name="l00122"></a>00122
+<a name="l00123"></a>00123                 <span class="keywordflow">if</span> (it == fileToEntry.end()) {
+<a name="l00124"></a>00124                         <span class="comment">// Filename not in file list.</span>
+<a name="l00125"></a>00125                         <span class="comment">// If file list is full, remove the least recently used</span>
+<a name="l00126"></a>00126                         <span class="comment">// file list entry.</span>
+<a name="l00127"></a>00127                         <span class="keywordflow">if</span> (maxSize != 0 &amp;&amp; fileToEntry.size() == maxSize) {
+<a name="l00128"></a>00128                                 EntryList::iterator listEnd(entries.end());
+<a name="l00129"></a>00129                                 listEnd--;
+<a name="l00130"></a>00130                                 <span class="keywordtype">string</span> filename((*listEnd)-&gt;filename);
+<a name="l00131"></a>00131                                 entries.pop_back();
+<a name="l00132"></a>00132                                 fileToEntry.erase(filename);
+<a name="l00133"></a>00133                         }
+<a name="l00134"></a>00134
+<a name="l00135"></a>00135                         <span class="comment">// Add to file list as most recently used.</span>
+<a name="l00136"></a>00136                         entry = EntryPtr(<span class="keyword">new</span> Entry(filename));
+<a name="l00137"></a>00137                         entries.push_front(entry);
+<a name="l00138"></a>00138                         fileToEntry[filename] = entries.begin();
+<a name="l00139"></a>00139                         newEntry = <span class="keyword">true</span>;
+<a name="l00140"></a>00140                 } <span class="keywordflow">else</span> {
+<a name="l00141"></a>00141                         <span class="comment">// Filename is in file list.</span>
+<a name="l00142"></a>00142                         entry = *it-&gt;second;
+<a name="l00143"></a>00143
+<a name="l00144"></a>00144                         <span class="comment">// Mark this entry as most recently used.</span>
+<a name="l00145"></a>00145                         entries.erase(it-&gt;second);
+<a name="l00146"></a>00146                         entries.push_front(entry);
+<a name="l00147"></a>00147                         fileToEntry[filename] = entries.begin();
+<a name="l00148"></a>00148                 }
+<a name="l00149"></a>00149
+<a name="l00150"></a>00150                 ret = cstat.stat(filename, &amp;buf, throttleRate);
+<a name="l00151"></a>00151                 <span class="keywordflow">if</span> (newEntry) {
+<a name="l00152"></a>00152                         <span class="comment">// The file's information isn't in the file list.</span>
+<a name="l00153"></a>00153                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00154"></a>00154                                 entry-&gt;lastMtime = 0;
+<a name="l00155"></a>00155                                 entry-&gt;lastCtime = 0;
+<a name="l00156"></a>00156                                 <span class="keywordflow">return</span> <span class="keyword">false</span>;
+<a name="l00157"></a>00157                         } <span class="keywordflow">else</span> {
+<a name="l00158"></a>00158                                 entry-&gt;lastMtime = buf.st_mtime;
+<a name="l00159"></a>00159                                 entry-&gt;lastCtime = buf.st_ctime;
+<a name="l00160"></a>00160                                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+<a name="l00161"></a>00161                         }
+<a name="l00162"></a>00162                 } <span class="keywordflow">else</span> {
+<a name="l00163"></a>00163                         <span class="comment">// The file's information was already in the file list.</span>
+<a name="l00164"></a>00164                         <span class="keywordflow">if</span> (ret == -1 &amp;&amp; errno == ENOENT) {
+<a name="l00165"></a>00165                                 result = entry-&gt;lastMtime != 0 || entry-&gt;lastCtime != 0;
+<a name="l00166"></a>00166                                 entry-&gt;lastMtime = 0;
+<a name="l00167"></a>00167                                 entry-&gt;lastCtime = 0;
+<a name="l00168"></a>00168                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00169"></a>00169                                 result = <span class="keyword">false</span>;
+<a name="l00170"></a>00170                         } <span class="keywordflow">else</span> {
+<a name="l00171"></a>00171                                 result = entry-&gt;lastMtime != buf.st_mtime || entry-&gt;lastCtime != buf.st_ctime;
+<a name="l00172"></a>00172                                 entry-&gt;lastMtime = buf.st_mtime;
+<a name="l00173"></a>00173                                 entry-&gt;lastCtime = buf.st_ctime;
+<a name="l00174"></a>00174                         }
+<a name="l00175"></a>00175                         <span class="keywordflow">return</span> result;
+<a name="l00176"></a>00176                 }
+<a name="l00177"></a>00177         }
+<a name="l00178"></a>00178         <span class="comment"></span>
+<a name="l00179"></a>00179 <span class="comment">        /**</span>
+<a name="l00180"></a>00180 <span class="comment">         * Change the maximum size of the internal file list.</span>
+<a name="l00181"></a>00181 <span class="comment">         *</span>
+<a name="l00182"></a>00182 <span class="comment">         * A size of 0 means unlimited.</span>
+<a name="l00183"></a>00183 <span class="comment">         */</span>
+<a name="l00184"></a><a class="code" href="classPassenger_1_1FileChangeChecker.html#5055aae067b41fc5fe11747a04b0a1dd">00184</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileChangeChecker.html#5055aae067b41fc5fe11747a04b0a1dd" title="Change the maximum size of the internal file list.">setMaxSize</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize) {
+<a name="l00185"></a>00185                 boost::unique_lock&lt;boost::mutex&gt; l(lock);
+<a name="l00186"></a>00186                 <span class="keywordflow">if</span> (maxSize != 0) {
+<a name="l00187"></a>00187                         <span class="keywordtype">int</span> toRemove = fileToEntry.size() - maxSize;
+<a name="l00188"></a>00188                         <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; toRemove; i++) {
+<a name="l00189"></a>00189                                 <span class="keywordtype">string</span> filename(entries.back()-&gt;filename);
+<a name="l00190"></a>00190                                 entries.pop_back();
+<a name="l00191"></a>00191                                 fileToEntry.erase(filename);
+<a name="l00192"></a>00192                         }
+<a name="l00193"></a>00193                 }
+<a name="l00194"></a>00194                 this-&gt;maxSize = maxSize;
+<a name="l00195"></a>00195                 cstat.setMaxSize(maxSize);
+<a name="l00196"></a>00196         }
+<a name="l00197"></a>00197         <span class="comment"></span>
+<a name="l00198"></a>00198 <span class="comment">        /**</span>
+<a name="l00199"></a>00199 <span class="comment">         * Returns whether &lt;tt&gt;filename&lt;/tt&gt; is in the internal file list.</span>
+<a name="l00200"></a>00200 <span class="comment">         */</span>
+<a name="l00201"></a><a class="code" href="classPassenger_1_1FileChangeChecker.html#3fb03c747d95f49bddec9e2ca8e8694f">00201</a>         <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1FileChangeChecker.html#3fb03c747d95f49bddec9e2ca8e8694f" title="Returns whether filename is in the internal file list.">knows</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;filename)<span class="keyword"> const </span>{
+<a name="l00202"></a>00202                 boost::unique_lock&lt;boost::mutex&gt; l(lock);
+<a name="l00203"></a>00203                 <span class="keywordflow">return</span> fileToEntry.find(filename) != fileToEntry.end();
+<a name="l00204"></a>00204         }
+<a name="l00205"></a>00205 };
+<a name="l00206"></a>00206
+<a name="l00207"></a>00207 } <span class="comment">// namespace Passenger</span>
+<a name="l00208"></a>00208
+<a name="l00209"></a>00209 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_CHANGE_FILE_CHECKER_H_ */</span>
+</pre></div></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 8 22:53:21 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>
+</html>

data/doc/cxxapi/FileDescriptor_8h-source.html ADDED

@@ -0,0 +1,206 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Passenger: FileDescriptor.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css">
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
+    </ul>
+  </div>
+<h1>FileDescriptor.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
+<a name="l00004"></a>00004 <span class="comment"> *</span>
+<a name="l00005"></a>00005 <span class="comment"> *  "Phusion Passenger" is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00006"></a>00006 <span class="comment"> *</span>
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the "Software"), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_FILE_DESCRIPTOR_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_FILE_DESCRIPTOR_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;oxt/system_calls.hpp&gt;</span>
+<a name="l00030"></a>00030
+<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;cerrno&gt;</span>
+<a name="l00033"></a>00033
+<a name="l00034"></a>00034 <span class="preprocessor">#include "MessageChannel.h"</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include "Exceptions.h"</span>
+<a name="l00036"></a>00036
+<a name="l00037"></a>00037 <span class="keyword">namespace </span>Passenger {
+<a name="l00038"></a>00038
+<a name="l00039"></a>00039 <span class="keyword">using namespace </span>boost;
+<a name="l00040"></a>00040 <span class="keyword">using namespace </span>oxt;
+<a name="l00041"></a>00041
+<a name="l00042"></a>00042 <span class="comment"></span>
+<a name="l00043"></a>00043 <span class="comment">/**</span>
+<a name="l00044"></a>00044 <span class="comment"> * Wrapper class around a file descriptor integer, for RAII behavior.</span>
+<a name="l00045"></a>00045 <span class="comment"> *</span>
+<a name="l00046"></a>00046 <span class="comment"> * A FileDescriptor object behaves just like an int, so that you can pass it to</span>
+<a name="l00047"></a>00047 <span class="comment"> * system calls such as read(). It performs reference counting. When the last</span>
+<a name="l00048"></a>00048 <span class="comment"> * copy of a FileDescriptor has been destroyed, the underlying file descriptor</span>
+<a name="l00049"></a>00049 <span class="comment"> * will be automatically closed. In this case, any close() system call errors</span>
+<a name="l00050"></a>00050 <span class="comment"> * are silently ignored. If you are interested in whether the close() system</span>
+<a name="l00051"></a>00051 <span class="comment"> * call succeeded, then you should call FileDescriptor::close().</span>
+<a name="l00052"></a>00052 <span class="comment"> *</span>
+<a name="l00053"></a>00053 <span class="comment"> * This class is *not* thread-safe. It is safe to call system calls on the</span>
+<a name="l00054"></a>00054 <span class="comment"> * underlying file descriptor from multiple threads, but it's not safe to</span>
+<a name="l00055"></a>00055 <span class="comment"> * call FileDescriptor::close() from multiple threads if all those</span>
+<a name="l00056"></a>00056 <span class="comment"> * FileDescriptor objects point to the same underlying file descriptor.</span>
+<a name="l00057"></a>00057 <span class="comment"> */</span>
+<a name="l00058"></a><a class="code" href="classPassenger_1_1FileDescriptor.html">00058</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> {
+<a name="l00059"></a>00059 <span class="keyword">private</span>:
+<a name="l00060"></a>00060         <span class="keyword">struct </span>SharedData {
+<a name="l00061"></a>00061                 <span class="keywordtype">int</span> fd;
+<a name="l00062"></a>00062
+<a name="l00063"></a>00063                 SharedData(<span class="keywordtype">int</span> fd) {
+<a name="l00064"></a>00064                         this-&gt;fd = fd;
+<a name="l00065"></a>00065                 }
+<a name="l00066"></a>00066
+<a name="l00067"></a>00067                 ~SharedData() {
+<a name="l00068"></a>00068                         <span class="keywordflow">if</span> (fd != -1) {
+<a name="l00069"></a>00069                                 this_thread::disable_syscall_interruption dsi;
+<a name="l00070"></a>00070                                 <a class="code" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
+<a name="l00071"></a>00071                         }
+<a name="l00072"></a>00072                 }
+<a name="l00073"></a>00073
+<a name="l00074"></a>00074                 <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close</a>() {
+<a name="l00075"></a>00075                         <span class="keywordflow">if</span> (fd != -1) {
+<a name="l00076"></a>00076                                 this_thread::disable_syscall_interruption dsi;
+<a name="l00077"></a>00077                                 <span class="keywordtype">int</span> theFd = fd;
+<a name="l00078"></a>00078                                 fd = -1;
+<a name="l00079"></a>00079                                 <span class="keywordflow">if</span> (syscalls::close(theFd) == -1 &amp;&amp; errno != ENOTCONN) {
+<a name="l00080"></a>00080                                         <span class="keywordtype">int</span> e = errno;
+<a name="l00081"></a>00081                                         <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 close file descriptor"</span>, e);
+<a name="l00082"></a>00082                                 }
+<a name="l00083"></a>00083                         }
+<a name="l00084"></a>00084                 }
+<a name="l00085"></a>00085         };
+<a name="l00086"></a>00086 <span class="comment"></span>
+<a name="l00087"></a>00087 <span class="comment">        /** Shared pointer for reference counting on this file descriptor */</span>
+<a name="l00088"></a>00088         shared_ptr&lt;SharedData&gt; data;
+<a name="l00089"></a>00089
+<a name="l00090"></a>00090 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00091"></a>00091 <span class="comment">        /** </span>
+<a name="l00092"></a>00092 <span class="comment">         * Creates a new empty FileDescriptor instance that has no underlying</span>
+<a name="l00093"></a>00093 <span class="comment">         * file descriptor.</span>
+<a name="l00094"></a>00094 <span class="comment">         *</span>
+<a name="l00095"></a>00095 <span class="comment">         * @post *this == -1</span>
+<a name="l00096"></a>00096 <span class="comment">         */</span>
+<a name="l00097"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#05d83ad9cc77c493a3ce4f2b51d44559">00097</a>         <a class="code" href="classPassenger_1_1FileDescriptor.html#05d83ad9cc77c493a3ce4f2b51d44559" title="Creates a new empty FileDescriptor instance that has no underlying file descriptor...">FileDescriptor</a>() { }
+<a name="l00098"></a>00098         <span class="comment"></span>
+<a name="l00099"></a>00099 <span class="comment">        /**</span>
+<a name="l00100"></a>00100 <span class="comment">         * Creates a new FileDescriptor instance with the given fd as a handle.</span>
+<a name="l00101"></a>00101 <span class="comment">         *</span>
+<a name="l00102"></a>00102 <span class="comment">         * @post *this == fd</span>
+<a name="l00103"></a>00103 <span class="comment">         */</span>
+<a name="l00104"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#62c05b925cb1cf964169cef7635650ee">00104</a>         <a class="code" href="classPassenger_1_1FileDescriptor.html#62c05b925cb1cf964169cef7635650ee" title="Creates a new FileDescriptor instance with the given fd as a handle.">FileDescriptor</a>(<span class="keywordtype">int</span> fd) {
+<a name="l00105"></a>00105                 data.reset(<span class="keyword">new</span> SharedData(fd));
+<a name="l00106"></a>00106         }
+<a name="l00107"></a>00107         <span class="comment"></span>
+<a name="l00108"></a>00108 <span class="comment">        /**</span>
+<a name="l00109"></a>00109 <span class="comment">         * Close the underlying file descriptor. If it was already closed, then</span>
+<a name="l00110"></a>00110 <span class="comment">         * nothing will happen.</span>
+<a name="l00111"></a>00111 <span class="comment">         *</span>
+<a name="l00112"></a>00112 <span class="comment">         * @throws SystemException Something went wrong while closing</span>
+<a name="l00113"></a>00113 <span class="comment">         *                         the file descriptor.</span>
+<a name="l00114"></a>00114 <span class="comment">         * @post *this == -1</span>
+<a name="l00115"></a>00115 <span class="comment">         */</span>
+<a name="l00116"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432">00116</a>         <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close</a>() {
+<a name="l00117"></a>00117                 <span class="keywordflow">if</span> (data != NULL) {
+<a name="l00118"></a>00118                         data-&gt;close();
+<a name="l00119"></a>00119                 }
+<a name="l00120"></a>00120         }
+<a name="l00121"></a>00121         <span class="comment"></span>
+<a name="l00122"></a>00122 <span class="comment">        /**</span>
+<a name="l00123"></a>00123 <span class="comment">         * Overloads the integer cast operator so that it will return the underlying</span>
+<a name="l00124"></a>00124 <span class="comment">         * file descriptor handle as an integer.</span>
+<a name="l00125"></a>00125 <span class="comment">         *</span>
+<a name="l00126"></a>00126 <span class="comment">         * Returns -1 if FileDescriptor::close() was called.</span>
+<a name="l00127"></a>00127 <span class="comment">         */</span>
+<a name="l00128"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#c335c2a97f3a6c8e3920f573b0d04081">00128</a>         <a class="code" href="classPassenger_1_1FileDescriptor.html#c335c2a97f3a6c8e3920f573b0d04081" title="Overloads the integer cast operator so that it will return the underlying file descriptor...">operator int </a>()<span class="keyword"> const </span>{
+<a name="l00129"></a>00129                 <span class="keywordflow">if</span> (data == NULL) {
+<a name="l00130"></a>00130                         <span class="keywordflow">return</span> -1;
+<a name="l00131"></a>00131                 } <span class="keywordflow">else</span> {
+<a name="l00132"></a>00132                         <span class="keywordflow">return</span> data-&gt;fd;
+<a name="l00133"></a>00133                 }
+<a name="l00134"></a>00134         }
+<a name="l00135"></a>00135 };
+<a name="l00136"></a>00136 <span class="comment"></span>
+<a name="l00137"></a>00137 <span class="comment">/**</span>
+<a name="l00138"></a>00138 <span class="comment"> * A synchronization mechanism that's implemented with file descriptors,</span>
+<a name="l00139"></a>00139 <span class="comment"> * and as such can be used in combination with select() and friends.</span>
+<a name="l00140"></a>00140 <span class="comment"> *</span>
+<a name="l00141"></a>00141 <span class="comment"> * One can wait for an event on an EventFd by select()ing it on read events.</span>
+<a name="l00142"></a>00142 <span class="comment"> * Another thread can signal the EventFd by calling notify().</span>
+<a name="l00143"></a>00143 <span class="comment"> */</span>
+<a name="l00144"></a><a class="code" href="classPassenger_1_1EventFd.html">00144</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&amp;#39;s implemented with file descriptors, and as...">EventFd</a> {
+<a name="l00145"></a>00145 <span class="keyword">private</span>:
+<a name="l00146"></a>00146         <span class="keywordtype">int</span> reader;
+<a name="l00147"></a>00147         <span class="keywordtype">int</span> writer;
+<a name="l00148"></a>00148
+<a name="l00149"></a>00149 <span class="keyword">public</span>:
+<a name="l00150"></a>00150         <a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&amp;#39;s implemented with file descriptors, and as...">EventFd</a>() {
+<a name="l00151"></a>00151                 <span class="keywordtype">int</span> fds[2];
+<a name="l00152"></a>00152
+<a name="l00153"></a>00153                 <span class="keywordflow">if</span> (syscalls::pipe(fds) == -1) {
+<a name="l00154"></a>00154                         <span class="keywordtype">int</span> e = errno;
+<a name="l00155"></a>00155                         <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 create a pipe"</span>, e);
+<a name="l00156"></a>00156                 }
+<a name="l00157"></a>00157                 reader = fds[0];
+<a name="l00158"></a>00158                 writer = fds[1];
+<a name="l00159"></a>00159         }
+<a name="l00160"></a>00160
+<a name="l00161"></a>00161         ~<a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&amp;#39;s implemented with file descriptors, and as...">EventFd</a>() {
+<a name="l00162"></a>00162                 this_thread::disable_syscall_interruption dsi;
+<a name="l00163"></a>00163                 syscalls::close(reader);
+<a name="l00164"></a>00164                 syscalls::close(writer);
+<a name="l00165"></a>00165         }
+<a name="l00166"></a>00166
+<a name="l00167"></a>00167         <span class="keywordtype">void</span> notify() {
+<a name="l00168"></a>00168                 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(writer).writeRaw(<span class="stringliteral">"x"</span>, 1);
+<a name="l00169"></a>00169         }
+<a name="l00170"></a>00170
+<a name="l00171"></a>00171         <span class="keywordtype">int</span> fd()<span class="keyword"> const </span>{
+<a name="l00172"></a>00172                 <span class="keywordflow">return</span> reader;
+<a name="l00173"></a>00173         }
+<a name="l00174"></a>00174 };
+<a name="l00175"></a>00175
+<a name="l00176"></a>00176 } <span class="comment">// namespace Passenger</span>
+<a name="l00177"></a>00177
+<a name="l00178"></a>00178 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_FILE_DESCRIPTOR_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;
+<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>
+</html>

data/doc/cxxapi/Hooks_8h-source.html CHANGED

@@ -65,7 +65,7 @@
 <a name="l00044"></a>00044 <span class="preprocessor"></span>
 <a name="l00045"></a>00045 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_HOOKS_H_ */</span>
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 8 11:42:56 2010 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 22 13:50:37 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>