| <!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/libprocess/src/gate.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 Page</span></a></li> |
| <li><a href="pages.html"><span>Related 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 List</span></a></li> |
| <li><a href="globals.html"><span>File 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_043a76de98701f9bddf61b5e98f305ff.html">libprocess</a></li><li class="navelem"><a class="el" href="dir_01cbbd8dcbf9de3825992568658f467e.html">src</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">gate.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="gate_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> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment">// limitations under the License</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __GATE_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __GATE_HPP__</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <condition_variable></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <mutex></span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="synchronized_8hpp.html">stout/synchronized.hpp</a>></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> |
| <div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classGate.html"> 21</a></span> <span class="keyword">class </span><a class="code" href="classGate.html">Gate</a></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classGate.html#ae8751315ab0d2e1b9f4e2d27a85ef4d3"> 24</a></span>  <span class="keyword">typedef</span> intptr_t <a class="code" href="classGate.html#ae8751315ab0d2e1b9f4e2d27a85ef4d3">state_t</a>;</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">int</span> waiters;</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="classGate.html#ae8751315ab0d2e1b9f4e2d27a85ef4d3">state_t</a> state;</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  std::mutex mutex;</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  std::condition_variable cond;</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classGate.html#a4fc24ecebc0ca8252bf7ab96a705e58a"> 33</a></span>  <a class="code" href="classGate.html#a4fc24ecebc0ca8252bf7ab96a705e58a">Gate</a>() : waiters(0), state(0) {}</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>  <a class="code" href="classGate.html#a3c54ba5a6b3b356886e873cc4ab132f0">~Gate</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Signals the state change of the gate to any (at least one) or</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// all (if 'all' is true) of the threads waiting on it.</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classGate.html#ae62ae49bc12b6f3d0268f9c424a053a9"> 39</a></span>  <span class="keywordtype">void</span> <a class="code" href="classGate.html#ae62ae49bc12b6f3d0268f9c424a053a9">open</a>(<span class="keywordtype">bool</span> all = <span class="keyword">true</span>)</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">synchronized</span> (mutex) {</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  state++;</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span> (all) {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  cond.notify_all();</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>  cond.notify_one();</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</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> </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// Blocks the current thread until the gate's state changes from</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// the current state.</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classGate.html#a9f100fda6d08dad6be9cead83317431c"> 53</a></span>  <span class="keywordtype">void</span> <a class="code" href="classGate.html#a9f100fda6d08dad6be9cead83317431c">wait</a>()</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>  <span class="keyword">synchronized</span> (mutex) {</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  waiters++;</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classGate.html#ae8751315ab0d2e1b9f4e2d27a85ef4d3">state_t</a> old = state;</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">while</span> (old == state) {</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="synchronized_8hpp.html#a9d854e5436a64744a231418cde397b05">synchronized_wait</a>(&cond, &mutex);</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  waiters--;</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</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">// Gets the current state of the gate and notifies the gate about</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// the intention to wait for its state change.</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// Call 'leave()' if no longer interested in the state change.</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classGate.html#ae811ed55cecd966053c05cf013ca3944"> 68</a></span>  <a class="code" href="classGate.html#ae8751315ab0d2e1b9f4e2d27a85ef4d3">state_t</a> <a class="code" href="classGate.html#ae811ed55cecd966053c05cf013ca3944">approach</a>()</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">synchronized</span> (mutex) {</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  waiters++;</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> state;</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Blocks the current thread until the gate's state changes from</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// the specified 'old' state. The 'old' state can be obtained by</span></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// calling 'approach()'. Returns the number of remaining waiters.</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classGate.html#a44685e5f462ed1d4769b495c101c8aef"> 79</a></span>  <span class="keywordtype">int</span> <a class="code" href="classGate.html#a44685e5f462ed1d4769b495c101c8aef">arrive</a>(<a class="code" href="classGate.html#ae8751315ab0d2e1b9f4e2d27a85ef4d3">state_t</a> old)</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  {</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">int</span> remaining;</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">synchronized</span> (mutex) {</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">while</span> (old == state) {</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="synchronized_8hpp.html#a9d854e5436a64744a231418cde397b05">synchronized_wait</a>(&cond, &mutex);</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>  waiters--;</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  remaining = waiters;</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> remaining;</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// Notifies the gate that a waiter (the current thread) is no</span></div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">// longer waiting for the gate's state change.</span></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classGate.html#ade174d090850666e22c4c3483bef2701"> 97</a></span>  <span class="keywordtype">void</span> <a class="code" href="classGate.html#ade174d090850666e22c4c3483bef2701">leave</a>()</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  {</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">synchronized</span> (mutex) {</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  waiters--;</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  }</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</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> </div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif // __GATE_HPP__</span></div> |
| <div class="ttc" id="synchronized_8hpp_html"><div class="ttname"><a href="synchronized_8hpp.html">synchronized.hpp</a></div></div> |
| <div class="ttc" id="classGate_html_ade174d090850666e22c4c3483bef2701"><div class="ttname"><a href="classGate.html#ade174d090850666e22c4c3483bef2701">Gate::leave</a></div><div class="ttdeci">void leave()</div><div class="ttdef"><b>Definition:</b> gate.hpp:97</div></div> |
| <div class="ttc" id="classGate_html_a3c54ba5a6b3b356886e873cc4ab132f0"><div class="ttname"><a href="classGate.html#a3c54ba5a6b3b356886e873cc4ab132f0">Gate::~Gate</a></div><div class="ttdeci">~Gate()=default</div></div> |
| <div class="ttc" id="classGate_html_ae8751315ab0d2e1b9f4e2d27a85ef4d3"><div class="ttname"><a href="classGate.html#ae8751315ab0d2e1b9f4e2d27a85ef4d3">Gate::state_t</a></div><div class="ttdeci">intptr_t state_t</div><div class="ttdef"><b>Definition:</b> gate.hpp:24</div></div> |
| <div class="ttc" id="classGate_html"><div class="ttname"><a href="classGate.html">Gate</a></div><div class="ttdef"><b>Definition:</b> gate.hpp:21</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 &#39;lock&#39; which has already been synchronized. </div></div> |
| <div class="ttc" id="classGate_html_a9f100fda6d08dad6be9cead83317431c"><div class="ttname"><a href="classGate.html#a9f100fda6d08dad6be9cead83317431c">Gate::wait</a></div><div class="ttdeci">void wait()</div><div class="ttdef"><b>Definition:</b> gate.hpp:53</div></div> |
| <div class="ttc" id="classGate_html_ae62ae49bc12b6f3d0268f9c424a053a9"><div class="ttname"><a href="classGate.html#ae62ae49bc12b6f3d0268f9c424a053a9">Gate::open</a></div><div class="ttdeci">void open(bool all=true)</div><div class="ttdef"><b>Definition:</b> gate.hpp:39</div></div> |
| <div class="ttc" id="classGate_html_a44685e5f462ed1d4769b495c101c8aef"><div class="ttname"><a href="classGate.html#a44685e5f462ed1d4769b495c101c8aef">Gate::arrive</a></div><div class="ttdeci">int arrive(state_t old)</div><div class="ttdef"><b>Definition:</b> gate.hpp:79</div></div> |
| <div class="ttc" id="classGate_html_ae811ed55cecd966053c05cf013ca3944"><div class="ttname"><a href="classGate.html#ae811ed55cecd966053c05cf013ca3944">Gate::approach</a></div><div class="ttdeci">state_t approach()</div><div class="ttdef"><b>Definition:</b> gate.hpp:68</div></div> |
| <div class="ttc" id="classGate_html_a4fc24ecebc0ca8252bf7ab96a705e58a"><div class="ttname"><a href="classGate.html#a4fc24ecebc0ca8252bf7ab96a705e58a">Gate::Gate</a></div><div class="ttdeci">Gate()</div><div class="ttdef"><b>Definition:</b> gate.hpp:33</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
