| 
							- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
 - <meta name="viewport" content="width=device-width, initial-scale=1"/>
 - <title>DISTRHO Plugin Framework: distrho/extra/Thread.hpp Source File</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">DISTRHO Plugin Framework
 -    </div>
 -   </td>
 -  </tr>
 -  </tbody>
 - </table>
 - </div>
 - <!-- end header part -->
 - <!-- Generated by Doxygen 1.8.17 -->
 - <script type="text/javascript">
 - /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
 - var searchBox = new SearchBox("searchBox", "search",false,'Search');
 - /* @license-end */
 - </script>
 - <script type="text/javascript" src="menudata.js"></script>
 - <script type="text/javascript" src="menu.js"></script>
 - <script type="text/javascript">
 - /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
 - $(function() {
 -   initMenu('',true,false,'search.php','Search');
 -   $(document).ready(function() { init_search(); });
 - });
 - /* @license-end */</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 id="nav-path" class="navpath">
 -   <ul>
 - <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li><li class="navelem"><a class="el" href="dir_b1be46be7d80596b116b2b4ac973f2f0.html">extra</a></li>  </ul>
 - </div>
 - </div><!-- top -->
 - <div class="header">
 -   <div class="headertitle">
 - <div class="title">Thread.hpp</div>  </div>
 - </div><!--header-->
 - <div class="contents">
 - <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span> <span class="comment">/*</span></div>
 - <div class="line"><a name="l00002"></a><span class="lineno">    2</span> <span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
 - <div class="line"><a name="l00003"></a><span class="lineno">    3</span> <span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com></span></div>
 - <div class="line"><a name="l00004"></a><span class="lineno">    4</span> <span class="comment"> *</span></div>
 - <div class="line"><a name="l00005"></a><span class="lineno">    5</span> <span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
 - <div class="line"><a name="l00006"></a><span class="lineno">    6</span> <span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
 - <div class="line"><a name="l00007"></a><span class="lineno">    7</span> <span class="comment"> * permission notice appear in all copies.</span></div>
 - <div class="line"><a name="l00008"></a><span class="lineno">    8</span> <span class="comment"> *</span></div>
 - <div class="line"><a name="l00009"></a><span class="lineno">    9</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
 - <div class="line"><a name="l00010"></a><span class="lineno">   10</span> <span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
 - <div class="line"><a name="l00011"></a><span class="lineno">   11</span> <span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
 - <div class="line"><a name="l00012"></a><span class="lineno">   12</span> <span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
 - <div class="line"><a name="l00013"></a><span class="lineno">   13</span> <span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
 - <div class="line"><a name="l00014"></a><span class="lineno">   14</span> <span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
 - <div class="line"><a name="l00015"></a><span class="lineno">   15</span> <span class="comment"> */</span></div>
 - <div class="line"><a name="l00016"></a><span class="lineno">   16</span>  </div>
 - <div class="line"><a name="l00017"></a><span class="lineno">   17</span> <span class="preprocessor">#ifndef DISTRHO_THREAD_HPP_INCLUDED</span></div>
 - <div class="line"><a name="l00018"></a><span class="lineno">   18</span> <span class="preprocessor">#define DISTRHO_THREAD_HPP_INCLUDED</span></div>
 - <div class="line"><a name="l00019"></a><span class="lineno">   19</span>  </div>
 - <div class="line"><a name="l00020"></a><span class="lineno">   20</span> <span class="preprocessor">#include "Mutex.hpp"</span></div>
 - <div class="line"><a name="l00021"></a><span class="lineno">   21</span> <span class="preprocessor">#include "Sleep.hpp"</span></div>
 - <div class="line"><a name="l00022"></a><span class="lineno">   22</span> <span class="preprocessor">#include "String.hpp"</span></div>
 - <div class="line"><a name="l00023"></a><span class="lineno">   23</span>  </div>
 - <div class="line"><a name="l00024"></a><span class="lineno">   24</span> <span class="preprocessor">#ifdef DISTRHO_OS_LINUX</span></div>
 - <div class="line"><a name="l00025"></a><span class="lineno">   25</span> <span class="preprocessor"># include <sys/prctl.h></span></div>
 - <div class="line"><a name="l00026"></a><span class="lineno">   26</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00027"></a><span class="lineno">   27</span>  </div>
 - <div class="line"><a name="l00028"></a><span class="lineno">   28</span> START_NAMESPACE_DISTRHO</div>
 - <div class="line"><a name="l00029"></a><span class="lineno">   29</span>  </div>
 - <div class="line"><a name="l00030"></a><span class="lineno">   30</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
 - <div class="line"><a name="l00031"></a><span class="lineno">   31</span> <span class="comment">// Thread class</span></div>
 - <div class="line"><a name="l00032"></a><span class="lineno">   32</span>  </div>
 - <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classThread.html">   33</a></span> <span class="keyword">class </span><a class="code" href="classThread.html">Thread</a></div>
 - <div class="line"><a name="l00034"></a><span class="lineno">   34</span> {</div>
 - <div class="line"><a name="l00035"></a><span class="lineno">   35</span> <span class="keyword">protected</span>:</div>
 - <div class="line"><a name="l00036"></a><span class="lineno">   36</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00037"></a><span class="lineno">   37</span> <span class="comment">     * Constructor.</span></div>
 - <div class="line"><a name="l00038"></a><span class="lineno">   38</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00039"></a><span class="lineno">   39</span>     <a class="code" href="classThread.html">Thread</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> threadName = <span class="keyword">nullptr</span>) noexcept</div>
 - <div class="line"><a name="l00040"></a><span class="lineno">   40</span>         : fLock(),</div>
 - <div class="line"><a name="l00041"></a><span class="lineno">   41</span>           fSignal(),</div>
 - <div class="line"><a name="l00042"></a><span class="lineno">   42</span>           fName(threadName),</div>
 - <div class="line"><a name="l00043"></a><span class="lineno">   43</span> <span class="preprocessor">#ifdef PTW32_DLLPORT</span></div>
 - <div class="line"><a name="l00044"></a><span class="lineno">   44</span>           fHandle({<span class="keyword">nullptr</span>, 0}),</div>
 - <div class="line"><a name="l00045"></a><span class="lineno">   45</span> #<span class="keywordflow">else</span></div>
 - <div class="line"><a name="l00046"></a><span class="lineno">   46</span>           fHandle(0),</div>
 - <div class="line"><a name="l00047"></a><span class="lineno">   47</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00048"></a><span class="lineno">   48</span>           fShouldExit(<span class="keyword">false</span>) {}</div>
 - <div class="line"><a name="l00049"></a><span class="lineno">   49</span>  </div>
 - <div class="line"><a name="l00050"></a><span class="lineno">   50</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00051"></a><span class="lineno">   51</span> <span class="comment">     * Destructor.</span></div>
 - <div class="line"><a name="l00052"></a><span class="lineno">   52</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00053"></a><span class="lineno">   53</span>     <span class="keyword">virtual</span> ~<a class="code" href="classThread.html">Thread</a>() <span class="comment">/*noexcept*/</span></div>
 - <div class="line"><a name="l00054"></a><span class="lineno">   54</span>     {</div>
 - <div class="line"><a name="l00055"></a><span class="lineno">   55</span>         DISTRHO_SAFE_ASSERT(! isThreadRunning());</div>
 - <div class="line"><a name="l00056"></a><span class="lineno">   56</span>  </div>
 - <div class="line"><a name="l00057"></a><span class="lineno">   57</span>         stopThread(-1);</div>
 - <div class="line"><a name="l00058"></a><span class="lineno">   58</span>     }</div>
 - <div class="line"><a name="l00059"></a><span class="lineno">   59</span>  </div>
 - <div class="line"><a name="l00060"></a><span class="lineno">   60</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00061"></a><span class="lineno">   61</span> <span class="comment">     * Virtual function to be implemented by the subclass.</span></div>
 - <div class="line"><a name="l00062"></a><span class="lineno">   62</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00063"></a><span class="lineno">   63</span>     <span class="keyword">virtual</span> <span class="keywordtype">void</span> run() = 0;</div>
 - <div class="line"><a name="l00064"></a><span class="lineno">   64</span>  </div>
 - <div class="line"><a name="l00065"></a><span class="lineno">   65</span>     <span class="comment">// -------------------------------------------------------------------</span></div>
 - <div class="line"><a name="l00066"></a><span class="lineno">   66</span>  </div>
 - <div class="line"><a name="l00067"></a><span class="lineno">   67</span> <span class="keyword">public</span>:</div>
 - <div class="line"><a name="l00068"></a><span class="lineno">   68</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00069"></a><span class="lineno">   69</span> <span class="comment">     * Check if the thread is running.</span></div>
 - <div class="line"><a name="l00070"></a><span class="lineno">   70</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00071"></a><span class="lineno">   71</span>     <span class="keywordtype">bool</span> isThreadRunning() <span class="keyword">const</span> noexcept</div>
 - <div class="line"><a name="l00072"></a><span class="lineno">   72</span>     {</div>
 - <div class="line"><a name="l00073"></a><span class="lineno">   73</span> <span class="preprocessor">#ifdef PTW32_DLLPORT</span></div>
 - <div class="line"><a name="l00074"></a><span class="lineno">   74</span>         <span class="keywordflow">return</span> (fHandle.p != <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00075"></a><span class="lineno">   75</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00076"></a><span class="lineno">   76</span>         <span class="keywordflow">return</span> (fHandle != 0);</div>
 - <div class="line"><a name="l00077"></a><span class="lineno">   77</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00078"></a><span class="lineno">   78</span>     }</div>
 - <div class="line"><a name="l00079"></a><span class="lineno">   79</span>  </div>
 - <div class="line"><a name="l00080"></a><span class="lineno">   80</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00081"></a><span class="lineno">   81</span> <span class="comment">     * Check if the thread should exit.</span></div>
 - <div class="line"><a name="l00082"></a><span class="lineno">   82</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00083"></a><span class="lineno">   83</span>     <span class="keywordtype">bool</span> shouldThreadExit() <span class="keyword">const</span> noexcept</div>
 - <div class="line"><a name="l00084"></a><span class="lineno">   84</span>     {</div>
 - <div class="line"><a name="l00085"></a><span class="lineno">   85</span>         <span class="keywordflow">return</span> fShouldExit;</div>
 - <div class="line"><a name="l00086"></a><span class="lineno">   86</span>     }</div>
 - <div class="line"><a name="l00087"></a><span class="lineno">   87</span>  </div>
 - <div class="line"><a name="l00088"></a><span class="lineno">   88</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00089"></a><span class="lineno">   89</span> <span class="comment">     * Start the thread.</span></div>
 - <div class="line"><a name="l00090"></a><span class="lineno">   90</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00091"></a><span class="lineno">   91</span>     <span class="keywordtype">bool</span> startThread(<span class="keyword">const</span> <span class="keywordtype">bool</span> withRealtimePriority = <span class="keyword">false</span>) noexcept</div>
 - <div class="line"><a name="l00092"></a><span class="lineno">   92</span>     {</div>
 - <div class="line"><a name="l00093"></a><span class="lineno">   93</span>         <span class="comment">// check if already running</span></div>
 - <div class="line"><a name="l00094"></a><span class="lineno">   94</span>         DISTRHO_SAFE_ASSERT_RETURN(! isThreadRunning(), <span class="keyword">true</span>);</div>
 - <div class="line"><a name="l00095"></a><span class="lineno">   95</span>  </div>
 - <div class="line"><a name="l00096"></a><span class="lineno">   96</span>         pthread_t handle;</div>
 - <div class="line"><a name="l00097"></a><span class="lineno">   97</span>  </div>
 - <div class="line"><a name="l00098"></a><span class="lineno">   98</span>         pthread_attr_t attr;</div>
 - <div class="line"><a name="l00099"></a><span class="lineno">   99</span>         pthread_attr_init(&attr);</div>
 - <div class="line"><a name="l00100"></a><span class="lineno">  100</span>  </div>
 - <div class="line"><a name="l00101"></a><span class="lineno">  101</span>         <span class="keyword">struct </span>sched_param sched_param;</div>
 - <div class="line"><a name="l00102"></a><span class="lineno">  102</span>         std::memset(&sched_param, 0, <span class="keyword">sizeof</span>(sched_param));</div>
 - <div class="line"><a name="l00103"></a><span class="lineno">  103</span>  </div>
 - <div class="line"><a name="l00104"></a><span class="lineno">  104</span>         <span class="keywordflow">if</span> (withRealtimePriority)</div>
 - <div class="line"><a name="l00105"></a><span class="lineno">  105</span>         {</div>
 - <div class="line"><a name="l00106"></a><span class="lineno">  106</span>             sched_param.sched_priority = 80;</div>
 - <div class="line"><a name="l00107"></a><span class="lineno">  107</span>  </div>
 - <div class="line"><a name="l00108"></a><span class="lineno">  108</span> <span class="preprocessor">#ifndef DISTRHO_OS_HAIKU</span></div>
 - <div class="line"><a name="l00109"></a><span class="lineno">  109</span>             <span class="keywordflow">if</span> (pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM)          == 0  &&</div>
 - <div class="line"><a name="l00110"></a><span class="lineno">  110</span>                 pthread_attr_setinheritsched(&attr, PTHREAD_EXPLICIT_SCHED) == 0  &&</div>
 - <div class="line"><a name="l00111"></a><span class="lineno">  111</span> # ifndef DISTRHO_OS_WINDOWS</div>
 - <div class="line"><a name="l00112"></a><span class="lineno">  112</span>                (pthread_attr_setschedpolicy(&attr, SCHED_FIFO)              == 0  ||</div>
 - <div class="line"><a name="l00113"></a><span class="lineno">  113</span>                 pthread_attr_setschedpolicy(&attr, SCHED_RR)                == 0) &&</div>
 - <div class="line"><a name="l00114"></a><span class="lineno">  114</span> # endif</div>
 - <div class="line"><a name="l00115"></a><span class="lineno">  115</span>                 pthread_attr_setschedparam(&attr, &sched_param)             == 0)</div>
 - <div class="line"><a name="l00116"></a><span class="lineno">  116</span>             {</div>
 - <div class="line"><a name="l00117"></a><span class="lineno">  117</span>                 d_stdout(<span class="stringliteral">"Thread setup with realtime priority successful"</span>);</div>
 - <div class="line"><a name="l00118"></a><span class="lineno">  118</span>             }</div>
 - <div class="line"><a name="l00119"></a><span class="lineno">  119</span>             <span class="keywordflow">else</span></div>
 - <div class="line"><a name="l00120"></a><span class="lineno">  120</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00121"></a><span class="lineno">  121</span>             {</div>
 - <div class="line"><a name="l00122"></a><span class="lineno">  122</span>                 d_stdout(<span class="stringliteral">"Thread setup with realtime priority failed, going with normal priority instead"</span>);</div>
 - <div class="line"><a name="l00123"></a><span class="lineno">  123</span>                 pthread_attr_destroy(&attr);</div>
 - <div class="line"><a name="l00124"></a><span class="lineno">  124</span>                 pthread_attr_init(&attr);</div>
 - <div class="line"><a name="l00125"></a><span class="lineno">  125</span>             }</div>
 - <div class="line"><a name="l00126"></a><span class="lineno">  126</span>         }</div>
 - <div class="line"><a name="l00127"></a><span class="lineno">  127</span>  </div>
 - <div class="line"><a name="l00128"></a><span class="lineno">  128</span>         <span class="keyword">const</span> <a class="code" href="classScopeLocker.html">MutexLocker</a> ml(fLock);</div>
 - <div class="line"><a name="l00129"></a><span class="lineno">  129</span>  </div>
 - <div class="line"><a name="l00130"></a><span class="lineno">  130</span>         fShouldExit = <span class="keyword">false</span>;</div>
 - <div class="line"><a name="l00131"></a><span class="lineno">  131</span>  </div>
 - <div class="line"><a name="l00132"></a><span class="lineno">  132</span>         <span class="keywordtype">bool</span> ok = pthread_create(&handle, &attr, _entryPoint, <span class="keyword">this</span>) == 0;</div>
 - <div class="line"><a name="l00133"></a><span class="lineno">  133</span>         pthread_attr_destroy(&attr);</div>
 - <div class="line"><a name="l00134"></a><span class="lineno">  134</span>  </div>
 - <div class="line"><a name="l00135"></a><span class="lineno">  135</span>         <span class="keywordflow">if</span> (withRealtimePriority && !ok)</div>
 - <div class="line"><a name="l00136"></a><span class="lineno">  136</span>        {</div>
 - <div class="line"><a name="l00137"></a><span class="lineno">  137</span>             d_stdout(<span class="stringliteral">"Thread with realtime priority failed on creation, going with normal priority instead"</span>);</div>
 - <div class="line"><a name="l00138"></a><span class="lineno">  138</span>             pthread_attr_init(&attr);</div>
 - <div class="line"><a name="l00139"></a><span class="lineno">  139</span>             ok = pthread_create(&handle, &attr, _entryPoint, <span class="keyword">this</span>) == 0;</div>
 - <div class="line"><a name="l00140"></a><span class="lineno">  140</span>             pthread_attr_destroy(&attr);</div>
 - <div class="line"><a name="l00141"></a><span class="lineno">  141</span>        }</div>
 - <div class="line"><a name="l00142"></a><span class="lineno">  142</span>  </div>
 - <div class="line"><a name="l00143"></a><span class="lineno">  143</span>         DISTRHO_SAFE_ASSERT_RETURN(ok, <span class="keyword">false</span>);</div>
 - <div class="line"><a name="l00144"></a><span class="lineno">  144</span> <span class="preprocessor">#ifdef PTW32_DLLPORT</span></div>
 - <div class="line"><a name="l00145"></a><span class="lineno">  145</span>         DISTRHO_SAFE_ASSERT_RETURN(handle.p != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>
 - <div class="line"><a name="l00146"></a><span class="lineno">  146</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00147"></a><span class="lineno">  147</span>         DISTRHO_SAFE_ASSERT_RETURN(handle != 0, <span class="keyword">false</span>);</div>
 - <div class="line"><a name="l00148"></a><span class="lineno">  148</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00149"></a><span class="lineno">  149</span>         pthread_detach(handle);</div>
 - <div class="line"><a name="l00150"></a><span class="lineno">  150</span>         _copyFrom(handle);</div>
 - <div class="line"><a name="l00151"></a><span class="lineno">  151</span>  </div>
 - <div class="line"><a name="l00152"></a><span class="lineno">  152</span>         <span class="comment">// wait for thread to start</span></div>
 - <div class="line"><a name="l00153"></a><span class="lineno">  153</span>         fSignal.wait();</div>
 - <div class="line"><a name="l00154"></a><span class="lineno">  154</span>         <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
 - <div class="line"><a name="l00155"></a><span class="lineno">  155</span>     }</div>
 - <div class="line"><a name="l00156"></a><span class="lineno">  156</span>  </div>
 - <div class="line"><a name="l00157"></a><span class="lineno">  157</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00158"></a><span class="lineno">  158</span> <span class="comment">     * Stop the thread.</span></div>
 - <div class="line"><a name="l00159"></a><span class="lineno">  159</span> <span class="comment">     * In the 'timeOutMilliseconds':</span></div>
 - <div class="line"><a name="l00160"></a><span class="lineno">  160</span> <span class="comment">     * = 0 -> no wait</span></div>
 - <div class="line"><a name="l00161"></a><span class="lineno">  161</span> <span class="comment">     * > 0 -> wait timeout value</span></div>
 - <div class="line"><a name="l00162"></a><span class="lineno">  162</span> <span class="comment">     * < 0 -> wait forever</span></div>
 - <div class="line"><a name="l00163"></a><span class="lineno">  163</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00164"></a><span class="lineno">  164</span>     <span class="keywordtype">bool</span> stopThread(<span class="keyword">const</span> <span class="keywordtype">int</span> timeOutMilliseconds) noexcept</div>
 - <div class="line"><a name="l00165"></a><span class="lineno">  165</span>     {</div>
 - <div class="line"><a name="l00166"></a><span class="lineno">  166</span>         <span class="keyword">const</span> <a class="code" href="classScopeLocker.html">MutexLocker</a> ml(fLock);</div>
 - <div class="line"><a name="l00167"></a><span class="lineno">  167</span>  </div>
 - <div class="line"><a name="l00168"></a><span class="lineno">  168</span>         <span class="keywordflow">if</span> (isThreadRunning())</div>
 - <div class="line"><a name="l00169"></a><span class="lineno">  169</span>         {</div>
 - <div class="line"><a name="l00170"></a><span class="lineno">  170</span>             signalThreadShouldExit();</div>
 - <div class="line"><a name="l00171"></a><span class="lineno">  171</span>  </div>
 - <div class="line"><a name="l00172"></a><span class="lineno">  172</span>             <span class="keywordflow">if</span> (timeOutMilliseconds != 0)</div>
 - <div class="line"><a name="l00173"></a><span class="lineno">  173</span>             {</div>
 - <div class="line"><a name="l00174"></a><span class="lineno">  174</span>                 <span class="comment">// Wait for the thread to stop</span></div>
 - <div class="line"><a name="l00175"></a><span class="lineno">  175</span>                 <span class="keywordtype">int</span> timeOutCheck = (timeOutMilliseconds == 1 || timeOutMilliseconds == -1) ? timeOutMilliseconds : timeOutMilliseconds/2;</div>
 - <div class="line"><a name="l00176"></a><span class="lineno">  176</span>  </div>
 - <div class="line"><a name="l00177"></a><span class="lineno">  177</span>                 <span class="keywordflow">for</span> (; isThreadRunning();)</div>
 - <div class="line"><a name="l00178"></a><span class="lineno">  178</span>                 {</div>
 - <div class="line"><a name="l00179"></a><span class="lineno">  179</span>                     d_msleep(2);</div>
 - <div class="line"><a name="l00180"></a><span class="lineno">  180</span>  </div>
 - <div class="line"><a name="l00181"></a><span class="lineno">  181</span>                     <span class="keywordflow">if</span> (timeOutCheck < 0)</div>
 - <div class="line"><a name="l00182"></a><span class="lineno">  182</span>                         <span class="keywordflow">continue</span>;</div>
 - <div class="line"><a name="l00183"></a><span class="lineno">  183</span>  </div>
 - <div class="line"><a name="l00184"></a><span class="lineno">  184</span>                     <span class="keywordflow">if</span> (timeOutCheck > 0)</div>
 - <div class="line"><a name="l00185"></a><span class="lineno">  185</span>                         timeOutCheck -= 1;</div>
 - <div class="line"><a name="l00186"></a><span class="lineno">  186</span>                     <span class="keywordflow">else</span></div>
 - <div class="line"><a name="l00187"></a><span class="lineno">  187</span>                         <span class="keywordflow">break</span>;</div>
 - <div class="line"><a name="l00188"></a><span class="lineno">  188</span>                 }</div>
 - <div class="line"><a name="l00189"></a><span class="lineno">  189</span>             }</div>
 - <div class="line"><a name="l00190"></a><span class="lineno">  190</span>  </div>
 - <div class="line"><a name="l00191"></a><span class="lineno">  191</span>             <span class="keywordflow">if</span> (isThreadRunning())</div>
 - <div class="line"><a name="l00192"></a><span class="lineno">  192</span>             {</div>
 - <div class="line"><a name="l00193"></a><span class="lineno">  193</span>                 <span class="comment">// should never happen!</span></div>
 - <div class="line"><a name="l00194"></a><span class="lineno">  194</span>                 d_stderr2(<span class="stringliteral">"assertion failure: \"! isThreadRunning()\" in file %s, line %i"</span>, __FILE__, __LINE__);</div>
 - <div class="line"><a name="l00195"></a><span class="lineno">  195</span>  </div>
 - <div class="line"><a name="l00196"></a><span class="lineno">  196</span>                 <span class="comment">// copy thread id so we can clear our one</span></div>
 - <div class="line"><a name="l00197"></a><span class="lineno">  197</span>                 pthread_t threadId;</div>
 - <div class="line"><a name="l00198"></a><span class="lineno">  198</span>                 _copyTo(threadId);</div>
 - <div class="line"><a name="l00199"></a><span class="lineno">  199</span>                 _init();</div>
 - <div class="line"><a name="l00200"></a><span class="lineno">  200</span>  </div>
 - <div class="line"><a name="l00201"></a><span class="lineno">  201</span>                 pthread_detach(threadId);</div>
 - <div class="line"><a name="l00202"></a><span class="lineno">  202</span>                 <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
 - <div class="line"><a name="l00203"></a><span class="lineno">  203</span>             }</div>
 - <div class="line"><a name="l00204"></a><span class="lineno">  204</span>         }</div>
 - <div class="line"><a name="l00205"></a><span class="lineno">  205</span>  </div>
 - <div class="line"><a name="l00206"></a><span class="lineno">  206</span>         <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
 - <div class="line"><a name="l00207"></a><span class="lineno">  207</span>     }</div>
 - <div class="line"><a name="l00208"></a><span class="lineno">  208</span>  </div>
 - <div class="line"><a name="l00209"></a><span class="lineno">  209</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00210"></a><span class="lineno">  210</span> <span class="comment">     * Tell the thread to stop as soon as possible.</span></div>
 - <div class="line"><a name="l00211"></a><span class="lineno">  211</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00212"></a><span class="lineno">  212</span>     <span class="keywordtype">void</span> signalThreadShouldExit() noexcept</div>
 - <div class="line"><a name="l00213"></a><span class="lineno">  213</span>     {</div>
 - <div class="line"><a name="l00214"></a><span class="lineno">  214</span>         fShouldExit = <span class="keyword">true</span>;</div>
 - <div class="line"><a name="l00215"></a><span class="lineno">  215</span>     }</div>
 - <div class="line"><a name="l00216"></a><span class="lineno">  216</span>  </div>
 - <div class="line"><a name="l00217"></a><span class="lineno">  217</span>     <span class="comment">// -------------------------------------------------------------------</span></div>
 - <div class="line"><a name="l00218"></a><span class="lineno">  218</span>  </div>
 - <div class="line"><a name="l00219"></a><span class="lineno">  219</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00220"></a><span class="lineno">  220</span> <span class="comment">     * Returns the name of the thread.</span></div>
 - <div class="line"><a name="l00221"></a><span class="lineno">  221</span> <span class="comment">     * This is the name that gets set in the constructor.</span></div>
 - <div class="line"><a name="l00222"></a><span class="lineno">  222</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00223"></a><span class="lineno">  223</span>     <span class="keyword">const</span> <a class="code" href="classString.html">String</a>& getThreadName() <span class="keyword">const</span> noexcept</div>
 - <div class="line"><a name="l00224"></a><span class="lineno">  224</span>     {</div>
 - <div class="line"><a name="l00225"></a><span class="lineno">  225</span>         <span class="keywordflow">return</span> fName;</div>
 - <div class="line"><a name="l00226"></a><span class="lineno">  226</span>     }</div>
 - <div class="line"><a name="l00227"></a><span class="lineno">  227</span>  </div>
 - <div class="line"><a name="l00228"></a><span class="lineno">  228</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00229"></a><span class="lineno">  229</span> <span class="comment">     * Returns the Id/handle of the thread.</span></div>
 - <div class="line"><a name="l00230"></a><span class="lineno">  230</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00231"></a><span class="lineno">  231</span>     pthread_t getThreadId() <span class="keyword">const</span> noexcept</div>
 - <div class="line"><a name="l00232"></a><span class="lineno">  232</span>     {</div>
 - <div class="line"><a name="l00233"></a><span class="lineno">  233</span>         <span class="keywordflow">return</span> fHandle;</div>
 - <div class="line"><a name="l00234"></a><span class="lineno">  234</span>     }</div>
 - <div class="line"><a name="l00235"></a><span class="lineno">  235</span>  </div>
 - <div class="line"><a name="l00236"></a><span class="lineno">  236</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00237"></a><span class="lineno">  237</span> <span class="comment">     * Changes the name of the caller thread.</span></div>
 - <div class="line"><a name="l00238"></a><span class="lineno">  238</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00239"></a><span class="lineno">  239</span>     <span class="keyword">static</span> <span class="keywordtype">void</span> setCurrentThreadName(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> name) noexcept</div>
 - <div class="line"><a name="l00240"></a><span class="lineno">  240</span>     {</div>
 - <div class="line"><a name="l00241"></a><span class="lineno">  241</span>         DISTRHO_SAFE_ASSERT_RETURN(name != <span class="keyword">nullptr</span> && name[0] != <span class="charliteral">'\0'</span>,);</div>
 - <div class="line"><a name="l00242"></a><span class="lineno">  242</span>  </div>
 - <div class="line"><a name="l00243"></a><span class="lineno">  243</span> <span class="preprocessor">#ifdef DISTRHO_OS_LINUX</span></div>
 - <div class="line"><a name="l00244"></a><span class="lineno">  244</span>         prctl(PR_SET_NAME, name, 0, 0, 0);</div>
 - <div class="line"><a name="l00245"></a><span class="lineno">  245</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00246"></a><span class="lineno">  246</span> <span class="preprocessor">#if defined(__GLIBC__) && (__GLIBC__ * 1000 + __GLIBC_MINOR__) >= 2012 && !defined(DISTRHO_OS_GNU_HURD)</span></div>
 - <div class="line"><a name="l00247"></a><span class="lineno">  247</span>         pthread_setname_np(pthread_self(), name);</div>
 - <div class="line"><a name="l00248"></a><span class="lineno">  248</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00249"></a><span class="lineno">  249</span>     }</div>
 - <div class="line"><a name="l00250"></a><span class="lineno">  250</span>  </div>
 - <div class="line"><a name="l00251"></a><span class="lineno">  251</span>     <span class="comment">// -------------------------------------------------------------------</span></div>
 - <div class="line"><a name="l00252"></a><span class="lineno">  252</span>  </div>
 - <div class="line"><a name="l00253"></a><span class="lineno">  253</span> <span class="keyword">private</span>:</div>
 - <div class="line"><a name="l00254"></a><span class="lineno">  254</span>     <a class="code" href="classMutex.html">Mutex</a>              fLock;       <span class="comment">// Thread lock</span></div>
 - <div class="line"><a name="l00255"></a><span class="lineno">  255</span>     <a class="code" href="classSignal.html">Signal</a>             fSignal;     <span class="comment">// Thread start wait signal</span></div>
 - <div class="line"><a name="l00256"></a><span class="lineno">  256</span>     <span class="keyword">const</span> <a class="code" href="classString.html">String</a>       fName;       <span class="comment">// Thread name</span></div>
 - <div class="line"><a name="l00257"></a><span class="lineno">  257</span>     <span class="keyword">volatile</span> pthread_t fHandle;     <span class="comment">// Handle for this thread</span></div>
 - <div class="line"><a name="l00258"></a><span class="lineno">  258</span>     <span class="keyword">volatile</span> <span class="keywordtype">bool</span>      fShouldExit; <span class="comment">// true if thread should exit</span></div>
 - <div class="line"><a name="l00259"></a><span class="lineno">  259</span>  </div>
 - <div class="line"><a name="l00260"></a><span class="lineno">  260</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00261"></a><span class="lineno">  261</span> <span class="comment">     * Init pthread type.</span></div>
 - <div class="line"><a name="l00262"></a><span class="lineno">  262</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00263"></a><span class="lineno">  263</span>     <span class="keywordtype">void</span> _init() noexcept</div>
 - <div class="line"><a name="l00264"></a><span class="lineno">  264</span>     {</div>
 - <div class="line"><a name="l00265"></a><span class="lineno">  265</span> <span class="preprocessor">#ifdef PTW32_DLLPORT</span></div>
 - <div class="line"><a name="l00266"></a><span class="lineno">  266</span>         fHandle.p = <span class="keyword">nullptr</span>;</div>
 - <div class="line"><a name="l00267"></a><span class="lineno">  267</span>         fHandle.x = 0;</div>
 - <div class="line"><a name="l00268"></a><span class="lineno">  268</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00269"></a><span class="lineno">  269</span>         fHandle = 0;</div>
 - <div class="line"><a name="l00270"></a><span class="lineno">  270</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00271"></a><span class="lineno">  271</span>     }</div>
 - <div class="line"><a name="l00272"></a><span class="lineno">  272</span>  </div>
 - <div class="line"><a name="l00273"></a><span class="lineno">  273</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00274"></a><span class="lineno">  274</span> <span class="comment">     * Copy our pthread type from another var.</span></div>
 - <div class="line"><a name="l00275"></a><span class="lineno">  275</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00276"></a><span class="lineno">  276</span>     <span class="keywordtype">void</span> _copyFrom(<span class="keyword">const</span> pthread_t& handle) noexcept</div>
 - <div class="line"><a name="l00277"></a><span class="lineno">  277</span>     {</div>
 - <div class="line"><a name="l00278"></a><span class="lineno">  278</span> <span class="preprocessor">#ifdef PTW32_DLLPORT</span></div>
 - <div class="line"><a name="l00279"></a><span class="lineno">  279</span>         fHandle.p = handle.p;</div>
 - <div class="line"><a name="l00280"></a><span class="lineno">  280</span>         fHandle.x = handle.x;</div>
 - <div class="line"><a name="l00281"></a><span class="lineno">  281</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00282"></a><span class="lineno">  282</span>         fHandle = handle;</div>
 - <div class="line"><a name="l00283"></a><span class="lineno">  283</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00284"></a><span class="lineno">  284</span>     }</div>
 - <div class="line"><a name="l00285"></a><span class="lineno">  285</span>  </div>
 - <div class="line"><a name="l00286"></a><span class="lineno">  286</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00287"></a><span class="lineno">  287</span> <span class="comment">     * Copy our pthread type to another var.</span></div>
 - <div class="line"><a name="l00288"></a><span class="lineno">  288</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00289"></a><span class="lineno">  289</span>     <span class="keywordtype">void</span> _copyTo(<span class="keyword">volatile</span> pthread_t& handle) <span class="keyword">const</span> noexcept</div>
 - <div class="line"><a name="l00290"></a><span class="lineno">  290</span>     {</div>
 - <div class="line"><a name="l00291"></a><span class="lineno">  291</span> <span class="preprocessor">#ifdef PTW32_DLLPORT</span></div>
 - <div class="line"><a name="l00292"></a><span class="lineno">  292</span>         handle.p = fHandle.p;</div>
 - <div class="line"><a name="l00293"></a><span class="lineno">  293</span>         handle.x = fHandle.x;</div>
 - <div class="line"><a name="l00294"></a><span class="lineno">  294</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00295"></a><span class="lineno">  295</span>         handle = fHandle;</div>
 - <div class="line"><a name="l00296"></a><span class="lineno">  296</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00297"></a><span class="lineno">  297</span>     }</div>
 - <div class="line"><a name="l00298"></a><span class="lineno">  298</span>  </div>
 - <div class="line"><a name="l00299"></a><span class="lineno">  299</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00300"></a><span class="lineno">  300</span> <span class="comment">     * Thread entry point.</span></div>
 - <div class="line"><a name="l00301"></a><span class="lineno">  301</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00302"></a><span class="lineno">  302</span>     <span class="keywordtype">void</span> _runEntryPoint() noexcept</div>
 - <div class="line"><a name="l00303"></a><span class="lineno">  303</span>     {</div>
 - <div class="line"><a name="l00304"></a><span class="lineno">  304</span>         <span class="keywordflow">if</span> (fName.isNotEmpty())</div>
 - <div class="line"><a name="l00305"></a><span class="lineno">  305</span>             setCurrentThreadName(fName);</div>
 - <div class="line"><a name="l00306"></a><span class="lineno">  306</span>  </div>
 - <div class="line"><a name="l00307"></a><span class="lineno">  307</span>         <span class="comment">// report ready</span></div>
 - <div class="line"><a name="l00308"></a><span class="lineno">  308</span>         fSignal.signal();</div>
 - <div class="line"><a name="l00309"></a><span class="lineno">  309</span>  </div>
 - <div class="line"><a name="l00310"></a><span class="lineno">  310</span>         <span class="keywordflow">try</span> {</div>
 - <div class="line"><a name="l00311"></a><span class="lineno">  311</span>             run();</div>
 - <div class="line"><a name="l00312"></a><span class="lineno">  312</span>         } <span class="keywordflow">catch</span>(...) {}</div>
 - <div class="line"><a name="l00313"></a><span class="lineno">  313</span>  </div>
 - <div class="line"><a name="l00314"></a><span class="lineno">  314</span>         <span class="comment">// done</span></div>
 - <div class="line"><a name="l00315"></a><span class="lineno">  315</span>         _init();</div>
 - <div class="line"><a name="l00316"></a><span class="lineno">  316</span>     }</div>
 - <div class="line"><a name="l00317"></a><span class="lineno">  317</span>  </div>
 - <div class="line"><a name="l00318"></a><span class="lineno">  318</span>     <span class="comment">/*</span></div>
 - <div class="line"><a name="l00319"></a><span class="lineno">  319</span> <span class="comment">     * Thread entry point.</span></div>
 - <div class="line"><a name="l00320"></a><span class="lineno">  320</span> <span class="comment">     */</span></div>
 - <div class="line"><a name="l00321"></a><span class="lineno">  321</span>     <span class="keyword">static</span> <span class="keywordtype">void</span>* _entryPoint(<span class="keywordtype">void</span>* userData) noexcept</div>
 - <div class="line"><a name="l00322"></a><span class="lineno">  322</span>     {</div>
 - <div class="line"><a name="l00323"></a><span class="lineno">  323</span>         <span class="keyword">static_cast<</span><a class="code" href="classThread.html">Thread</a>*<span class="keyword">></span>(userData)->_runEntryPoint();</div>
 - <div class="line"><a name="l00324"></a><span class="lineno">  324</span>         <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
 - <div class="line"><a name="l00325"></a><span class="lineno">  325</span>     }</div>
 - <div class="line"><a name="l00326"></a><span class="lineno">  326</span>  </div>
 - <div class="line"><a name="l00327"></a><span class="lineno">  327</span>     DISTRHO_DECLARE_NON_COPYABLE(<a class="code" href="classThread.html">Thread</a>)</div>
 - <div class="line"><a name="l00328"></a><span class="lineno">  328</span> };</div>
 - <div class="line"><a name="l00329"></a><span class="lineno">  329</span>  </div>
 - <div class="line"><a name="l00330"></a><span class="lineno">  330</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
 - <div class="line"><a name="l00331"></a><span class="lineno">  331</span>  </div>
 - <div class="line"><a name="l00332"></a><span class="lineno">  332</span> END_NAMESPACE_DISTRHO</div>
 - <div class="line"><a name="l00333"></a><span class="lineno">  333</span>  </div>
 - <div class="line"><a name="l00334"></a><span class="lineno">  334</span> <span class="preprocessor">#endif // DISTRHO_THREAD_HPP_INCLUDED</span></div>
 - </div><!-- fragment --></div><!-- contents -->
 - <div class="ttc" id="aclassString_html"><div class="ttname"><a href="classString.html">String</a></div><div class="ttdef"><b>Definition:</b> String.hpp:30</div></div>
 - <div class="ttc" id="aclassSignal_html"><div class="ttname"><a href="classSignal.html">Signal</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:183</div></div>
 - <div class="ttc" id="aclassScopeLocker_html"><div class="ttname"><a href="classScopeLocker.html">ScopeLocker</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:265</div></div>
 - <div class="ttc" id="aclassMutex_html"><div class="ttname"><a href="classMutex.html">Mutex</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:36</div></div>
 - <div class="ttc" id="aclassThread_html"><div class="ttname"><a href="classThread.html">Thread</a></div><div class="ttdef"><b>Definition:</b> Thread.hpp:33</div></div>
 - <!-- start footer part -->
 - <hr class="footer"/><address class="footer"><small>
 - Generated on Sat Jul 3 2021 23:07:05 for DISTRHO Plugin Framework by  <a href="http://www.doxygen.org/index.html">
 - <img class="footer" src="doxygen.png" alt="doxygen"/>
 - </a> 1.8.17
 - </small></address>
 - </body>
 - </html>
 
 
  |