/usr/share/doc/libjuce/apiref/classHighResolutionTimer.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: HighResolutionTimer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classHighResolutionTimer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">HighResolutionTimer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A high-resolution periodic timer.
<a href="classHighResolutionTimer.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5eb450755a308ebc74e30085af52082b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classHighResolutionTimer.html#a5eb450755a308ebc74e30085af52082b">~HighResolutionTimer</a> ()</td></tr>
<tr class="memdesc:a5eb450755a308ebc74e30085af52082b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a5eb450755a308ebc74e30085af52082b">More...</a><br /></td></tr>
<tr class="separator:a5eb450755a308ebc74e30085af52082b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38fac5960301220b28b687817e4e7598"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHighResolutionTimer.html#a38fac5960301220b28b687817e4e7598">hiResTimerCallback</a> ()=0</td></tr>
<tr class="memdesc:a38fac5960301220b28b687817e4e7598"><td class="mdescLeft"> </td><td class="mdescRight">The user-defined callback routine that actually gets called periodically. <a href="#a38fac5960301220b28b687817e4e7598">More...</a><br /></td></tr>
<tr class="separator:a38fac5960301220b28b687817e4e7598"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d3709eee45c33f0d2095ab80121a965"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHighResolutionTimer.html#a9d3709eee45c33f0d2095ab80121a965">startTimer</a> (int intervalInMilliseconds)</td></tr>
<tr class="memdesc:a9d3709eee45c33f0d2095ab80121a965"><td class="mdescLeft"> </td><td class="mdescRight">Starts the timer and sets the length of interval required. <a href="#a9d3709eee45c33f0d2095ab80121a965">More...</a><br /></td></tr>
<tr class="separator:a9d3709eee45c33f0d2095ab80121a965"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a141251dfd58c8564709a15da52dffd3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classHighResolutionTimer.html#a141251dfd58c8564709a15da52dffd3a">stopTimer</a> ()</td></tr>
<tr class="memdesc:a141251dfd58c8564709a15da52dffd3a"><td class="mdescLeft"> </td><td class="mdescRight">Stops the timer. <a href="#a141251dfd58c8564709a15da52dffd3a">More...</a><br /></td></tr>
<tr class="separator:a141251dfd58c8564709a15da52dffd3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a628e5e8a30df147af372818baa96cf96"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classHighResolutionTimer.html#a628e5e8a30df147af372818baa96cf96">isTimerRunning</a> () const noexcept</td></tr>
<tr class="memdesc:a628e5e8a30df147af372818baa96cf96"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the timer has been started. <a href="#a628e5e8a30df147af372818baa96cf96">More...</a><br /></td></tr>
<tr class="separator:a628e5e8a30df147af372818baa96cf96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96e6af2a70291b57cba40155cb4cbc01"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classHighResolutionTimer.html#a96e6af2a70291b57cba40155cb4cbc01">getTimerInterval</a> () const noexcept</td></tr>
<tr class="memdesc:a96e6af2a70291b57cba40155cb4cbc01"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timer's interval. <a href="#a96e6af2a70291b57cba40155cb4cbc01">More...</a><br /></td></tr>
<tr class="separator:a96e6af2a70291b57cba40155cb4cbc01"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ac79eb2389b1d52cd4a387836fe9ce860"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classHighResolutionTimer.html#ac79eb2389b1d52cd4a387836fe9ce860">HighResolutionTimer</a> ()</td></tr>
<tr class="memdesc:ac79eb2389b1d52cd4a387836fe9ce860"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classHighResolutionTimer.html" title="A high-resolution periodic timer. ">HighResolutionTimer</a>. <a href="#ac79eb2389b1d52cd4a387836fe9ce860">More...</a><br /></td></tr>
<tr class="separator:ac79eb2389b1d52cd4a387836fe9ce860"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A high-resolution periodic timer. </p>
<p>This provides accurately-timed regular callbacks. Unlike the normal <a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a> class, this one uses a dedicated thread, not the message thread, so is far more stable and precise.</p>
<p>You should only use this class in situations where you really need accuracy, because unlike the normal <a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a> class, which is very lightweight and cheap to start/stop, the <a class="el" href="classHighResolutionTimer.html" title="A high-resolution periodic timer. ">HighResolutionTimer</a> will use far more resources, and starting/stopping it may involve launching and killing threads.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classTimer.html" title="Makes repeated callbacks to a virtual method at a specified time interval. ">Timer</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac79eb2389b1d52cd4a387836fe9ce860"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac79eb2389b1d52cd4a387836fe9ce860">§ </a></span>HighResolutionTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">HighResolutionTimer::HighResolutionTimer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classHighResolutionTimer.html" title="A high-resolution periodic timer. ">HighResolutionTimer</a>. </p>
<p>When created, the timer is stopped, so use <a class="el" href="classHighResolutionTimer.html#a9d3709eee45c33f0d2095ab80121a965" title="Starts the timer and sets the length of interval required. ">startTimer()</a> to get it going. </p>
</div>
</div>
<a id="a5eb450755a308ebc74e30085af52082b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5eb450755a308ebc74e30085af52082b">§ </a></span>~HighResolutionTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual HighResolutionTimer::~HighResolutionTimer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a38fac5960301220b28b687817e4e7598"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38fac5960301220b28b687817e4e7598">§ </a></span>hiResTimerCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void HighResolutionTimer::hiResTimerCallback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The user-defined callback routine that actually gets called periodically. </p>
<p>This will be called on a dedicated timer thread, so make sure your implementation is thread-safe!</p>
<p>It's perfectly ok to call <a class="el" href="classHighResolutionTimer.html#a9d3709eee45c33f0d2095ab80121a965" title="Starts the timer and sets the length of interval required. ">startTimer()</a> or <a class="el" href="classHighResolutionTimer.html#a141251dfd58c8564709a15da52dffd3a" title="Stops the timer. ">stopTimer()</a> from within this callback to change the subsequent intervals. </p>
</div>
</div>
<a id="a9d3709eee45c33f0d2095ab80121a965"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d3709eee45c33f0d2095ab80121a965">§ </a></span>startTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HighResolutionTimer::startTimer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>intervalInMilliseconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the timer and sets the length of interval required. </p>
<p>If the timer is already started, this will reset its counter, so the time between calling this method and the next timer callback will not be less than the interval length passed in.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">intervalInMilliseconds</td><td>the interval to use (any values less than 1 will be rounded up to 1) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a141251dfd58c8564709a15da52dffd3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a141251dfd58c8564709a15da52dffd3a">§ </a></span>stopTimer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void HighResolutionTimer::stopTimer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the timer. </p>
<p>This method may block while it waits for pending callbacks to complete. Once it returns, no more callbacks will be made. If it is called from the timer's own thread, it will cancel the timer after the current callback returns. </p>
</div>
</div>
<a id="a628e5e8a30df147af372818baa96cf96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a628e5e8a30df147af372818baa96cf96">§ </a></span>isTimerRunning()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool HighResolutionTimer::isTimerRunning </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the timer has been started. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the timer is running. </dd></dl>
</div>
</div>
<a id="a96e6af2a70291b57cba40155cb4cbc01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96e6af2a70291b57cba40155cb4cbc01">§ </a></span>getTimerInterval()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int HighResolutionTimer::getTimerInterval </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the timer's interval. </p>
<dl class="section return"><dt>Returns</dt><dd>the timer's interval in milliseconds if it's running, or 0 if it's not. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__HighResolutionTimer_8h.html">juce_HighResolutionTimer.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|