DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

144 lines
8.3KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.9.1"/>
  7. <title>DISTRHO Plugin Framework: Thread Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td style="padding-left: 0.5em;">
  26. <div id="projectname">DISTRHO Plugin Framework
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.9.1 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-methods">Public Member Functions</a> &#124;
  86. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  87. <a href="#pro-methods">Protected Member Functions</a> &#124;
  88. <a href="classThread-members.html">List of all members</a> </div>
  89. <div class="headertitle">
  90. <div class="title">Thread Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  95. Public Member Functions</h2></td></tr>
  96. <tr class="memitem:a43ff15a88d142fd3fb112f6f801ad1ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43ff15a88d142fd3fb112f6f801ad1ef"></a>
  97. bool&#160;</td><td class="memItemRight" valign="bottom"><b>isThreadRunning</b> () const noexcept</td></tr>
  98. <tr class="separator:a43ff15a88d142fd3fb112f6f801ad1ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a261ed6f5073b681129d6892b645aeac9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a261ed6f5073b681129d6892b645aeac9"></a>
  100. bool&#160;</td><td class="memItemRight" valign="bottom"><b>shouldThreadExit</b> () const noexcept</td></tr>
  101. <tr class="separator:a261ed6f5073b681129d6892b645aeac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a7dcfd73e108cf2288e53d2c130a5e9d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7dcfd73e108cf2288e53d2c130a5e9d1"></a>
  103. bool&#160;</td><td class="memItemRight" valign="bottom"><b>startThread</b> () noexcept</td></tr>
  104. <tr class="separator:a7dcfd73e108cf2288e53d2c130a5e9d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a35a7bf228734d406243d7c52739f5c93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35a7bf228734d406243d7c52739f5c93"></a>
  106. bool&#160;</td><td class="memItemRight" valign="bottom"><b>stopThread</b> (const int timeOutMilliseconds) noexcept</td></tr>
  107. <tr class="separator:a35a7bf228734d406243d7c52739f5c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a72043b3684f6b51a089dff65f523491a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72043b3684f6b51a089dff65f523491a"></a>
  109. void&#160;</td><td class="memItemRight" valign="bottom"><b>signalThreadShouldExit</b> () noexcept</td></tr>
  110. <tr class="separator:a72043b3684f6b51a089dff65f523491a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a04ae21de0884d0814efe13de1ff475be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04ae21de0884d0814efe13de1ff475be"></a>
  112. const <a class="el" href="classString.html">String</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getThreadName</b> () const noexcept</td></tr>
  113. <tr class="separator:a04ae21de0884d0814efe13de1ff475be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table><table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  116. Static Public Member Functions</h2></td></tr>
  117. <tr class="memitem:accc450d8056f287d984c2cd8866daf2f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accc450d8056f287d984c2cd8866daf2f"></a>
  118. static void&#160;</td><td class="memItemRight" valign="bottom"><b>setCurrentThreadName</b> (const char *const name) noexcept</td></tr>
  119. <tr class="separator:accc450d8056f287d984c2cd8866daf2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  122. Protected Member Functions</h2></td></tr>
  123. <tr class="memitem:a296f51dbefe82aa028d2cfabe1afc6a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a296f51dbefe82aa028d2cfabe1afc6a9"></a>
  124. &#160;</td><td class="memItemRight" valign="bottom"><b>Thread</b> (const char *const threadName=nullptr) noexcept</td></tr>
  125. <tr class="separator:a296f51dbefe82aa028d2cfabe1afc6a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:aae90dfabab3e1776cf01a26e7ee3a620"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae90dfabab3e1776cf01a26e7ee3a620"></a>
  127. virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>run</b> ()=0</td></tr>
  128. <tr class="separator:aae90dfabab3e1776cf01a26e7ee3a620"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table>
  130. <hr/>The documentation for this class was generated from the following file:<ul>
  131. <li>distrho/extra/<a class="el" href="Thread_8hpp_source.html">Thread.hpp</a></li>
  132. </ul>
  133. </div><!-- contents -->
  134. <!-- start footer part -->
  135. <hr class="footer"/><address class="footer"><small>
  136. Generated on Wed Jun 17 2015 11:36:22 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  137. <img class="footer" src="doxygen.png" alt="doxygen"/>
  138. </a> 1.8.9.1
  139. </small></address>
  140. </body>
  141. </html>