/usr/share/doc/libjuce/apiref/classTimeSliceThread.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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | <!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: TimeSliceThread 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="classTimeSliceThread-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TimeSliceThread Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run some sort of short task.
<a href="classTimeSliceThread.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for TimeSliceThread:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classTimeSliceThread.png" usemap="#TimeSliceThread_map" alt=""/>
<map id="TimeSliceThread_map" name="TimeSliceThread_map">
<area href="classThread.html" title="Encapsulates a thread. " alt="Thread" shape="rect" coords="0,0,106,24"/>
</map>
</div></div>
<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:ad2fa29d3076a7c0b600e297cc18fc9d9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceThread.html#ad2fa29d3076a7c0b600e297cc18fc9d9">TimeSliceThread</a> (const <a class="el" href="classString.html">String</a> &threadName)</td></tr>
<tr class="memdesc:ad2fa29d3076a7c0b600e297cc18fc9d9"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a>. <a href="#ad2fa29d3076a7c0b600e297cc18fc9d9">More...</a><br /></td></tr>
<tr class="separator:ad2fa29d3076a7c0b600e297cc18fc9d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4374e45b3ffabac2abd5ebc04594b8d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceThread.html#aa4374e45b3ffabac2abd5ebc04594b8d">~TimeSliceThread</a> ()</td></tr>
<tr class="memdesc:aa4374e45b3ffabac2abd5ebc04594b8d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa4374e45b3ffabac2abd5ebc04594b8d">More...</a><br /></td></tr>
<tr class="separator:aa4374e45b3ffabac2abd5ebc04594b8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8244dfb9ed53d0c8b10d301d8897d8f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceThread.html#ac8244dfb9ed53d0c8b10d301d8897d8f">addTimeSliceClient</a> (<a class="el" href="classTimeSliceClient.html">TimeSliceClient</a> *client, int millisecondsBeforeStarting=0)</td></tr>
<tr class="memdesc:ac8244dfb9ed53d0c8b10d301d8897d8f"><td class="mdescLeft"> </td><td class="mdescRight">Adds a client to the list. <a href="#ac8244dfb9ed53d0c8b10d301d8897d8f">More...</a><br /></td></tr>
<tr class="separator:ac8244dfb9ed53d0c8b10d301d8897d8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07b538bee2ba11da5b66bd59af25f153"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceThread.html#a07b538bee2ba11da5b66bd59af25f153">removeTimeSliceClient</a> (<a class="el" href="classTimeSliceClient.html">TimeSliceClient</a> *client)</td></tr>
<tr class="memdesc:a07b538bee2ba11da5b66bd59af25f153"><td class="mdescLeft"> </td><td class="mdescRight">Removes a client from the list. <a href="#a07b538bee2ba11da5b66bd59af25f153">More...</a><br /></td></tr>
<tr class="separator:a07b538bee2ba11da5b66bd59af25f153"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58c97295da5d454c299b9252a7a0999d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceThread.html#a58c97295da5d454c299b9252a7a0999d">moveToFrontOfQueue</a> (<a class="el" href="classTimeSliceClient.html">TimeSliceClient</a> *client)</td></tr>
<tr class="memdesc:a58c97295da5d454c299b9252a7a0999d"><td class="mdescLeft"> </td><td class="mdescRight">If the given client is waiting in the queue, it will be moved to the front and given a time-slice as soon as possible. <a href="#a58c97295da5d454c299b9252a7a0999d">More...</a><br /></td></tr>
<tr class="separator:a58c97295da5d454c299b9252a7a0999d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28af6d0122a09584c3490f0c9a55b16c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceThread.html#a28af6d0122a09584c3490f0c9a55b16c">getNumClients</a> () const</td></tr>
<tr class="memdesc:a28af6d0122a09584c3490f0c9a55b16c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of registered clients. <a href="#a28af6d0122a09584c3490f0c9a55b16c">More...</a><br /></td></tr>
<tr class="separator:a28af6d0122a09584c3490f0c9a55b16c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77c63e14007bd1d3329c257189ccb814"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTimeSliceClient.html">TimeSliceClient</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTimeSliceThread.html#a77c63e14007bd1d3329c257189ccb814">getClient</a> (int index) const</td></tr>
<tr class="memdesc:a77c63e14007bd1d3329c257189ccb814"><td class="mdescLeft"> </td><td class="mdescRight">Returns one of the registered clients. <a href="#a77c63e14007bd1d3329c257189ccb814">More...</a><br /></td></tr>
<tr class="separator:a77c63e14007bd1d3329c257189ccb814"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classThread"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classThread')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classThread.html">Thread</a></td></tr>
<tr class="memitem:a9105c0abed75dd620b80c8c5e8b01603 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a9105c0abed75dd620b80c8c5e8b01603">Thread</a> (const <a class="el" href="classString.html">String</a> &threadName, size_t threadStackSize=0)</td></tr>
<tr class="memdesc:a9105c0abed75dd620b80c8c5e8b01603 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Creates a thread. <a href="classThread.html#a9105c0abed75dd620b80c8c5e8b01603">More...</a><br /></td></tr>
<tr class="separator:a9105c0abed75dd620b80c8c5e8b01603 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a026b23628e1727050e864e00489c0baf inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a026b23628e1727050e864e00489c0baf">~Thread</a> ()</td></tr>
<tr class="memdesc:a026b23628e1727050e864e00489c0baf inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classThread.html#a026b23628e1727050e864e00489c0baf">More...</a><br /></td></tr>
<tr class="separator:a026b23628e1727050e864e00489c0baf inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae90dfabab3e1776cf01a26e7ee3a620 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#aae90dfabab3e1776cf01a26e7ee3a620">run</a> ()=0</td></tr>
<tr class="memdesc:aae90dfabab3e1776cf01a26e7ee3a620 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Must be implemented to perform the thread's actual code. <a href="classThread.html#aae90dfabab3e1776cf01a26e7ee3a620">More...</a><br /></td></tr>
<tr class="separator:aae90dfabab3e1776cf01a26e7ee3a620 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5502205d727c00752f95af27a063d983 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a5502205d727c00752f95af27a063d983">startThread</a> ()</td></tr>
<tr class="memdesc:a5502205d727c00752f95af27a063d983 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Starts the thread running. <a href="classThread.html#a5502205d727c00752f95af27a063d983">More...</a><br /></td></tr>
<tr class="separator:a5502205d727c00752f95af27a063d983 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc4aff2ceb97b0f16a0a08132315a900 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#acc4aff2ceb97b0f16a0a08132315a900">startThread</a> (int priority)</td></tr>
<tr class="memdesc:acc4aff2ceb97b0f16a0a08132315a900 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Starts the thread with a given priority. <a href="classThread.html#acc4aff2ceb97b0f16a0a08132315a900">More...</a><br /></td></tr>
<tr class="separator:acc4aff2ceb97b0f16a0a08132315a900 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18583d51411d6a34c59b63f0adff4697 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a18583d51411d6a34c59b63f0adff4697">stopThread</a> (int timeOutMilliseconds)</td></tr>
<tr class="memdesc:a18583d51411d6a34c59b63f0adff4697 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to stop the thread running. <a href="classThread.html#a18583d51411d6a34c59b63f0adff4697">More...</a><br /></td></tr>
<tr class="separator:a18583d51411d6a34c59b63f0adff4697 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc4e7957f1c3a3f98218324c0fdc3beb inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#afc4e7957f1c3a3f98218324c0fdc3beb">isThreadRunning</a> () const</td></tr>
<tr class="memdesc:afc4e7957f1c3a3f98218324c0fdc3beb inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the thread is currently active. <a href="classThread.html#afc4e7957f1c3a3f98218324c0fdc3beb">More...</a><br /></td></tr>
<tr class="separator:afc4e7957f1c3a3f98218324c0fdc3beb inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affe168e27c6ee50b0d10522810772268 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#affe168e27c6ee50b0d10522810772268">signalThreadShouldExit</a> ()</td></tr>
<tr class="memdesc:affe168e27c6ee50b0d10522810772268 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Sets a flag to tell the thread it should stop. <a href="classThread.html#affe168e27c6ee50b0d10522810772268">More...</a><br /></td></tr>
<tr class="separator:affe168e27c6ee50b0d10522810772268 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab89b68d53514e0b3978460aab3202fd7 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#ab89b68d53514e0b3978460aab3202fd7">threadShouldExit</a> () const</td></tr>
<tr class="memdesc:ab89b68d53514e0b3978460aab3202fd7 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the thread has been told to stop running. <a href="classThread.html#ab89b68d53514e0b3978460aab3202fd7">More...</a><br /></td></tr>
<tr class="separator:ab89b68d53514e0b3978460aab3202fd7 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9b6494f25d5d8eb07ed6fc96178eac5 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#ad9b6494f25d5d8eb07ed6fc96178eac5">waitForThreadToExit</a> (int timeOutMilliseconds) const</td></tr>
<tr class="memdesc:ad9b6494f25d5d8eb07ed6fc96178eac5 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the thread to stop. <a href="classThread.html#ad9b6494f25d5d8eb07ed6fc96178eac5">More...</a><br /></td></tr>
<tr class="separator:ad9b6494f25d5d8eb07ed6fc96178eac5 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0975d9ee9f403f5f82287fcce4a7168f inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a0975d9ee9f403f5f82287fcce4a7168f">setPriority</a> (int priority)</td></tr>
<tr class="memdesc:a0975d9ee9f403f5f82287fcce4a7168f inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Changes the thread's priority. <a href="classThread.html#a0975d9ee9f403f5f82287fcce4a7168f">More...</a><br /></td></tr>
<tr class="separator:a0975d9ee9f403f5f82287fcce4a7168f inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a614605563fceeac6f03d507bc35bdce4 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a614605563fceeac6f03d507bc35bdce4">setAffinityMask</a> (<a class="el" href="juce__MathsFunctions_8h.html#a1134b580f8da4de94ca6b1de4d37975e">uint32</a> affinityMask)</td></tr>
<tr class="memdesc:a614605563fceeac6f03d507bc35bdce4 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Sets the affinity mask for the thread. <a href="classThread.html#a614605563fceeac6f03d507bc35bdce4">More...</a><br /></td></tr>
<tr class="separator:a614605563fceeac6f03d507bc35bdce4 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99ac29606fd57fd418dfd169939f7b25 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a99ac29606fd57fd418dfd169939f7b25">wait</a> (int timeOutMilliseconds) const</td></tr>
<tr class="memdesc:a99ac29606fd57fd418dfd169939f7b25 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Makes the thread wait for a notification. <a href="classThread.html#a99ac29606fd57fd418dfd169939f7b25">More...</a><br /></td></tr>
<tr class="separator:a99ac29606fd57fd418dfd169939f7b25 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b4d5a1ffaa35cc13f323a0524012a2b inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a0b4d5a1ffaa35cc13f323a0524012a2b">notify</a> () const</td></tr>
<tr class="memdesc:a0b4d5a1ffaa35cc13f323a0524012a2b inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Wakes up the thread. <a href="classThread.html#a0b4d5a1ffaa35cc13f323a0524012a2b">More...</a><br /></td></tr>
<tr class="separator:a0b4d5a1ffaa35cc13f323a0524012a2b inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39ca822734b9b20ab32eeba774c9a803 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classThread.html#a077e20855a3c974c2fc6f9e7caa8412c">ThreadID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a39ca822734b9b20ab32eeba774c9a803">getThreadId</a> () const noexcept</td></tr>
<tr class="memdesc:a39ca822734b9b20ab32eeba774c9a803 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of this thread. <a href="classThread.html#a39ca822734b9b20ab32eeba774c9a803">More...</a><br /></td></tr>
<tr class="separator:a39ca822734b9b20ab32eeba774c9a803 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d416be2e075de0be64ba958ac0efc17 inherit pub_methods_classThread"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a0d416be2e075de0be64ba958ac0efc17">getThreadName</a> () const</td></tr>
<tr class="memdesc:a0d416be2e075de0be64ba958ac0efc17 inherit pub_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the thread. <a href="classThread.html#a0d416be2e075de0be64ba958ac0efc17">More...</a><br /></td></tr>
<tr class="separator:a0d416be2e075de0be64ba958ac0efc17 inherit pub_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classThread"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classThread')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classThread.html">Thread</a></td></tr>
<tr class="memitem:a077e20855a3c974c2fc6f9e7caa8412c inherit pub_types_classThread"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a077e20855a3c974c2fc6f9e7caa8412c">ThreadID</a></td></tr>
<tr class="memdesc:a077e20855a3c974c2fc6f9e7caa8412c inherit pub_types_classThread"><td class="mdescLeft"> </td><td class="mdescRight">A value type used for thread IDs. <a href="classThread.html#a077e20855a3c974c2fc6f9e7caa8412c">More...</a><br /></td></tr>
<tr class="separator:a077e20855a3c974c2fc6f9e7caa8412c inherit pub_types_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classThread"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classThread')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classThread.html">Thread</a></td></tr>
<tr class="memitem:ac92778089556fd0b5ab9c31557669ce8 inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#ac92778089556fd0b5ab9c31557669ce8">currentThreadShouldExit</a> ()</td></tr>
<tr class="memdesc:ac92778089556fd0b5ab9c31557669ce8 inherit pub_static_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the current thread has been told to stop running. <a href="classThread.html#ac92778089556fd0b5ab9c31557669ce8">More...</a><br /></td></tr>
<tr class="separator:ac92778089556fd0b5ab9c31557669ce8 inherit pub_static_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a777202bb5aa9ce7f57605674b100f4 inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a9a777202bb5aa9ce7f57605674b100f4">setCurrentThreadPriority</a> (int priority)</td></tr>
<tr class="memdesc:a9a777202bb5aa9ce7f57605674b100f4 inherit pub_static_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Changes the priority of the caller thread. <a href="classThread.html#a9a777202bb5aa9ce7f57605674b100f4">More...</a><br /></td></tr>
<tr class="separator:a9a777202bb5aa9ce7f57605674b100f4 inherit pub_static_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac21eb5ae8c32bc2ecacba904f3411802 inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#ac21eb5ae8c32bc2ecacba904f3411802">setCurrentThreadAffinityMask</a> (<a class="el" href="juce__MathsFunctions_8h.html#a1134b580f8da4de94ca6b1de4d37975e">uint32</a> affinityMask)</td></tr>
<tr class="memdesc:ac21eb5ae8c32bc2ecacba904f3411802 inherit pub_static_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Changes the affinity mask for the caller thread. <a href="classThread.html#ac21eb5ae8c32bc2ecacba904f3411802">More...</a><br /></td></tr>
<tr class="separator:ac21eb5ae8c32bc2ecacba904f3411802 inherit pub_static_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ee1ddee32aa82ac90bc567cb7427926 inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a4ee1ddee32aa82ac90bc567cb7427926">sleep</a> (int milliseconds)</td></tr>
<tr class="separator:a4ee1ddee32aa82ac90bc567cb7427926 inherit pub_static_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf47a344b3b715e49ffcbc6119c72cdc inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#aaf47a344b3b715e49ffcbc6119c72cdc">yield</a> ()</td></tr>
<tr class="memdesc:aaf47a344b3b715e49ffcbc6119c72cdc inherit pub_static_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Yields the calling thread's current time-slot. <a href="classThread.html#aaf47a344b3b715e49ffcbc6119c72cdc">More...</a><br /></td></tr>
<tr class="separator:aaf47a344b3b715e49ffcbc6119c72cdc inherit pub_static_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd4762b20144186ffc28280cedd224e9 inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classThread.html#a077e20855a3c974c2fc6f9e7caa8412c">ThreadID</a> <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#abd4762b20144186ffc28280cedd224e9">getCurrentThreadId</a> ()</td></tr>
<tr class="memdesc:abd4762b20144186ffc28280cedd224e9 inherit pub_static_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Returns an id that identifies the caller thread. <a href="classThread.html#abd4762b20144186ffc28280cedd224e9">More...</a><br /></td></tr>
<tr class="separator:abd4762b20144186ffc28280cedd224e9 inherit pub_static_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40a9f45ea3ff9a7d39a50f78059640cd inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classThread.html">Thread</a> *<a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a40a9f45ea3ff9a7d39a50f78059640cd">getCurrentThread</a> ()</td></tr>
<tr class="memdesc:a40a9f45ea3ff9a7d39a50f78059640cd inherit pub_static_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Finds the thread object that is currently running. <a href="classThread.html#a40a9f45ea3ff9a7d39a50f78059640cd">More...</a><br /></td></tr>
<tr class="separator:a40a9f45ea3ff9a7d39a50f78059640cd inherit pub_static_methods_classThread"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ba2a683ea8111c08db83092360b7226 inherit pub_static_methods_classThread"><td class="memItemLeft" align="right" valign="top">static void <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classThread.html#a8ba2a683ea8111c08db83092360b7226">setCurrentThreadName</a> (const <a class="el" href="classString.html">String</a> &newThreadName)</td></tr>
<tr class="memdesc:a8ba2a683ea8111c08db83092360b7226 inherit pub_static_methods_classThread"><td class="mdescLeft"> </td><td class="mdescRight">Changes the name of the caller thread. <a href="classThread.html#a8ba2a683ea8111c08db83092360b7226">More...</a><br /></td></tr>
<tr class="separator:a8ba2a683ea8111c08db83092360b7226 inherit pub_static_methods_classThread"><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 thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run some sort of short task. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classTimeSliceClient.html" title="Used by the TimeSliceThread class. ">TimeSliceClient</a>, <a class="el" href="classThread.html" title="Encapsulates a thread. ">Thread</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad2fa29d3076a7c0b600e297cc18fc9d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2fa29d3076a7c0b600e297cc18fc9d9">§ </a></span>TimeSliceThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TimeSliceThread::TimeSliceThread </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>threadName</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classTimeSliceThread.html" title="A thread that keeps a list of clients, and calls each one in turn, giving them all a chance to run so...">TimeSliceThread</a>. </p>
<p>When first created, the thread is not running. Use the <a class="el" href="classThread.html#a5502205d727c00752f95af27a063d983" title="Starts the thread running. ">startThread()</a> method to start it. </p>
</div>
</div>
<a id="aa4374e45b3ffabac2abd5ebc04594b8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4374e45b3ffabac2abd5ebc04594b8d">§ </a></span>~TimeSliceThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TimeSliceThread::~TimeSliceThread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Deleting a <a class="el" href="classThread.html" title="Encapsulates a thread. ">Thread</a> object that is running will only give the thread a brief opportunity to stop itself cleanly, so it's recommended that you should always call <a class="el" href="classThread.html#a18583d51411d6a34c59b63f0adff4697" title="Attempts to stop the thread running. ">stopThread()</a> with a decent timeout before deleting, to avoid the thread being forcibly killed (which is a Bad Thing). </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac8244dfb9ed53d0c8b10d301d8897d8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8244dfb9ed53d0c8b10d301d8897d8f">§ </a></span>addTimeSliceClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeSliceThread::addTimeSliceClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTimeSliceClient.html">TimeSliceClient</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>millisecondsBeforeStarting</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a client to the list. </p>
<p>The client's callbacks will start after the number of milliseconds specified by millisecondsBeforeStarting (and this may happen before this method has returned). </p>
</div>
</div>
<a id="a07b538bee2ba11da5b66bd59af25f153"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07b538bee2ba11da5b66bd59af25f153">§ </a></span>removeTimeSliceClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeSliceThread::removeTimeSliceClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTimeSliceClient.html">TimeSliceClient</a> * </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a client from the list. </p>
<p>This method will make sure that all callbacks to the client have completely finished before the method returns. </p>
</div>
</div>
<a id="a58c97295da5d454c299b9252a7a0999d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58c97295da5d454c299b9252a7a0999d">§ </a></span>moveToFrontOfQueue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TimeSliceThread::moveToFrontOfQueue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTimeSliceClient.html">TimeSliceClient</a> * </td>
<td class="paramname"><em>client</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>If the given client is waiting in the queue, it will be moved to the front and given a time-slice as soon as possible. </p>
<p>If the specified client has not been added, nothing will happen. </p>
</div>
</div>
<a id="a28af6d0122a09584c3490f0c9a55b16c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28af6d0122a09584c3490f0c9a55b16c">§ </a></span>getNumClients()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int TimeSliceThread::getNumClients </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of registered clients. </p>
</div>
</div>
<a id="a77c63e14007bd1d3329c257189ccb814"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77c63e14007bd1d3329c257189ccb814">§ </a></span>getClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTimeSliceClient.html">TimeSliceClient</a>* TimeSliceThread::getClient </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns one of the registered clients. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__TimeSliceThread_8h.html">juce_TimeSliceThread.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|