Google Git
Sign in
apache / mesos-site / d0a5bf614f489fd253d80c53b90644efb359647c / . / publish / api / latest / c++ / synchronized_8hpp_source.html
blob: 281197cef8890ab8e1151281e44b735c1c81a6b1 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Apache Mesos: 3rdparty/stout/include/stout/synchronized.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="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 style="padding-left: 0.5em;">
<div id="projectname">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_aa547de1d719d14adccfca1dfb1735b3.html">stout</a></li><li class="navelem"><a class="el" href="dir_1a1b923d951dd999d43396870333fc33.html">include</a></li><li class="navelem"><a class="el" href="dir_dbd52553d038069c1ed93e3477ea333d.html">stout</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">synchronized.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="synchronized_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef __STOUT_SYNCHRONIZED_HPP__</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __STOUT_SYNCHRONIZED_HPP__</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;condition_variable&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;glog/logging.h&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="preprocessor_8hpp.html">stout/preprocessor.hpp</a>&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// An RAII class for the &#39;synchronized(m)&#39; macro.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classSynchronized.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classSynchronized.html">Synchronized</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classSynchronized.html#a6f1fcefdbc244929d3a3efce643d1a42"> 30</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classSynchronized.html#a6f1fcefdbc244929d3a3efce643d1a42">Synchronized</a>(T* t, <span class="keywordtype">void</span> (*acquire)(T*), <span class="keywordtype">void</span> (*<a class="code" href="namespaceos.html#a079aa1b108c567735620a14ea2a2e506">release</a>)(T*))</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; : t_(CHECK_NOTNULL(t)), release_(<a class="code" href="namespaceos.html#a079aa1b108c567735620a14ea2a2e506">release</a>)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; acquire(t_);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classSynchronized.html#aecbfeefc61737bdcc3f0c010cdb62c07"> 36</a></span>&#160; <a class="code" href="classSynchronized.html#aecbfeefc61737bdcc3f0c010cdb62c07">~Synchronized</a>() { release_(t_); }</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// NOTE: &#39;false&#39; being returned here has no significance.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// Refer to the NOTE for &#39;synchronized&#39; at the bottom for why.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classSynchronized.html#a0c23c62109e1d563cb090b58f0d222ff"> 40</a></span>&#160; <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; T* t_;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; void (*release_)(T*);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;};</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment">// The generic version handles mutexes which have &#39;lock&#39; and &#39;unlock&#39;</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">// member functions such as &#39;std::mutex&#39; and &#39;std::recursive_mutex&#39;.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#ab47019f16d58f080f2b323b5b586e55d"> 52</a></span>&#160;<a class="code" href="classSynchronized.html">Synchronized&lt;T&gt;</a> <a class="code" href="synchronized_8hpp.html#ab47019f16d58f080f2b323b5b586e55d">synchronize</a>(T* t)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;{</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classSynchronized.html">Synchronized&lt;T&gt;</a>(</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; t,</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; [](T* t) { t-&gt;lock(); },</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; [](T* t) { t-&gt;unlock(); }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; );</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;}</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment">// An overload of the &#39;synchronize&#39; function for &#39;std::atomic_flag&#39;.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#a4811b9eee17fd0e658196b48663462b8"> 63</a></span>&#160;<span class="keyword">inline</span> <a class="code" href="classSynchronized.html">Synchronized&lt;std::atomic_flag&gt;</a> <a class="code" href="synchronized_8hpp.html#ab47019f16d58f080f2b323b5b586e55d">synchronize</a>(std::atomic_flag* lock)</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;{</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classSynchronized.html">Synchronized&lt;std::atomic_flag&gt;</a>(</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; lock,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; [](std::atomic_flag* lock) {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">while</span> (lock-&gt;test_and_set(std::memory_order_acquire)) {}</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; },</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; [](std::atomic_flag* lock) {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; lock-&gt;clear(std::memory_order_release);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; }</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; );</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#a4ec79edd13ce87b72eae3ba83b34ad14"> 78</a></span>&#160;T* <a class="code" href="synchronized_8hpp.html#a4ec79edd13ce87b72eae3ba83b34ad14">synchronized_get_pointer</a>(T** t)</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;{</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> *CHECK_NOTNULL(t);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#a7b170182b10e3e723c5411e390766518"> 85</a></span>&#160;T* <a class="code" href="synchronized_8hpp.html#a4ec79edd13ce87b72eae3ba83b34ad14">synchronized_get_pointer</a>(T* t)</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;{</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">return</span> t;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;}</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment">// Macros to help generate &quot;unique&quot; identifiers for the</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment">// synchronization variable name and label. The line number gets</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment">// embedded which makes it unique enough, but not absolutely unique.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment">// It shouldn&#39;t be a problem however, since it&#39;s very unlikely that</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment">// anyone would place multiple &#39;synchronized&#39; blocks on one line.</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#ab321ce868d1f56a473a4bc3fac9a45da"> 96</a></span>&#160;<span class="preprocessor">#define SYNCHRONIZED_PREFIX CAT(__synchronizer_, __LINE__)</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#a7c5f22c44193503d21cedd6e433aa697"> 97</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define SYNCHRONIZED_VAR CAT(SYNCHRONIZED_PREFIX, _var__)</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#af611e06d6b072b3b4eb0dae282676143"> 98</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define SYNCHRONIZED_LABEL CAT(SYNCHRONIZED_PREFIX, _label__)</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment">// A macro for acquiring a scoped &#39;guard&#39; on any type that can satisfy</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment">// the &#39;Synchronized&#39; interface. We support &#39;std::mutex&#39;,</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment">// &#39;std::recursive_mutex&#39; and &#39;std::atomic_flag&#39; by default.</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment">// Example usage:</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment">// std::mutex m;</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment">// synchronized (m) {</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment">// // Do something under the lock.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment">// }</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment">// You can easily extend support for your synchronization primitive</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment">// here, by overloading the &#39;synchronize&#39; function.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment">// Example overload:</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment">// inline Synchronized&lt;bufferevent&gt; synchronize(bufferevent* bev)</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment">// {</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment">// return Synchronized&lt;bufferevent&gt;(</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment">// bev,</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment">// [](bufferevent* bev) { bufferevent_lock(bev); },</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment">// [](bufferevent* bev) { bufferevent_unlock(bev); },</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment">// );</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment">// }</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="comment">// How it works: An instance of the synchronization primitive is</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment">// constructed inside the &#39;condition&#39; of if statement. This variable</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="comment">// stays alive for the lifetime of the block. The trick with &#39;goto&#39;,</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment">// &#39;else&#39; and the label allows the compiler to figure out that the</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment">// synchronized block will always execute. This allows us to return</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment">// within the synchronized block and avoid the</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="comment">// &#39;control reaches the end of a non-void function&#39; warning.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment">// Note that the variable declared inside the &#39;condition&#39; of an if</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment">// statement is guaranteed to live through the &#39;else&#39; clause as well.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment">// From Section 6.4.3:</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="comment">// A name introduced by a declaration in a condition (either</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment">// introduced by the decl-specifier-seq or the declarator of the</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="comment">// condition) is in scope from its point of declaration until the</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="comment">// end of the substatements controlled by the condition.</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#a3038464a289ad3d8957a761b1795b37b"> 139</a></span>&#160;<span class="preprocessor">#define synchronized(m) \</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="preprocessor"> if (Synchronized&lt;typename std::remove_pointer&lt;decltype(m)&gt;::type&gt; \</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor"> SYNCHRONIZED_VAR = ::synchronize(::synchronized_get_pointer(&amp;m))) { \</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="preprocessor"> goto SYNCHRONIZED_LABEL; \</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="preprocessor"> } else SYNCHRONIZED_LABEL:</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> CV, <span class="keyword">typename</span> Lock&gt;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="keywordtype">void</span> <a class="code" href="synchronized_8hpp.html#a9d854e5436a64744a231418cde397b05">synchronized_wait</a>(CV* cv, Lock* lock);</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;<span class="keyword">template</span> &lt;&gt;</div>
<div class="line"><a name="l00189"></a><span class="lineno"><a class="line" href="synchronized_8hpp.html#aad5d742a7c6da3c4583b0bbda035e091"> 189</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="synchronized_8hpp.html#a9d854e5436a64744a231418cde397b05">synchronized_wait</a>(std::condition_variable* cv, std::mutex* mutex)</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;{</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; CHECK_NOTNULL(cv);</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; CHECK_NOTNULL(mutex);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="comment">// Since the pre-condition is that &#39;mutex&#39; is already owned by the</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; <span class="comment">// calling thread, we use &#39;std::adopt_lock&#39; to adopt the mutex</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="comment">// rather than trying to lock it ourselves.</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; std::unique_lock&lt;std::mutex&gt; lock(*mutex, std::adopt_lock);</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="comment">// On entrance, &#39;std::condition_variable::wait&#39; releases &#39;mutex&#39;.</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; <span class="comment">// On exit, &#39;std::condition_variable::wait&#39; re-acquires &#39;mutex&#39;.</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; cv-&gt;wait(lock);</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <span class="comment">// At this point, the &#39;mutex&#39; has been acquired. Since the</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; <span class="comment">// post-condition is that &#39;mutex&#39; is still owned by the calling</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <span class="comment">// thread, we use &#39;release&#39; in order to prevent &#39;std::unique_lock&#39;</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; <span class="comment">// from unlocking the &#39;mutex&#39;.</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; lock.release();</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;}</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Lock&gt;</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;<span class="keywordtype">void</span> <a class="code" href="synchronized_8hpp.html#a9d854e5436a64744a231418cde397b05">synchronized_wait</a>(std::condition_variable_any* cv, Lock* lock) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;<span class="preprocessor">#endif // __STOUT_SYNCHRONIZED_HPP__</span></div>
<div class="ttc" id="synchronized_8hpp_html_ab47019f16d58f080f2b323b5b586e55d"><div class="ttname"><a href="synchronized_8hpp.html#ab47019f16d58f080f2b323b5b586e55d">synchronize</a></div><div class="ttdeci">Synchronized&lt; T &gt; synchronize(T *t)</div><div class="ttdef"><b>Definition:</b> synchronized.hpp:52</div></div>
<div class="ttc" id="classSynchronized_html_a6f1fcefdbc244929d3a3efce643d1a42"><div class="ttname"><a href="classSynchronized.html#a6f1fcefdbc244929d3a3efce643d1a42">Synchronized::Synchronized</a></div><div class="ttdeci">Synchronized(T *t, void(*acquire)(T *), void(*release)(T *))</div><div class="ttdef"><b>Definition:</b> synchronized.hpp:30</div></div>
<div class="ttc" id="classSynchronized_html"><div class="ttname"><a href="classSynchronized.html">Synchronized</a></div><div class="ttdef"><b>Definition:</b> synchronized.hpp:27</div></div>
<div class="ttc" id="synchronized_8hpp_html_a9d854e5436a64744a231418cde397b05"><div class="ttname"><a href="synchronized_8hpp.html#a9d854e5436a64744a231418cde397b05">synchronized_wait</a></div><div class="ttdeci">void synchronized_wait(CV *cv, Lock *lock)</div><div class="ttdoc">Waits on the condition variable associated with &amp;#39;lock&amp;#39; which has already been synchronized. </div></div>
<div class="ttc" id="classSynchronized_html_aecbfeefc61737bdcc3f0c010cdb62c07"><div class="ttname"><a href="classSynchronized.html#aecbfeefc61737bdcc3f0c010cdb62c07">Synchronized::~Synchronized</a></div><div class="ttdeci">~Synchronized()</div><div class="ttdef"><b>Definition:</b> synchronized.hpp:36</div></div>
<div class="ttc" id="namespaceos_html_a079aa1b108c567735620a14ea2a2e506"><div class="ttname"><a href="namespaceos.html#a079aa1b108c567735620a14ea2a2e506">os::release</a></div><div class="ttdeci">Try&lt; Version &gt; release()</div><div class="ttdef"><b>Definition:</b> os.hpp:380</div></div>
<div class="ttc" id="synchronized_8hpp_html_a4ec79edd13ce87b72eae3ba83b34ad14"><div class="ttname"><a href="synchronized_8hpp.html#a4ec79edd13ce87b72eae3ba83b34ad14">synchronized_get_pointer</a></div><div class="ttdeci">T * synchronized_get_pointer(T **t)</div><div class="ttdef"><b>Definition:</b> synchronized.hpp:78</div></div>
<div class="ttc" id="preprocessor_8hpp_html"><div class="ttname"><a href="preprocessor_8hpp.html">preprocessor.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>