/usr/share/doc/libjuce/apiref/classMessageManager.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 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 | <!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: MessageManager 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="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classMessageManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MessageManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class is in charge of the application's event-dispatch loop.
<a href="classMessageManager.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager_1_1MessageBase.html">MessageBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal class used as the base class for all message objects. <a href="classMessageManager_1_1MessageBase.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a3084a3a75717db0f7f05604f2956ff65"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a3084a3a75717db0f7f05604f2956ff65">runDispatchLoop</a> ()</td></tr>
<tr class="memdesc:a3084a3a75717db0f7f05604f2956ff65"><td class="mdescLeft"> </td><td class="mdescRight">Runs the event dispatch loop until a stop message is posted. <a href="#a3084a3a75717db0f7f05604f2956ff65">More...</a><br /></td></tr>
<tr class="separator:a3084a3a75717db0f7f05604f2956ff65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a283b20c2b3786537b31952670d2df7bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a283b20c2b3786537b31952670d2df7bf">stopDispatchLoop</a> ()</td></tr>
<tr class="memdesc:a283b20c2b3786537b31952670d2df7bf"><td class="mdescLeft"> </td><td class="mdescRight">Sends a signal that the dispatch loop should terminate. <a href="#a283b20c2b3786537b31952670d2df7bf">More...</a><br /></td></tr>
<tr class="separator:a283b20c2b3786537b31952670d2df7bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b51c7c37417fea8c4f47ebb7913ddba"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a3b51c7c37417fea8c4f47ebb7913ddba">hasStopMessageBeenSent</a> () const noexcept</td></tr>
<tr class="memdesc:a3b51c7c37417fea8c4f47ebb7913ddba"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the <a class="el" href="classMessageManager.html#a283b20c2b3786537b31952670d2df7bf" title="Sends a signal that the dispatch loop should terminate. ">stopDispatchLoop()</a> method has been called. <a href="#a3b51c7c37417fea8c4f47ebb7913ddba">More...</a><br /></td></tr>
<tr class="separator:a3b51c7c37417fea8c4f47ebb7913ddba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ddde5289b71c37a3a4a4bb9d673a0de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a0ddde5289b71c37a3a4a4bb9d673a0de">runDispatchLoopUntil</a> (int millisecondsToRunFor)</td></tr>
<tr class="memdesc:a0ddde5289b71c37a3a4a4bb9d673a0de"><td class="mdescLeft"> </td><td class="mdescRight">Synchronously dispatches messages until a given time has elapsed. <a href="#a0ddde5289b71c37a3a4a4bb9d673a0de">More...</a><br /></td></tr>
<tr class="separator:a0ddde5289b71c37a3a4a4bb9d673a0de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a554f81587d57127c9cb5be72aced11c1"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a554f81587d57127c9cb5be72aced11c1">callFunctionOnMessageThread</a> (<a class="el" href="juce__MessageManager_8h.html#adb257d4cb706b5211bf572126b925ca2">MessageCallbackFunction</a> *callback, void *userData)</td></tr>
<tr class="memdesc:a554f81587d57127c9cb5be72aced11c1"><td class="mdescLeft"> </td><td class="mdescRight">Calls a function using the message-thread. <a href="#a554f81587d57127c9cb5be72aced11c1">More...</a><br /></td></tr>
<tr class="separator:a554f81587d57127c9cb5be72aced11c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accd7b539b31d809c30685b3d49327322"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#accd7b539b31d809c30685b3d49327322">isThisTheMessageThread</a> () const noexcept</td></tr>
<tr class="memdesc:accd7b539b31d809c30685b3d49327322"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the caller-thread is the message thread. <a href="#accd7b539b31d809c30685b3d49327322">More...</a><br /></td></tr>
<tr class="separator:accd7b539b31d809c30685b3d49327322"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af94f78debd3b3d70acade65f50c5058e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#af94f78debd3b3d70acade65f50c5058e">setCurrentThreadAsMessageThread</a> ()</td></tr>
<tr class="memdesc:af94f78debd3b3d70acade65f50c5058e"><td class="mdescLeft"> </td><td class="mdescRight">Called to tell the manager that the current thread is the one that's running the dispatch loop. <a href="#af94f78debd3b3d70acade65f50c5058e">More...</a><br /></td></tr>
<tr class="separator:af94f78debd3b3d70acade65f50c5058e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa64162d4d9711b2c299e66775b57f414"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classThread.html#a077e20855a3c974c2fc6f9e7caa8412c">Thread::ThreadID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#aa64162d4d9711b2c299e66775b57f414">getCurrentMessageThread</a> () const noexcept</td></tr>
<tr class="memdesc:aa64162d4d9711b2c299e66775b57f414"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of the current message thread, as set by <a class="el" href="classMessageManager.html#af94f78debd3b3d70acade65f50c5058e" title="Called to tell the manager that the current thread is the one that's running the dispatch loop...">setCurrentThreadAsMessageThread()</a>. <a href="#aa64162d4d9711b2c299e66775b57f414">More...</a><br /></td></tr>
<tr class="separator:aa64162d4d9711b2c299e66775b57f414"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebd4b8896d7b6bdfa34d3cd8eb2e1777"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#aebd4b8896d7b6bdfa34d3cd8eb2e1777">currentThreadHasLockedMessageManager</a> () const noexcept</td></tr>
<tr class="memdesc:aebd4b8896d7b6bdfa34d3cd8eb2e1777"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the caller thread has currently got the message manager locked. <a href="#aebd4b8896d7b6bdfa34d3cd8eb2e1777">More...</a><br /></td></tr>
<tr class="separator:aebd4b8896d7b6bdfa34d3cd8eb2e1777"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4ee5d1cae2b55eb45507b491489e5de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#ad4ee5d1cae2b55eb45507b491489e5de">registerBroadcastListener</a> (<a class="el" href="classActionListener.html">ActionListener</a> *listener)</td></tr>
<tr class="memdesc:ad4ee5d1cae2b55eb45507b491489e5de"><td class="mdescLeft"> </td><td class="mdescRight">Registers a listener to get told about broadcast messages. <a href="#ad4ee5d1cae2b55eb45507b491489e5de">More...</a><br /></td></tr>
<tr class="separator:ad4ee5d1cae2b55eb45507b491489e5de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a64dae92820a0ec102294d8ea7aa94f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a5a64dae92820a0ec102294d8ea7aa94f">deregisterBroadcastListener</a> (<a class="el" href="classActionListener.html">ActionListener</a> *listener)</td></tr>
<tr class="memdesc:a5a64dae92820a0ec102294d8ea7aa94f"><td class="mdescLeft"> </td><td class="mdescRight">Deregisters a broadcast listener. <a href="#a5a64dae92820a0ec102294d8ea7aa94f">More...</a><br /></td></tr>
<tr class="separator:a5a64dae92820a0ec102294d8ea7aa94f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aea95a541b6660b7cdcc79b675879f35d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMessageManager.html">MessageManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#aea95a541b6660b7cdcc79b675879f35d">getInstance</a> ()</td></tr>
<tr class="memdesc:aea95a541b6660b7cdcc79b675879f35d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the global instance of the <a class="el" href="classMessageManager.html" title="This class is in charge of the application's event-dispatch loop. ">MessageManager</a>. <a href="#aea95a541b6660b7cdcc79b675879f35d">More...</a><br /></td></tr>
<tr class="separator:aea95a541b6660b7cdcc79b675879f35d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae890114c8f95bef376d498f633db4de2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMessageManager.html">MessageManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#ae890114c8f95bef376d498f633db4de2">getInstanceWithoutCreating</a> () noexcept</td></tr>
<tr class="memdesc:ae890114c8f95bef376d498f633db4de2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the global instance of the <a class="el" href="classMessageManager.html" title="This class is in charge of the application's event-dispatch loop. ">MessageManager</a>, or nullptr if it doesn't exist. <a href="#ae890114c8f95bef376d498f633db4de2">More...</a><br /></td></tr>
<tr class="separator:ae890114c8f95bef376d498f633db4de2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bdcb8bd5ef27480b49d6b1ff6ecdaa9"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a4bdcb8bd5ef27480b49d6b1ff6ecdaa9">deleteInstance</a> ()</td></tr>
<tr class="memdesc:a4bdcb8bd5ef27480b49d6b1ff6ecdaa9"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the global <a class="el" href="classMessageManager.html" title="This class is in charge of the application's event-dispatch loop. ">MessageManager</a> instance. <a href="#a4bdcb8bd5ef27480b49d6b1ff6ecdaa9">More...</a><br /></td></tr>
<tr class="separator:a4bdcb8bd5ef27480b49d6b1ff6ecdaa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a252262c8bfe857ea77fe4e7b4b42ae80"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageManager.html#a252262c8bfe857ea77fe4e7b4b42ae80">broadcastMessage</a> (const <a class="el" href="classString.html">String</a> &messageText)</td></tr>
<tr class="memdesc:a252262c8bfe857ea77fe4e7b4b42ae80"><td class="mdescLeft"> </td><td class="mdescRight">Sends a message to all other JUCE applications that are running. <a href="#a252262c8bfe857ea77fe4e7b4b42ae80">More...</a><br /></td></tr>
<tr class="separator:a252262c8bfe857ea77fe4e7b4b42ae80"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is in charge of the application's event-dispatch loop. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessage.html" title="The base class for objects that can be sent to a MessageListener. ">Message</a>, <a class="el" href="classCallbackMessage.html" title="A message that invokes a callback method when it gets delivered. ">CallbackMessage</a>, <a class="el" href="classMessageManagerLock.html" title="Used to make sure that the calling thread has exclusive access to the message loop. ">MessageManagerLock</a>, <a class="el" href="classJUCEApplication.html" title="An instance of this class is used to specify initialisation and shutdown code for the application...">JUCEApplication</a>, <a class="el" href="classJUCEApplicationBase.html" title="Abstract base class for application classes. ">JUCEApplicationBase</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aea95a541b6660b7cdcc79b675879f35d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea95a541b6660b7cdcc79b675879f35d">§ </a></span>getInstance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classMessageManager.html">MessageManager</a>* MessageManager::getInstance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the global instance of the <a class="el" href="classMessageManager.html" title="This class is in charge of the application's event-dispatch loop. ">MessageManager</a>. </p>
</div>
</div>
<a id="ae890114c8f95bef376d498f633db4de2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae890114c8f95bef376d498f633db4de2">§ </a></span>getInstanceWithoutCreating()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classMessageManager.html">MessageManager</a>* MessageManager::getInstanceWithoutCreating </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the global instance of the <a class="el" href="classMessageManager.html" title="This class is in charge of the application's event-dispatch loop. ">MessageManager</a>, or nullptr if it doesn't exist. </p>
</div>
</div>
<a id="a4bdcb8bd5ef27480b49d6b1ff6ecdaa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bdcb8bd5ef27480b49d6b1ff6ecdaa9">§ </a></span>deleteInstance()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void MessageManager::deleteInstance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes the global <a class="el" href="classMessageManager.html" title="This class is in charge of the application's event-dispatch loop. ">MessageManager</a> instance. </p>
<p>Does nothing if no instance had been created. </p>
</div>
</div>
<a id="a3084a3a75717db0f7f05604f2956ff65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3084a3a75717db0f7f05604f2956ff65">§ </a></span>runDispatchLoop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MessageManager::runDispatchLoop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Runs the event dispatch loop until a stop message is posted. </p>
<p>This method is only intended to be run by the application's startup routine, as it blocks, and will only return after the <a class="el" href="classMessageManager.html#a283b20c2b3786537b31952670d2df7bf" title="Sends a signal that the dispatch loop should terminate. ">stopDispatchLoop()</a> method has been used.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManager.html#a283b20c2b3786537b31952670d2df7bf" title="Sends a signal that the dispatch loop should terminate. ">stopDispatchLoop</a> </dd></dl>
</div>
</div>
<a id="a283b20c2b3786537b31952670d2df7bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a283b20c2b3786537b31952670d2df7bf">§ </a></span>stopDispatchLoop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MessageManager::stopDispatchLoop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a signal that the dispatch loop should terminate. </p>
<p>After this is called, the <a class="el" href="classMessageManager.html#a3084a3a75717db0f7f05604f2956ff65" title="Runs the event dispatch loop until a stop message is posted. ">runDispatchLoop()</a> or <a class="el" href="classMessageManager.html#a0ddde5289b71c37a3a4a4bb9d673a0de" title="Synchronously dispatches messages until a given time has elapsed. ">runDispatchLoopUntil()</a> methods will be interrupted and will return.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManager.html#a3084a3a75717db0f7f05604f2956ff65" title="Runs the event dispatch loop until a stop message is posted. ">runDispatchLoop</a> </dd></dl>
</div>
</div>
<a id="a3b51c7c37417fea8c4f47ebb7913ddba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b51c7c37417fea8c4f47ebb7913ddba">§ </a></span>hasStopMessageBeenSent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MessageManager::hasStopMessageBeenSent </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 true if the <a class="el" href="classMessageManager.html#a283b20c2b3786537b31952670d2df7bf" title="Sends a signal that the dispatch loop should terminate. ">stopDispatchLoop()</a> method has been called. </p>
</div>
</div>
<a id="a0ddde5289b71c37a3a4a4bb9d673a0de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ddde5289b71c37a3a4a4bb9d673a0de">§ </a></span>runDispatchLoopUntil()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool MessageManager::runDispatchLoopUntil </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>millisecondsToRunFor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronously dispatches messages until a given time has elapsed. </p>
<p>Returns false if a quit message has been posted by a call to <a class="el" href="classMessageManager.html#a283b20c2b3786537b31952670d2df7bf" title="Sends a signal that the dispatch loop should terminate. ">stopDispatchLoop()</a>, otherwise returns true. </p>
</div>
</div>
<a id="a554f81587d57127c9cb5be72aced11c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a554f81587d57127c9cb5be72aced11c1">§ </a></span>callFunctionOnMessageThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* MessageManager::callFunctionOnMessageThread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MessageManager_8h.html#adb257d4cb706b5211bf572126b925ca2">MessageCallbackFunction</a> * </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userData</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls a function using the message-thread. </p>
<p>This can be used by any thread to cause this function to be called-back by the message thread. If it's the message-thread that's calling this method, then the function will just be called; if another thread is calling, a message will be posted to the queue, and this method will block until that message is delivered, the function is called, and the result is returned.</p>
<p>Be careful not to cause any deadlocks with this! It's easy to do - e.g. if the caller thread has a critical section locked, which an unrelated message callback then tries to lock before the message thread gets round to processing this callback.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>the function to call - its signature must be<div class="fragment"><div class="line"><span class="keywordtype">void</span>* myCallbackFunction (<span class="keywordtype">void</span>*) </div></div><!-- fragment --> </td></tr>
<tr><td class="paramname">userData</td><td>a user-defined pointer that will be passed to the function that gets called </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value that the callback function returns. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManagerLock.html" title="Used to make sure that the calling thread has exclusive access to the message loop. ">MessageManagerLock</a> </dd></dl>
</div>
</div>
<a id="accd7b539b31d809c30685b3d49327322"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accd7b539b31d809c30685b3d49327322">§ </a></span>isThisTheMessageThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MessageManager::isThisTheMessageThread </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 true if the caller-thread is the message thread. </p>
</div>
</div>
<a id="af94f78debd3b3d70acade65f50c5058e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af94f78debd3b3d70acade65f50c5058e">§ </a></span>setCurrentThreadAsMessageThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MessageManager::setCurrentThreadAsMessageThread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to tell the manager that the current thread is the one that's running the dispatch loop. </p>
<p>(Best to ignore this method unless you really know what you're doing..) </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManager.html#aa64162d4d9711b2c299e66775b57f414" title="Returns the ID of the current message thread, as set by setCurrentThreadAsMessageThread(). ">getCurrentMessageThread</a> </dd></dl>
</div>
</div>
<a id="aa64162d4d9711b2c299e66775b57f414"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa64162d4d9711b2c299e66775b57f414">§ </a></span>getCurrentMessageThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classThread.html#a077e20855a3c974c2fc6f9e7caa8412c">Thread::ThreadID</a> MessageManager::getCurrentMessageThread </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 ID of the current message thread, as set by <a class="el" href="classMessageManager.html#af94f78debd3b3d70acade65f50c5058e" title="Called to tell the manager that the current thread is the one that's running the dispatch loop...">setCurrentThreadAsMessageThread()</a>. </p>
<p>(Best to ignore this method unless you really know what you're doing..) </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManager.html#af94f78debd3b3d70acade65f50c5058e" title="Called to tell the manager that the current thread is the one that's running the dispatch loop...">setCurrentThreadAsMessageThread</a> </dd></dl>
</div>
</div>
<a id="aebd4b8896d7b6bdfa34d3cd8eb2e1777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebd4b8896d7b6bdfa34d3cd8eb2e1777">§ </a></span>currentThreadHasLockedMessageManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool MessageManager::currentThreadHasLockedMessageManager </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 true if the caller thread has currently got the message manager locked. </p>
<p>see the <a class="el" href="classMessageManagerLock.html" title="Used to make sure that the calling thread has exclusive access to the message loop. ">MessageManagerLock</a> class for more info about this.</p>
<p>This will be true if the caller is the message thread, because that automatically gains a lock while a message is being dispatched. </p>
</div>
</div>
<a id="a252262c8bfe857ea77fe4e7b4b42ae80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a252262c8bfe857ea77fe4e7b4b42ae80">§ </a></span>broadcastMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void MessageManager::broadcastMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>messageText</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a message to all other JUCE applications that are running. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">messageText</td><td>the string that will be passed to the actionListenerCallback() method of the broadcast listeners in the other app. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManager.html#ad4ee5d1cae2b55eb45507b491489e5de" title="Registers a listener to get told about broadcast messages. ">registerBroadcastListener</a>, <a class="el" href="classActionListener.html" title="Interface class for delivery of events that are sent by an ActionBroadcaster. ">ActionListener</a> </dd></dl>
</div>
</div>
<a id="ad4ee5d1cae2b55eb45507b491489e5de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4ee5d1cae2b55eb45507b491489e5de">§ </a></span>registerBroadcastListener()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MessageManager::registerBroadcastListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classActionListener.html">ActionListener</a> * </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a listener to get told about broadcast messages. </p>
<p>The actionListenerCallback() callback's string parameter is the message passed into <a class="el" href="classMessageManager.html#a252262c8bfe857ea77fe4e7b4b42ae80" title="Sends a message to all other JUCE applications that are running. ">broadcastMessage()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMessageManager.html#a252262c8bfe857ea77fe4e7b4b42ae80" title="Sends a message to all other JUCE applications that are running. ">broadcastMessage</a> </dd></dl>
</div>
</div>
<a id="a5a64dae92820a0ec102294d8ea7aa94f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a64dae92820a0ec102294d8ea7aa94f">§ </a></span>deregisterBroadcastListener()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MessageManager::deregisterBroadcastListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classActionListener.html">ActionListener</a> * </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deregisters a broadcast listener. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__MessageManager_8h.html">juce_MessageManager.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|