DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
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.
385 Commits
7 Branches
56MB
Tree: 20d5006e9a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '20d5006e9a'
${ noResults }
DPF/Mutex_8hpp_source.html

379 lines
40KB
Raw Blame History 

  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: distrho/extra/Mutex.hpp Source File</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><a href="annotated.html"><span>Classes</span></a></li>

  43.       <li class="current"><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="files.html"><span>File&#160;List</span></a></li>

  65.     </ul>

  66.   </div>

  67. <!-- window showing the filter options -->

  68. <div id="MSearchSelectWindow"

  69.      onmouseover="return searchBox.OnSearchSelectShow()"

  70.      onmouseout="return searchBox.OnSearchSelectHide()"

  71.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  72. </div>

  73. 

  74. <!-- iframe showing the search results (closed by default) -->

  75. <div id="MSearchResultsWindow">

  76. <iframe src="javascript:void(0)" frameborder="0" 

  77.         name="MSearchResults" id="MSearchResults">

  78. </iframe>

  79. </div>

  80. 

  81. <div id="nav-path" class="navpath">

  82.   <ul>

  83. <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>

  84. </div>

  85. </div><!-- top -->

  86. <div class="header">

  87.   <div class="headertitle">

  88. <div class="title">Mutex.hpp</div>  </div>

  89. </div><!--header-->

  90. <div class="contents">

  91. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>

  92. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>

  93. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright (C) 2012-2015 Filipe Coelho &lt;falktx@falktx.com&gt;</span></div>

  94. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>

  95. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>

  96. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>

  97. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * permission notice appear in all copies.</span></div>

  98. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>

  99. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>

  100. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>

  101. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>

  102. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>

  103. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>

  104. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>

  105. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>

  106. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>

  107. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef DISTRHO_MUTEX_HPP_INCLUDED</span></div>

  108. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define DISTRHO_MUTEX_HPP_INCLUDED</span></div>

  109. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div>

  110. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;../DistrhoUtils.hpp&quot;</span></div>

  111. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>

  112. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  113. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor"># include &lt;winsock2.h&gt;</span></div>

  114. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor"># include &lt;windows.h&gt;</span></div>

  115. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#endif</span></div>

  116. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div>

  117. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;pthread.h&gt;</span></div>

  118. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>

  119. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;START_NAMESPACE_DISTRHO</div>

  120. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>

  121. <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  122. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">// Mutex class</span></div>

  123. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>

  124. <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classMutex.html">   34</a></span>&#160;<span class="keyword">class </span><a class="code" href="classMutex.html">Mutex</a></div>

  125. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;{</div>

  126. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="keyword">public</span>:</div>

  127. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="comment">/*</span></div>

  128. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">     * Constructor.</span></div>

  129. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">     */</span></div>

  130. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <a class="code" href="classMutex.html">Mutex</a>() noexcept</div>

  131. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        : fMutex()</div>

  132. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    {</div>

  133. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;        pthread_mutex_init(&amp;fMutex, <span class="keyword">nullptr</span>);</div>

  134. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    }</div>

  135. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>

  136. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="comment">/*</span></div>

  137. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">     * Destructor.</span></div>

  138. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">     */</span></div>

  139. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    ~<a class="code" href="classMutex.html">Mutex</a>() noexcept</div>

  140. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    {</div>

  141. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        pthread_mutex_destroy(&amp;fMutex);</div>

  142. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    }</div>

  143. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>

  144. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="comment">/*</span></div>

  145. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">     * Lock the mutex.</span></div>

  146. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">     */</span></div>

  147. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordtype">void</span> lock() <span class="keyword">const</span> noexcept</div>

  148. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    {</div>

  149. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;        pthread_mutex_lock(&amp;fMutex);</div>

  150. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    }</div>

  151. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div>

  152. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="comment">/*</span></div>

  153. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">     * Try to lock the mutex.</span></div>

  154. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">     * Returns true if successful.</span></div>

  155. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">     */</span></div>

  156. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="keywordtype">bool</span> tryLock() <span class="keyword">const</span> noexcept</div>

  157. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    {</div>

  158. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;        <span class="keywordflow">return</span> (pthread_mutex_trylock(&amp;fMutex) == 0);</div>

  159. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    }</div>

  160. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>

  161. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="comment">/*</span></div>

  162. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">     * Unlock the mutex.</span></div>

  163. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">     */</span></div>

  164. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keywordtype">void</span> unlock() <span class="keyword">const</span> noexcept</div>

  165. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    {</div>

  166. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;        pthread_mutex_unlock(&amp;fMutex);</div>

  167. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    }</div>

  168. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>

  169. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="keyword">private</span>:</div>

  170. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keyword">mutable</span> pthread_mutex_t fMutex;</div>

  171. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>

  172. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    DISTRHO_PREVENT_HEAP_ALLOCATION</div>

  173. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    DISTRHO_DECLARE_NON_COPY_CLASS(<a class="code" href="classMutex.html">Mutex</a>)</div>

  174. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;};</div>

  175. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>

  176. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  177. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment">// RecursiveMutex class</span></div>

  178. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>

  179. <div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classRecursiveMutex.html">   89</a></span>&#160;<span class="keyword">class </span><a class="code" href="classRecursiveMutex.html">RecursiveMutex</a></div>

  180. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;{</div>

  181. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="keyword">public</span>:</div>

  182. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="comment">/*</span></div>

  183. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment">     * Constructor.</span></div>

  184. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">     */</span></div>

  185. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <a class="code" href="classRecursiveMutex.html">RecursiveMutex</a>() noexcept</div>

  186. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  187. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        : fSection()</div>

  188. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="preprocessor">#else</span></div>

  189. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;        : fMutex()</div>

  190. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="preprocessor">#endif</span></div>

  191. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    {</div>

  192. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  193. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        InitializeCriticalSection(&amp;fSection);</div>

  194. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="preprocessor">#else</span></div>

  195. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        pthread_mutexattr_t atts;</div>

  196. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        pthread_mutexattr_init(&amp;atts);</div>

  197. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        pthread_mutexattr_settype(&amp;atts, PTHREAD_MUTEX_RECURSIVE);</div>

  198. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        pthread_mutex_init(&amp;fMutex, &amp;atts);</div>

  199. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        pthread_mutexattr_destroy(&amp;atts);</div>

  200. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="preprocessor">#endif</span></div>

  201. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    }</div>

  202. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div>

  203. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    <span class="comment">/*</span></div>

  204. <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">     * Destructor.</span></div>

  205. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">     */</span></div>

  206. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    ~<a class="code" href="classRecursiveMutex.html">RecursiveMutex</a>() noexcept</div>

  207. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    {</div>

  208. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  209. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        DeleteCriticalSection(&amp;fSection);</div>

  210. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="preprocessor">#else</span></div>

  211. <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        pthread_mutex_destroy(&amp;fMutex);</div>

  212. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="preprocessor">#endif</span></div>

  213. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    }</div>

  214. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div>

  215. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    <span class="comment">/*</span></div>

  216. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment">     * Lock the mutex.</span></div>

  217. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">     */</span></div>

  218. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <span class="keywordtype">void</span> lock() <span class="keyword">const</span> noexcept</div>

  219. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    {</div>

  220. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  221. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        EnterCriticalSection(&amp;fSection);</div>

  222. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="preprocessor">#else</span></div>

  223. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;        pthread_mutex_lock(&amp;fMutex);</div>

  224. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="preprocessor">#endif</span></div>

  225. <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    }</div>

  226. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;</div>

  227. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;    <span class="comment">/*</span></div>

  228. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment">     * Try to lock the mutex.</span></div>

  229. <div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment">     * Returns true if successful.</span></div>

  230. <div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment">     */</span></div>

  231. <div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    <span class="keywordtype">bool</span> tryLock() <span class="keyword">const</span> noexcept</div>

  232. <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    {</div>

  233. <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  234. <div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;        <span class="keywordflow">return</span> (TryEnterCriticalSection(&amp;fSection) != FALSE);</div>

  235. <div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="preprocessor">#else</span></div>

  236. <div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;        <span class="keywordflow">return</span> (pthread_mutex_trylock(&amp;fMutex) == 0);</div>

  237. <div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="preprocessor">#endif</span></div>

  238. <div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    }</div>

  239. <div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;</div>

  240. <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    <span class="comment">/*</span></div>

  241. <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">     * Unlock the mutex.</span></div>

  242. <div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment">     */</span></div>

  243. <div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;    <span class="keywordtype">void</span> unlock() <span class="keyword">const</span> noexcept</div>

  244. <div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    {</div>

  245. <div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  246. <div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;        LeaveCriticalSection(&amp;fSection);</div>

  247. <div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="preprocessor">#else</span></div>

  248. <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;        pthread_mutex_unlock(&amp;fMutex);</div>

  249. <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="preprocessor">#endif</span></div>

  250. <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;    }</div>

  251. <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;</div>

  252. <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="keyword">private</span>:</div>

  253. <div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>

  254. <div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    <span class="keyword">mutable</span> CRITICAL_SECTION fSection;</div>

  255. <div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="preprocessor">#else</span></div>

  256. <div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;    <span class="keyword">mutable</span> pthread_mutex_t fMutex;</div>

  257. <div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="preprocessor">#endif</span></div>

  258. <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;</div>

  259. <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    DISTRHO_PREVENT_HEAP_ALLOCATION</div>

  260. <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    DISTRHO_DECLARE_NON_COPY_CLASS(<a class="code" href="classRecursiveMutex.html">RecursiveMutex</a>)</div>

  261. <div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;};</div>

  262. <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;</div>

  263. <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  264. <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<span class="comment">// Helper class to lock&amp;unlock a mutex during a function scope.</span></div>

  265. <div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;</div>

  266. <div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> Mutex&gt;</div>

  267. <div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="classScopeLocker.html">  177</a></span>&#160;<span class="keyword">class </span><a class="code" href="classScopeLocker.html">ScopeLocker</a></div>

  268. <div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;{</div>

  269. <div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="keyword">public</span>:</div>

  270. <div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;    <a class="code" href="classScopeLocker.html">ScopeLocker</a>(<span class="keyword">const</span> <a class="code" href="classMutex.html">Mutex</a>&amp; mutex) noexcept</div>

  271. <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;        : fMutex(mutex)</div>

  272. <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    {</div>

  273. <div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;        fMutex.lock();</div>

  274. <div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;    }</div>

  275. <div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;</div>

  276. <div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    ~<a class="code" href="classScopeLocker.html">ScopeLocker</a>() noexcept</div>

  277. <div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;    {</div>

  278. <div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;        fMutex.unlock();</div>

  279. <div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;    }</div>

  280. <div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;</div>

  281. <div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="keyword">private</span>:</div>

  282. <div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;    <span class="keyword">const</span> <a class="code" href="classMutex.html">Mutex</a>&amp; fMutex;</div>

  283. <div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;</div>

  284. <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;    DISTRHO_PREVENT_HEAP_ALLOCATION</div>

  285. <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;    DISTRHO_DECLARE_NON_COPY_CLASS(<a class="code" href="classScopeLocker.html">ScopeLocker</a>)</div>

  286. <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;};</div>

  287. <div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;</div>

  288. <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  289. <div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment">// Helper class to try-lock&amp;unlock a mutex during a function scope.</span></div>

  290. <div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;</div>

  291. <div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> Mutex&gt;</div>

  292. <div class="line"><a name="l00202"></a><span class="lineno"><a class="line" href="classScopeTryLocker.html">  202</a></span>&#160;<span class="keyword">class </span><a class="code" href="classScopeTryLocker.html">ScopeTryLocker</a></div>

  293. <div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;{</div>

  294. <div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="keyword">public</span>:</div>

  295. <div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;    <a class="code" href="classScopeTryLocker.html">ScopeTryLocker</a>(<span class="keyword">const</span> <a class="code" href="classMutex.html">Mutex</a>&amp; mutex) noexcept</div>

  296. <div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;        : fMutex(mutex),</div>

  297. <div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;          fLocked(mutex.tryLock()) {}</div>

  298. <div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;</div>

  299. <div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;    ~<a class="code" href="classScopeTryLocker.html">ScopeTryLocker</a>() noexcept</div>

  300. <div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;    {</div>

  301. <div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;        <span class="keywordflow">if</span> (fLocked)</div>

  302. <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;            fMutex.unlock();</div>

  303. <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;    }</div>

  304. <div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;</div>

  305. <div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;    <span class="keywordtype">bool</span> wasLocked() <span class="keyword">const</span> noexcept</div>

  306. <div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;    {</div>

  307. <div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;        <span class="keywordflow">return</span> fLocked;</div>

  308. <div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;    }</div>

  309. <div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;</div>

  310. <div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;    <span class="keywordtype">bool</span> wasNotLocked() <span class="keyword">const</span> noexcept</div>

  311. <div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;    {</div>

  312. <div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;        <span class="keywordflow">return</span> !fLocked;</div>

  313. <div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;    }</div>

  314. <div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;</div>

  315. <div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="keyword">private</span>:</div>

  316. <div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;    <span class="keyword">const</span> <a class="code" href="classMutex.html">Mutex</a>&amp; fMutex;</div>

  317. <div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;    <span class="keyword">const</span> <span class="keywordtype">bool</span>   fLocked;</div>

  318. <div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;</div>

  319. <div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;    DISTRHO_PREVENT_HEAP_ALLOCATION</div>

  320. <div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;    DISTRHO_DECLARE_NON_COPY_CLASS(<a class="code" href="classScopeTryLocker.html">ScopeTryLocker</a>)</div>

  321. <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;};</div>

  322. <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;</div>

  323. <div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  324. <div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment">// Helper class to unlock&amp;lock a mutex during a function scope.</span></div>

  325. <div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;</div>

  326. <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> Mutex&gt;</div>

  327. <div class="line"><a name="l00237"></a><span class="lineno"><a class="line" href="classScopeUnlocker.html">  237</a></span>&#160;<span class="keyword">class </span><a class="code" href="classScopeUnlocker.html">ScopeUnlocker</a></div>

  328. <div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;{</div>

  329. <div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="keyword">public</span>:</div>

  330. <div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;    <a class="code" href="classScopeUnlocker.html">ScopeUnlocker</a>(<span class="keyword">const</span> <a class="code" href="classMutex.html">Mutex</a>&amp; mutex) noexcept</div>

  331. <div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;        : fMutex(mutex)</div>

  332. <div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;    {</div>

  333. <div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;        fMutex.unlock();</div>

  334. <div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;    }</div>

  335. <div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;</div>

  336. <div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;    ~<a class="code" href="classScopeUnlocker.html">ScopeUnlocker</a>() noexcept</div>

  337. <div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;    {</div>

  338. <div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;        fMutex.lock();</div>

  339. <div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;    }</div>

  340. <div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;</div>

  341. <div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;<span class="keyword">private</span>:</div>

  342. <div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;    <span class="keyword">const</span> <a class="code" href="classMutex.html">Mutex</a>&amp; fMutex;</div>

  343. <div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;</div>

  344. <div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;    DISTRHO_PREVENT_HEAP_ALLOCATION</div>

  345. <div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;    DISTRHO_DECLARE_NON_COPY_CLASS(<a class="code" href="classScopeUnlocker.html">ScopeUnlocker</a>)</div>

  346. <div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;};</div>

  347. <div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;</div>

  348. <div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  349. <div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment">// Define types</span></div>

  350. <div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;</div>

  351. <div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;<span class="keyword">typedef</span> <a class="code" href="classScopeLocker.html">ScopeLocker&lt;Mutex&gt;</a>          <a class="code" href="classScopeLocker.html">MutexLocker</a>;</div>

  352. <div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;<span class="keyword">typedef</span> <a class="code" href="classScopeLocker.html">ScopeLocker&lt;RecursiveMutex&gt;</a> <a class="code" href="classScopeLocker.html">RecursiveMutexLocker</a>;</div>

  353. <div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;</div>

  354. <div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;<span class="keyword">typedef</span> <a class="code" href="classScopeTryLocker.html">ScopeTryLocker&lt;Mutex&gt;</a>          <a class="code" href="classScopeTryLocker.html">MutexTryLocker</a>;</div>

  355. <div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;<span class="keyword">typedef</span> <a class="code" href="classScopeTryLocker.html">ScopeTryLocker&lt;RecursiveMutex&gt;</a> <a class="code" href="classScopeTryLocker.html">RecursiveMutexTryLocker</a>;</div>

  356. <div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;</div>

  357. <div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;<span class="keyword">typedef</span> <a class="code" href="classScopeUnlocker.html">ScopeUnlocker&lt;Mutex&gt;</a>          <a class="code" href="classScopeUnlocker.html">MutexUnlocker</a>;</div>

  358. <div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="keyword">typedef</span> <a class="code" href="classScopeUnlocker.html">ScopeUnlocker&lt;RecursiveMutex&gt;</a> <a class="code" href="classScopeUnlocker.html">RecursiveMutexUnlocker</a>;</div>

  359. <div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;</div>

  360. <div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;<span class="comment">// -----------------------------------------------------------------------</span></div>

  361. <div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;</div>

  362. <div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;END_NAMESPACE_DISTRHO</div>

  363. <div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;</div>

  364. <div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;<span class="preprocessor">#endif // DISTRHO_MUTEX_HPP_INCLUDED</span></div>

  365. <div class="ttc" id="classRecursiveMutex_html"><div class="ttname"><a href="classRecursiveMutex.html">RecursiveMutex</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:89</div></div>

  366. <div class="ttc" id="classScopeLocker_html"><div class="ttname"><a href="classScopeLocker.html">ScopeLocker</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:177</div></div>

  367. <div class="ttc" id="classScopeTryLocker_html"><div class="ttname"><a href="classScopeTryLocker.html">ScopeTryLocker</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:202</div></div>

  368. <div class="ttc" id="classMutex_html"><div class="ttname"><a href="classMutex.html">Mutex</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:34</div></div>

  369. <div class="ttc" id="classScopeUnlocker_html"><div class="ttname"><a href="classScopeUnlocker.html">ScopeUnlocker</a></div><div class="ttdef"><b>Definition:</b> Mutex.hpp:237</div></div>

  370. </div><!-- fragment --></div><!-- contents -->

  371. <!-- start footer part -->

  372. <hr class="footer"/><address class="footer"><small>

  373. Generated on Wed Jun 17 2015 11:36:22 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  374. <img class="footer" src="doxygen.png" alt="doxygen"/>

  375. </a> 1.8.9.1

  376. </small></address>

  377. </body>

  378. </html>