doc/cxxapi/CachedFileStat_8h-source.html in passenger-2.2.9 vs doc/cxxapi/CachedFileStat_8h-source.html in passenger-2.2.10
- old
+ new
@@ -8,10 +8,11 @@
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main 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">
@@ -19,169 +20,60 @@
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>CachedFileStat.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) 2009 Phusion</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 & Ninh Bui.</span>
+<a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
-<a name="l00007"></a>00007 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
-<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
-<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; version 2 of the License.</span>
-<a name="l00010"></a>00010 <span class="comment"> *</span>
-<a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
-<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
-<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
-<a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span>
-<a name="l00015"></a>00015 <span class="comment"> *</span>
-<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
-<a name="l00017"></a>00017 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
-<a name="l00018"></a>00018 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
-<a name="l00019"></a>00019 <span class="comment"> */</span>
-<a name="l00020"></a>00020 <span class="preprocessor">#ifndef _PASSENGER_CACHED_FILE_STAT_H_</span>
-<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_CACHED_FILE_STAT_H_</span>
-<a name="l00022"></a>00022 <span class="preprocessor"></span>
-<a name="l00023"></a>00023 <span class="preprocessor">#include <sys/types.h></span>
-<a name="l00024"></a>00024 <span class="preprocessor">#include <sys/stat.h></span>
-<a name="l00025"></a>00025 <span class="preprocessor">#include <unistd.h></span>
-<a name="l00026"></a>00026 <span class="preprocessor">#include <time.h></span>
-<a name="l00027"></a>00027
-<a name="l00028"></a>00028 <span class="preprocessor">#ifdef __cplusplus</span>
-<a name="l00029"></a>00029 <span class="preprocessor"></span>
-<a name="l00030"></a>00030 <span class="preprocessor">#include <errno.h></span>
-<a name="l00031"></a>00031 <span class="preprocessor">#include <string></span>
-<a name="l00032"></a>00032 <span class="preprocessor">#include <oxt/system_calls.hpp></span>
-<a name="l00033"></a>00033
-<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"> * CachedFileStat allows one to stat() a file at a throttled rate, in order</span>
-<a name="l00043"></a>00043 <span class="comment"> * to minimize stress on the filesystem. It does this by caching the old stat</span>
-<a name="l00044"></a>00044 <span class="comment"> * data for a specified amount of time.</span>
-<a name="l00045"></a>00045 <span class="comment"> */</span>
-<a name="l00046"></a>00046 <span class="keyword">class </span>CachedFileStat {
-<a name="l00047"></a>00047 <span class="keyword">private</span>:<span class="comment"></span>
-<a name="l00048"></a>00048 <span class="comment"> /** The last return value of stat(). */</span>
-<a name="l00049"></a>00049 <span class="keywordtype">int</span> last_result;
-<a name="l00050"></a>00050 <span class="comment"></span>
-<a name="l00051"></a>00051 <span class="comment"> /** The errno set by the last stat() call. */</span>
-<a name="l00052"></a>00052 <span class="keywordtype">int</span> last_errno;
-<a name="l00053"></a>00053 <span class="comment"></span>
-<a name="l00054"></a>00054 <span class="comment"> /** The filename of the file to stat. */</span>
-<a name="l00055"></a>00055 <span class="keywordtype">string</span> filename;
-<a name="l00056"></a>00056 <span class="comment"></span>
-<a name="l00057"></a>00057 <span class="comment"> /** The last time a stat() was performed. */</span>
-<a name="l00058"></a>00058 time_t last_time;
-<a name="l00059"></a>00059 <span class="comment"></span>
-<a name="l00060"></a>00060 <span class="comment"> /**</span>
-<a name="l00061"></a>00061 <span class="comment"> * Checks whether <em>interval</em> seconds have elapsed since <em>begin</em></span>
-<a name="l00062"></a>00062 <span class="comment"> * The current time is returned via the <tt>currentTime</tt> argument,</span>
-<a name="l00063"></a>00063 <span class="comment"> * so that the caller doesn't have to call time() again if it needs the current</span>
-<a name="l00064"></a>00064 <span class="comment"> * time.</span>
-<a name="l00065"></a>00065 <span class="comment"> *</span>
-<a name="l00066"></a>00066 <span class="comment"> * @pre begin <= time(NULL)</span>
-<a name="l00067"></a>00067 <span class="comment"> * @return Whether <tt>interval</tt> seconds have elapsed since <tt>begin</tt>.</span>
-<a name="l00068"></a>00068 <span class="comment"> * @throws SystemException Something went wrong while retrieving the time.</span>
-<a name="l00069"></a>00069 <span class="comment"> * @throws boost::thread_interrupted</span>
-<a name="l00070"></a>00070 <span class="comment"> */</span>
-<a name="l00071"></a>00071 <span class="keywordtype">bool</span> expired(time_t begin, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> interval, time_t &currentTime) {
-<a name="l00072"></a>00072 currentTime = <a class="code" href="classPassenger_1_1SystemTime.html#d643b3e5748ee929e013517e6aca046c" title="Returns the time since the Epoch, measured in seconds.">SystemTime::get</a>();
-<a name="l00073"></a>00073 <span class="keywordflow">return</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) (currentTime - begin) >= interval;
-<a name="l00074"></a>00074 }
-<a name="l00075"></a>00075
-<a name="l00076"></a>00076 <span class="keyword">public</span>:<span class="comment"></span>
-<a name="l00077"></a>00077 <span class="comment"> /** The cached stat info. */</span>
-<a name="l00078"></a>00078 <span class="keyword">struct </span>stat info;
-<a name="l00079"></a>00079 <span class="comment"></span>
-<a name="l00080"></a>00080 <span class="comment"> /**</span>
-<a name="l00081"></a>00081 <span class="comment"> * Creates a new CachedFileStat object. The file will not be</span>
-<a name="l00082"></a>00082 <span class="comment"> * stat()ted until you call refresh().</span>
-<a name="l00083"></a>00083 <span class="comment"> *</span>
-<a name="l00084"></a>00084 <span class="comment"> * @param filename The file to stat.</span>
-<a name="l00085"></a>00085 <span class="comment"> */</span>
-<a name="l00086"></a>00086 CachedFileStat(<span class="keyword">const</span> <span class="keywordtype">string</span> &filename) {
-<a name="l00087"></a>00087 memset(&info, 0, <span class="keyword">sizeof</span>(<span class="keyword">struct</span> stat));
-<a name="l00088"></a>00088 last_result = -1;
-<a name="l00089"></a>00089 last_errno = 0;
-<a name="l00090"></a>00090 this->filename = filename;
-<a name="l00091"></a>00091 last_time = 0;
-<a name="l00092"></a>00092 }
-<a name="l00093"></a>00093 <span class="comment"></span>
-<a name="l00094"></a>00094 <span class="comment"> /**</span>
-<a name="l00095"></a>00095 <span class="comment"> * Re-stat() the file, if necessary. If <tt>throttleRate</tt> seconds have</span>
-<a name="l00096"></a>00096 <span class="comment"> * passed since the last time stat() was called, then the file will be</span>
-<a name="l00097"></a>00097 <span class="comment"> * re-stat()ted.</span>
-<a name="l00098"></a>00098 <span class="comment"> *</span>
-<a name="l00099"></a>00099 <span class="comment"> * The stat information, which may either be the result of a new stat() call</span>
-<a name="l00100"></a>00100 <span class="comment"> * or just the old cached information, is be available in the <tt>info</tt></span>
-<a name="l00101"></a>00101 <span class="comment"> * member.</span>
-<a name="l00102"></a>00102 <span class="comment"> *</span>
-<a name="l00103"></a>00103 <span class="comment"> * @return 0 if the stat() call succeeded or if no stat() was performed,</span>
-<a name="l00104"></a>00104 <span class="comment"> * -1 if something went wrong while statting the file. In the latter</span>
-<a name="l00105"></a>00105 <span class="comment"> * case, <tt>errno</tt> will be populated with an appropriate error code.</span>
-<a name="l00106"></a>00106 <span class="comment"> * @throws SystemException Something went wrong while retrieving the</span>
-<a name="l00107"></a>00107 <span class="comment"> * system time. stat() errors will <em>not</em> result in SystemException</span>
-<a name="l00108"></a>00108 <span class="comment"> * being thrown.</span>
-<a name="l00109"></a>00109 <span class="comment"> * @throws boost::thread_interrupted</span>
-<a name="l00110"></a>00110 <span class="comment"> */</span>
-<a name="l00111"></a>00111 <span class="keywordtype">int</span> refresh(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate) {
-<a name="l00112"></a>00112 time_t currentTime;
-<a name="l00113"></a>00113
-<a name="l00114"></a>00114 <span class="keywordflow">if</span> (expired(last_time, throttleRate, currentTime)) {
-<a name="l00115"></a>00115 last_result = syscalls::stat(filename.c_str(), &info);
-<a name="l00116"></a>00116 last_errno = errno;
-<a name="l00117"></a>00117 last_time = currentTime;
-<a name="l00118"></a>00118 <span class="keywordflow">return</span> last_result;
-<a name="l00119"></a>00119 } <span class="keywordflow">else</span> {
-<a name="l00120"></a>00120 errno = last_errno;
-<a name="l00121"></a>00121 <span class="keywordflow">return</span> last_result;
-<a name="l00122"></a>00122 }
-<a name="l00123"></a>00123 }
-<a name="l00124"></a>00124 };
-<a name="l00125"></a>00125
-<a name="l00126"></a>00126 } <span class="comment">// namespace Passenger</span>
-<a name="l00127"></a>00127
-<a name="l00128"></a>00128 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
-<a name="l00129"></a>00129
-<a name="l00130"></a>00130
-<a name="l00131"></a>00131 <span class="preprocessor">#ifdef __cplusplus</span>
-<a name="l00132"></a>00132 <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
-<a name="l00133"></a>00133 <span class="preprocessor">#endif</span>
-<a name="l00134"></a>00134 <span class="preprocessor"></span><span class="comment"></span>
-<a name="l00135"></a>00135 <span class="comment">/**</span>
-<a name="l00136"></a>00136 <span class="comment"> * CachedMultiFileStat allows one to stat() files at a throttled rate, in order</span>
-<a name="l00137"></a>00137 <span class="comment"> * to minimize stress on the filesystem. It does this by caching the old stat</span>
-<a name="l00138"></a>00138 <span class="comment"> * data for a specified amount of time.</span>
-<a name="l00139"></a>00139 <span class="comment"> *</span>
-<a name="l00140"></a>00140 <span class="comment"> * Unlike CachedFileStat, which can only stat() one specific file per</span>
-<a name="l00141"></a>00141 <span class="comment"> * CachedFileStat object, CachedMultiFileStat can stat() any file. The</span>
-<a name="l00142"></a>00142 <span class="comment"> * number of cached stat() information is limited by the given cache size.</span>
-<a name="l00143"></a>00143 <span class="comment"> *</span>
-<a name="l00144"></a>00144 <span class="comment"> * This class is fully thread-safe.</span>
-<a name="l00145"></a>00145 <span class="comment"> */</span>
-<a name="l00146"></a>00146 <span class="keyword">typedef</span> <span class="keyword">struct </span>CachedMultiFileStat CachedMultiFileStat;
-<a name="l00147"></a>00147
-<a name="l00148"></a>00148 CachedMultiFileStat *cached_multi_file_stat_new(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max_size);
-<a name="l00149"></a>00149 <span class="keywordtype">void</span> cached_multi_file_stat_free(CachedMultiFileStat *mstat);
-<a name="l00150"></a>00150 <span class="keywordtype">int</span> cached_multi_file_stat_perform(CachedMultiFileStat *mstat,
-<a name="l00151"></a>00151 <span class="keyword">const</span> <span class="keywordtype">char</span> *filename,
-<a name="l00152"></a>00152 <span class="keyword">struct</span> stat *buf,
-<a name="l00153"></a>00153 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttle_rate);
-<a name="l00154"></a>00154
-<a name="l00155"></a>00155 <span class="preprocessor">#ifdef __cplusplus</span>
-<a name="l00156"></a>00156 <span class="preprocessor"></span> }
-<a name="l00157"></a>00157 <span class="preprocessor">#endif</span>
-<a name="l00158"></a>00158 <span class="preprocessor"></span>
-<a name="l00159"></a>00159 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_CACHED_FILE_STAT_H_ */</span>
-<a name="l00160"></a>00160
+<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_CACHED_FILE_STAT_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_CACHED_FILE_STAT_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include <sys/stat.h></span>
+<a name="l00029"></a>00029
+<a name="l00030"></a>00030 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00032"></a>00032 <span class="preprocessor">#endif</span>
+<a name="l00033"></a>00033 <span class="preprocessor"></span>
+<a name="l00034"></a>00034 <span class="comment"></span>
+<a name="l00035"></a>00035 <span class="comment">/** C bindings for Passenger::CachedFileStat. */</span>
+<a name="l00036"></a>00036
+<a name="l00037"></a>00037 <span class="keyword">typedef</span> <span class="keyword">struct </span>CachedFileStat CachedFileStat;
+<a name="l00038"></a>00038
+<a name="l00039"></a>00039 CachedFileStat *cached_file_stat_new(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> max_size);
+<a name="l00040"></a>00040 <span class="keywordtype">void</span> cached_file_stat_free(CachedFileStat *cstat);
+<a name="l00041"></a>00041 <span class="keywordtype">int</span> cached_file_stat_perform(CachedFileStat *cstat,
+<a name="l00042"></a>00042 <span class="keyword">const</span> <span class="keywordtype">char</span> *filename,
+<a name="l00043"></a>00043 <span class="keyword">struct</span> stat *buf,
+<a name="l00044"></a>00044 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttle_rate);
+<a name="l00045"></a>00045
+<a name="l00046"></a>00046
+<a name="l00047"></a>00047 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00048"></a>00048 <span class="preprocessor"></span>}
+<a name="l00049"></a>00049 <span class="preprocessor">#endif</span>
+<a name="l00050"></a>00050 <span class="preprocessor"></span>
+<a name="l00051"></a>00051 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_CACHED_FILE_STAT_H_ */</span>
</pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 8 22:35:10 2009 for Passenger by
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 8 22:53:21 2010 for Passenger by
<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>