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.

143 lines
9.0KB

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