1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
<!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: SystemTime.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 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 List</span></a></li>
</ul>
</div>
<h1>SystemTime.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 & 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_SYSTEM_TIME_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_SYSTEM_TIME_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <boost/thread.hpp></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <oxt/system_calls.hpp></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "Exceptions.h"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>Passenger {
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">using namespace </span>oxt;
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">namespace </span>SystemTimeData {
<a name="l00037"></a>00037 <span class="keyword">extern</span> <span class="keywordtype">bool</span> hasForcedValue;
<a name="l00038"></a>00038 <span class="keyword">extern</span> time_t forcedValue;
<a name="l00039"></a>00039 <span class="keyword">extern</span> <span class="keywordtype">bool</span> hasForcedMsecValue;
<a name="l00040"></a>00040 <span class="keyword">extern</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> forcedMsecValue;
<a name="l00041"></a>00041 <span class="keyword">extern</span> <span class="keywordtype">bool</span> hasForcedUsecValue;
<a name="l00042"></a>00042 <span class="keyword">extern</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> forcedUsecValue;
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/**</span>
<a name="l00046"></a>00046 <span class="comment"> * This class allows one to obtain the system time, similar to time() and</span>
<a name="l00047"></a>00047 <span class="comment"> * gettimeofday(). Unlike time(), it is possible to force a certain time</span>
<a name="l00048"></a>00048 <span class="comment"> * to be returned, which is useful for testing code that depends on the</span>
<a name="l00049"></a>00049 <span class="comment"> * system time.</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * get() provides seconds resolution while getMsec() provides milliseconds</span>
<a name="l00052"></a>00052 <span class="comment"> * resolution. Both clocks can be independently forced to a certain value</span>
<a name="l00053"></a>00053 <span class="comment"> * through force() and forceMsec().</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a><a class="code" href="classPassenger_1_1SystemTime.html">00055</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1SystemTime.html" title="This class allows one to obtain the system time, similar to time() and gettimeofday()...">SystemTime</a> {
<a name="l00056"></a>00056 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /**</span>
<a name="l00058"></a>00058 <span class="comment"> * Returns the time since the Epoch, measured in seconds. Or, if a time</span>
<a name="l00059"></a>00059 <span class="comment"> * was forced with force(), then the forced time is returned instead.</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * @throws TimeRetrievalException Something went wrong while retrieving the time.</span>
<a name="l00062"></a>00062 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00063"></a>00063 <span class="comment"> */</span>
<a name="l00064"></a><a class="code" href="classPassenger_1_1SystemTime.html#d643b3e5748ee929e013517e6aca046c">00064</a> <span class="keyword">static</span> time_t <span class="keyword">get</span>() {
<a name="l00065"></a>00065 <span class="keywordflow">if</span> (SystemTimeData::hasForcedValue) {
<a name="l00066"></a>00066 <span class="keywordflow">return</span> SystemTimeData::forcedValue;
<a name="l00067"></a>00067 } <span class="keywordflow">else</span> {
<a name="l00068"></a>00068 time_t ret = syscalls::time(NULL);
<a name="l00069"></a>00069 <span class="keywordflow">if</span> (ret == -1) {
<a name="l00070"></a>00070 <span class="keywordtype">int</span> e = errno;
<a name="l00071"></a>00071 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a>(
<a name="l00072"></a>00072 <span class="stringliteral">"Unable to retrieve the system time"</span>,
<a name="l00073"></a>00073 e);
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075 <span class="keywordflow">return</span> ret;
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment"> /**</span>
<a name="l00080"></a>00080 <span class="comment"> * Returns the time since the Epoch, measured in milliseconds. Or, if a</span>
<a name="l00081"></a>00081 <span class="comment"> * time was forced with forceMsec(), then the forced time is returned instead.</span>
<a name="l00082"></a>00082 <span class="comment"> *</span>
<a name="l00083"></a>00083 <span class="comment"> * @throws TimeRetrievalException Something went wrong while retrieving the time.</span>
<a name="l00084"></a>00084 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a><a class="code" href="classPassenger_1_1SystemTime.html#7573bebcacde25571ee1072b046a21a6">00086</a> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classPassenger_1_1SystemTime.html#7573bebcacde25571ee1072b046a21a6" title="Returns the time since the Epoch, measured in milliseconds.">getMsec</a>() {
<a name="l00087"></a>00087 <span class="keywordflow">if</span> (SystemTimeData::hasForcedMsecValue) {
<a name="l00088"></a>00088 <span class="keywordflow">return</span> SystemTimeData::forcedMsecValue;
<a name="l00089"></a>00089 } <span class="keywordflow">else</span> {
<a name="l00090"></a>00090 <span class="keyword">struct </span>timeval t;
<a name="l00091"></a>00091 <span class="keywordtype">int</span> ret;
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordflow">do</span> {
<a name="l00094"></a>00094 ret = gettimeofday(&t, NULL);
<a name="l00095"></a>00095 } <span class="keywordflow">while</span> (ret == -1 && errno == EINTR);
<a name="l00096"></a>00096 <span class="keywordflow">if</span> (ret == -1) {
<a name="l00097"></a>00097 <span class="keywordtype">int</span> e = errno;
<a name="l00098"></a>00098 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a>(
<a name="l00099"></a>00099 <span class="stringliteral">"Unable to retrieve the system time"</span>,
<a name="l00100"></a>00100 e);
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102 <span class="keywordflow">return</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span>) t.tv_sec * 1000 + t.tv_usec / 1000;
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment"> /**</span>
<a name="l00107"></a>00107 <span class="comment"> * Returns the time since the Epoch, measured in microseconds. Or, if a</span>
<a name="l00108"></a>00108 <span class="comment"> * time was forced with forceUsec(), then the forced time is returned instead.</span>
<a name="l00109"></a>00109 <span class="comment"> *</span>
<a name="l00110"></a>00110 <span class="comment"> * @throws TimeRetrievalException Something went wrong while retrieving the time.</span>
<a name="l00111"></a>00111 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a><a class="code" href="classPassenger_1_1SystemTime.html#4e7110f4fb3fa2bfd646608f0ae8249d">00113</a> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classPassenger_1_1SystemTime.html#4e7110f4fb3fa2bfd646608f0ae8249d" title="Returns the time since the Epoch, measured in microseconds.">getUsec</a>() {
<a name="l00114"></a>00114 <span class="keywordflow">if</span> (SystemTimeData::hasForcedUsecValue) {
<a name="l00115"></a>00115 <span class="keywordflow">return</span> SystemTimeData::forcedUsecValue;
<a name="l00116"></a>00116 } <span class="keywordflow">else</span> {
<a name="l00117"></a>00117 <span class="keyword">struct </span>timeval t;
<a name="l00118"></a>00118 <span class="keywordtype">int</span> ret;
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="keywordflow">do</span> {
<a name="l00121"></a>00121 ret = gettimeofday(&t, NULL);
<a name="l00122"></a>00122 } <span class="keywordflow">while</span> (ret == -1 && errno == EINTR);
<a name="l00123"></a>00123 <span class="keywordflow">if</span> (ret == -1) {
<a name="l00124"></a>00124 <span class="keywordtype">int</span> e = errno;
<a name="l00125"></a>00125 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time().">TimeRetrievalException</a>(
<a name="l00126"></a>00126 <span class="stringliteral">"Unable to retrieve the system time"</span>,
<a name="l00127"></a>00127 e);
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129 <span class="keywordflow">return</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span>) t.tv_sec * 1000000 + t.tv_usec;
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment"> /**</span>
<a name="l00134"></a>00134 <span class="comment"> * Force get() to return the given value.</span>
<a name="l00135"></a>00135 <span class="comment"> */</span>
<a name="l00136"></a><a class="code" href="classPassenger_1_1SystemTime.html#e15eaa6cdbbf8ab91ff740a0ca8ad57b">00136</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1SystemTime.html#e15eaa6cdbbf8ab91ff740a0ca8ad57b" title="Force get() to return the given value.">force</a>(time_t value) {
<a name="l00137"></a>00137 SystemTimeData::hasForcedValue = <span class="keyword">true</span>;
<a name="l00138"></a>00138 SystemTimeData::forcedValue = value;
<a name="l00139"></a>00139 }
<a name="l00140"></a>00140 <span class="comment"></span>
<a name="l00141"></a>00141 <span class="comment"> /**</span>
<a name="l00142"></a>00142 <span class="comment"> * Force getMsec() to return the given value.</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a><a class="code" href="classPassenger_1_1SystemTime.html#76e60fd47ab1f675650b1132b7c10c4c">00144</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1SystemTime.html#76e60fd47ab1f675650b1132b7c10c4c" title="Force getMsec() to return the given value.">forceMsec</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> value) {
<a name="l00145"></a>00145 SystemTimeData::hasForcedMsecValue = <span class="keyword">true</span>;
<a name="l00146"></a>00146 SystemTimeData::forcedMsecValue = value;
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment"> /**</span>
<a name="l00150"></a>00150 <span class="comment"> * Force getUsec() to return the given value.</span>
<a name="l00151"></a>00151 <span class="comment"> */</span>
<a name="l00152"></a><a class="code" href="classPassenger_1_1SystemTime.html#6d4c44acefc39a576ec3f9e628c88ca5">00152</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1SystemTime.html#6d4c44acefc39a576ec3f9e628c88ca5" title="Force getUsec() to return the given value.">forceUsec</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> value) {
<a name="l00153"></a>00153 SystemTimeData::hasForcedUsecValue = <span class="keyword">true</span>;
<a name="l00154"></a>00154 SystemTimeData::forcedUsecValue = value;
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment"> /**</span>
<a name="l00158"></a>00158 <span class="comment"> * Release the previously forced seconds value, so that get()</span>
<a name="l00159"></a>00159 <span class="comment"> * returns the system time once again.</span>
<a name="l00160"></a>00160 <span class="comment"> */</span>
<a name="l00161"></a><a class="code" href="classPassenger_1_1SystemTime.html#aa31ee319abe639741327a535c6d22fd">00161</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1SystemTime.html#aa31ee319abe639741327a535c6d22fd" title="Release the previously forced seconds value, so that get() returns the system time...">release</a>() {
<a name="l00162"></a>00162 SystemTimeData::hasForcedValue = <span class="keyword">false</span>;
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164 <span class="comment"></span>
<a name="l00165"></a>00165 <span class="comment"> /**</span>
<a name="l00166"></a>00166 <span class="comment"> * Release the previously forced msec value, so that getMsec()</span>
<a name="l00167"></a>00167 <span class="comment"> * returns the system time once again.</span>
<a name="l00168"></a>00168 <span class="comment"> */</span>
<a name="l00169"></a><a class="code" href="classPassenger_1_1SystemTime.html#0177ab20f22dca37889261aebbe6519d">00169</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1SystemTime.html#0177ab20f22dca37889261aebbe6519d" title="Release the previously forced msec value, so that getMsec() returns the system time...">releaseMsec</a>() {
<a name="l00170"></a>00170 SystemTimeData::hasForcedMsecValue = <span class="keyword">false</span>;
<a name="l00171"></a>00171 }
<a name="l00172"></a>00172 <span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment"> /**</span>
<a name="l00174"></a>00174 <span class="comment"> * Release the previously forced usec value, so that getUsec()</span>
<a name="l00175"></a>00175 <span class="comment"> * returns the system time once again.</span>
<a name="l00176"></a>00176 <span class="comment"> */</span>
<a name="l00177"></a><a class="code" href="classPassenger_1_1SystemTime.html#e087e2d9503dea21b60d581e4369b235">00177</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1SystemTime.html#e087e2d9503dea21b60d581e4369b235" title="Release the previously forced usec value, so that getUsec() returns the system time...">releaseUsec</a>() {
<a name="l00178"></a>00178 SystemTimeData::hasForcedUsecValue = <span class="keyword">false</span>;
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180 <span class="comment"></span>
<a name="l00181"></a>00181 <span class="comment"> /**</span>
<a name="l00182"></a>00182 <span class="comment"> * Release all previously forced values, so that get(), getMsec()</span>
<a name="l00183"></a>00183 <span class="comment"> * and getUsec() return the system time once again.</span>
<a name="l00184"></a>00184 <span class="comment"> */</span>
<a name="l00185"></a><a class="code" href="classPassenger_1_1SystemTime.html#72a1636723f21458d8ba3b504cd56ea9">00185</a> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1SystemTime.html#72a1636723f21458d8ba3b504cd56ea9" title="Release all previously forced values, so that get(), getMsec() and getUsec() return...">releaseAll</a>() {
<a name="l00186"></a>00186 SystemTimeData::hasForcedValue = <span class="keyword">false</span>;
<a name="l00187"></a>00187 SystemTimeData::hasForcedMsecValue = <span class="keyword">false</span>;
<a name="l00188"></a>00188 SystemTimeData::hasForcedUsecValue = <span class="keyword">false</span>;
<a name="l00189"></a>00189 }
<a name="l00190"></a>00190 };
<a name="l00191"></a>00191
<a name="l00192"></a>00192 } <span class="comment">// namespace Passenger</span>
<a name="l00193"></a>00193
<a name="l00194"></a>00194 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SYSTEM_TIME_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 8 22:53:22 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>
|
