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
|
<!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: Timer.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>Timer.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_TIMER_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_TIMER_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 <sys/time.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <cerrno></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Passenger {
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">using namespace </span>boost;
<a name="l00036"></a>00036 <span class="keyword">using namespace </span>oxt;
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/**</span>
<a name="l00039"></a>00039 <span class="comment"> * A Timer which one can use to check how much time has elapsed since the</span>
<a name="l00040"></a>00040 <span class="comment"> * timer started. This timer support miliseconds-resolution, but the exact</span>
<a name="l00041"></a>00041 <span class="comment"> * resolution depends on the OS and the hardware.</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * This class is thread-safe.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * @code</span>
<a name="l00046"></a>00046 <span class="comment"> * Timer timer;</span>
<a name="l00047"></a>00047 <span class="comment"> * sleep(10);</span>
<a name="l00048"></a>00048 <span class="comment"> * timer.elapsed(); // => about 10000 (msec)</span>
<a name="l00049"></a>00049 <span class="comment"> * @endcode</span>
<a name="l00050"></a>00050 <span class="comment"> */</span>
<a name="l00051"></a><a class="code" href="classPassenger_1_1Timer.html">00051</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Timer.html" title="A Timer which one can use to check how much time has elapsed since the timer started...">Timer</a> {
<a name="l00052"></a>00052 <span class="keyword">private</span>:
<a name="l00053"></a>00053 <span class="keyword">struct </span>timeval startTime;
<a name="l00054"></a>00054 <span class="keyword">mutable</span> boost::mutex lock;
<a name="l00055"></a>00055 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /**</span>
<a name="l00057"></a>00057 <span class="comment"> * Creates a new Timer object.</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * @param startNow Whether the timer should be started immediately.</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a><a class="code" href="classPassenger_1_1Timer.html#6be9070c1a2d0a9abbd98a1a90f916c6">00061</a> <a class="code" href="classPassenger_1_1Timer.html#6be9070c1a2d0a9abbd98a1a90f916c6" title="Creates a new Timer object.">Timer</a>(<span class="keywordtype">bool</span> startNow = <span class="keyword">true</span>) {
<a name="l00062"></a>00062 <span class="keywordflow">if</span> (startNow) {
<a name="l00063"></a>00063 <a class="code" href="classPassenger_1_1Timer.html#3808e3b519b4d59894ae3390bc19e7a5" title="Start the timer.">start</a>();
<a name="l00064"></a>00064 } <span class="keywordflow">else</span> {
<a name="l00065"></a>00065 <a class="code" href="classPassenger_1_1Timer.html#15aadf8f5b520c18ccd87b9d2bc7e063" title="Stop the timer.">stop</a>();
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment"> /**</span>
<a name="l00070"></a>00070 <span class="comment"> * Start the timer. If the timer was already started, then this will</span>
<a name="l00071"></a>00071 <span class="comment"> * restart the timer.</span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a><a class="code" href="classPassenger_1_1Timer.html#3808e3b519b4d59894ae3390bc19e7a5">00073</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Timer.html#3808e3b519b4d59894ae3390bc19e7a5" title="Start the timer.">start</a>() {
<a name="l00074"></a>00074 <span class="comment">// TODO: We really use should clock_gettime() and the monotonic</span>
<a name="l00075"></a>00075 <span class="comment">// clock whenever possible, instead of gettimeofday()...</span>
<a name="l00076"></a>00076 lock_guard<boost::mutex> l(lock);
<a name="l00077"></a>00077 <span class="keywordtype">int</span> ret;
<a name="l00078"></a>00078 <span class="keywordflow">do</span> {
<a name="l00079"></a>00079 ret = gettimeofday(&startTime, NULL);
<a name="l00080"></a>00080 } <span class="keywordflow">while</span> (ret == -1 && errno == EINTR);
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /**</span>
<a name="l00084"></a>00084 <span class="comment"> * Stop the timer. If there's currently another thread waiting on the wait()</span>
<a name="l00085"></a>00085 <span class="comment"> * call, then that wait() call will block indefinitely until you call start()</span>
<a name="l00086"></a>00086 <span class="comment"> * and sufficient amount of time has elapsed.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a><a class="code" href="classPassenger_1_1Timer.html#15aadf8f5b520c18ccd87b9d2bc7e063">00088</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Timer.html#15aadf8f5b520c18ccd87b9d2bc7e063" title="Stop the timer.">stop</a>() {
<a name="l00089"></a>00089 lock_guard<boost::mutex> l(lock);
<a name="l00090"></a>00090 startTime.tv_sec = 0;
<a name="l00091"></a>00091 startTime.tv_usec = 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"> * Returns the amount of time that has elapsed since the timer was last started,</span>
<a name="l00096"></a>00096 <span class="comment"> * in miliseconds. If the timer is currently stopped, then 0 is returned.</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a><a class="code" href="classPassenger_1_1Timer.html#b65b046b385b6d964f685ada320fe5f2">00098</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classPassenger_1_1Timer.html#b65b046b385b6d964f685ada320fe5f2" title="Returns the amount of time that has elapsed since the timer was last started, in...">elapsed</a>()<span class="keyword"> const </span>{
<a name="l00099"></a>00099 lock_guard<boost::mutex> l(lock);
<a name="l00100"></a>00100 <span class="keywordflow">if</span> (startTime.tv_sec == 0 && startTime.tv_usec == 0) {
<a name="l00101"></a>00101 <span class="keywordflow">return</span> 0;
<a name="l00102"></a>00102 } <span class="keywordflow">else</span> {
<a name="l00103"></a>00103 <span class="keyword">struct </span>timeval t;
<a name="l00104"></a>00104 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> now, beginning;
<a name="l00105"></a>00105 <span class="keywordtype">int</span> ret;
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keywordflow">do</span> {
<a name="l00108"></a>00108 ret = gettimeofday(&t, NULL);
<a name="l00109"></a>00109 } <span class="keywordflow">while</span> (ret == -1 && errno == EINTR);
<a name="l00110"></a>00110 now = (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) t.tv_sec * 1000 + t.tv_usec / 1000;
<a name="l00111"></a>00111 beginning = (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span>) startTime.tv_sec * 1000 + startTime.tv_usec / 1000;
<a name="l00112"></a>00112 <span class="keywordflow">return</span> now - beginning;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /**</span>
<a name="l00117"></a>00117 <span class="comment"> * Wait until <em>time</em> miliseconds have elapsed since the timer</span>
<a name="l00118"></a>00118 <span class="comment"> * was last started.</span>
<a name="l00119"></a>00119 <span class="comment"> */</span>
<a name="l00120"></a><a class="code" href="classPassenger_1_1Timer.html#5f8667ebab3890ddc412b2086dbec14c">00120</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Timer.html#5f8667ebab3890ddc412b2086dbec14c" title="Wait until time miliseconds have elapsed since the timer was last started.">wait</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> time)<span class="keyword"> const </span>{
<a name="l00121"></a>00121 <span class="keywordflow">while</span> (<a class="code" href="classPassenger_1_1Timer.html#b65b046b385b6d964f685ada320fe5f2" title="Returns the amount of time that has elapsed since the timer was last started, in...">elapsed</a>() < time) {
<a name="l00122"></a>00122 syscalls::usleep(25000);
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125 };
<a name="l00126"></a>00126
<a name="l00127"></a>00127 } <span class="comment">// namespace Passenger</span>
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_TIMER_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>
|
