blob: 7deece804ead8045f66b311a0792a6b5b26aae07 [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/libprocess/src/process_reference.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_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">process_reference.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="process__reference_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 __PROCESS_REFERENCE_HPP__</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __PROCESS_REFERENCE_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;<a class="code" href="libprocess_2include_2process_2process_8hpp.html">process/process.hpp</a>&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment">// Provides reference counting semantics for a process pointer.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classprocess_1_1ProcessReference.html"> 21</a></span>&#160;<span class="keyword">class </span><a class="code" href="classprocess_1_1ProcessReference.html">ProcessReference</a></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="keyword">public</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classprocess_1_1ProcessReference.html#a17fba74dbc68ffb7aca4b0b4d04531ff"> 24</a></span>&#160; <a class="code" href="classprocess_1_1ProcessReference.html#a17fba74dbc68ffb7aca4b0b4d04531ff">ProcessReference</a>() : process(nullptr) {}</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classprocess_1_1ProcessReference.html#a98984b83dcbe3ff6d4b9abf3c5d3a5ad"> 26</a></span>&#160; <a class="code" href="classprocess_1_1ProcessReference.html#a98984b83dcbe3ff6d4b9abf3c5d3a5ad">~ProcessReference</a>()</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; cleanup();</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; }</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classprocess_1_1ProcessReference.html#a9643b9ab539969b547510cdc5fdd688a"> 31</a></span>&#160; <a class="code" href="classprocess_1_1ProcessReference.html#a9643b9ab539969b547510cdc5fdd688a">ProcessReference</a>(<span class="keyword">const</span> <a class="code" href="classprocess_1_1ProcessReference.html">ProcessReference</a>&amp; that)</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; copy(that);</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="classprocess_1_1ProcessReference.html#a5319dfdfca31ef4b93837cbb6928c391"> 36</a></span>&#160; <a class="code" href="classprocess_1_1ProcessReference.html">ProcessReference</a>&amp; <a class="code" href="classprocess_1_1ProcessReference.html#a5319dfdfca31ef4b93837cbb6928c391">operator=</a>(<span class="keyword">const</span> <a class="code" href="classprocess_1_1ProcessReference.html">ProcessReference</a>&amp; that)</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="keywordflow">if</span> (<span class="keyword">this</span> != &amp;that) {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; cleanup();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; copy(that);</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="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</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"><a class="line" href="classprocess_1_1ProcessReference.html#afe6b9c2c47f6fae01f9217e9835537ae"> 45</a></span>&#160; <a class="code" href="classprocess_1_1ProcessBase.html">ProcessBase</a>* <a class="code" href="classprocess_1_1ProcessReference.html#afe6b9c2c47f6fae01f9217e9835537ae">operator-&gt;</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> process;</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;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classprocess_1_1ProcessReference.html#a481b9c25e0209530c60ab5ebdadb075f"> 50</a></span>&#160; <span class="keyword">operator</span> <a class="code" href="classprocess_1_1ProcessBase.html">ProcessBase</a>*() <span class="keyword">const</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> process;</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;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classprocess_1_1ProcessReference.html#a6f4785c71a30651f6ad2092ec07a40a8"> 55</a></span>&#160; <span class="keyword">operator</span> bool()<span class="keyword"> const</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">return</span> process != <span class="keyword">nullptr</span>;</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;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classprocess_1_1ProcessReference.html#ae1701c7594fe2cf1c96b951a52eb0396"> 61</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classprocess_1_1ProcessReference.html#ae1701c7594fe2cf1c96b951a52eb0396">ProcessManager</a>; <span class="comment">// For ProcessManager::use.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classprocess_1_1ProcessReference.html#a17fba74dbc68ffb7aca4b0b4d04531ff">ProcessReference</a>(<a class="code" href="classprocess_1_1ProcessBase.html">ProcessBase</a>* _process)</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; : <a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>(_process)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> != <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>-&gt;refs.fetch_add(1);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; }</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;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">void</span> <a class="code" href="namespaceutils.html#ac8be4e5e1fedfabe178ca20b6a37349c">copy</a>(<span class="keyword">const</span> <a class="code" href="classprocess_1_1ProcessReference.html#a17fba74dbc68ffb7aca4b0b4d04531ff">ProcessReference</a>&amp; that)</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; <a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> = that.process;</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; <span class="keywordflow">if</span> (<a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> != <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">// There should be at least one reference to the process, so</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// we don&#39;t need to worry about checking if it&#39;s exiting or</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// not, since we know we can always create another reference.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; CHECK(<a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>-&gt;refs.load() &gt; 0);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>-&gt;refs.fetch_add(1);</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="keywordtype">void</span> <a class="code" href="namespacecgroups.html#a12d210f286e5fcf7993c0c90b9459606">cleanup</a>()</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; {</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> != <span class="keyword">nullptr</span>) {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>-&gt;refs.fetch_sub(1);</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; ProcessBase* <a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;};</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;} <span class="comment">// namespace process {</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="preprocessor">#endif // __PROCESS_REFERENCE_HPP__</span></div>
<div class="ttc" id="classprocess_1_1ProcessReference_html_afe6b9c2c47f6fae01f9217e9835537ae"><div class="ttname"><a href="classprocess_1_1ProcessReference.html#afe6b9c2c47f6fae01f9217e9835537ae">process::ProcessReference::operator-&gt;</a></div><div class="ttdeci">ProcessBase * operator-&gt;() const </div><div class="ttdef"><b>Definition:</b> process_reference.hpp:45</div></div>
<div class="ttc" id="namespacecgroups_html_a12d210f286e5fcf7993c0c90b9459606"><div class="ttname"><a href="namespacecgroups.html#a12d210f286e5fcf7993c0c90b9459606">cgroups::cleanup</a></div><div class="ttdeci">process::Future&lt; bool &gt; cleanup(const std::string &amp;hierarchy)</div></div>
<div class="ttc" id="classprocess_1_1ProcessReference_html_ae1701c7594fe2cf1c96b951a52eb0396"><div class="ttname"><a href="classprocess_1_1ProcessReference.html#ae1701c7594fe2cf1c96b951a52eb0396">process::ProcessReference::ProcessManager</a></div><div class="ttdeci">friend class ProcessManager</div><div class="ttdef"><b>Definition:</b> process_reference.hpp:61</div></div>
<div class="ttc" id="classprocess_1_1ProcessBase_html"><div class="ttname"><a href="classprocess_1_1ProcessBase.html">process::ProcessBase</a></div><div class="ttdef"><b>Definition:</b> process.hpp:68</div></div>
<div class="ttc" id="classprocess_1_1ProcessReference_html_a98984b83dcbe3ff6d4b9abf3c5d3a5ad"><div class="ttname"><a href="classprocess_1_1ProcessReference.html#a98984b83dcbe3ff6d4b9abf3c5d3a5ad">process::ProcessReference::~ProcessReference</a></div><div class="ttdeci">~ProcessReference()</div><div class="ttdef"><b>Definition:</b> process_reference.hpp:26</div></div>
<div class="ttc" id="classprocess_1_1ProcessReference_html"><div class="ttname"><a href="classprocess_1_1ProcessReference.html">process::ProcessReference</a></div><div class="ttdef"><b>Definition:</b> process_reference.hpp:21</div></div>
<div class="ttc" id="classprocess_1_1ProcessReference_html_a5319dfdfca31ef4b93837cbb6928c391"><div class="ttname"><a href="classprocess_1_1ProcessReference.html#a5319dfdfca31ef4b93837cbb6928c391">process::ProcessReference::operator=</a></div><div class="ttdeci">ProcessReference &amp; operator=(const ProcessReference &amp;that)</div><div class="ttdef"><b>Definition:</b> process_reference.hpp:36</div></div>
<div class="ttc" id="namespaceos_html_ae19e4161a51b86a1f330f3bf1dc75389"><div class="ttname"><a href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">os::process</a></div><div class="ttdeci">Result&lt; Process &gt; process(pid_t pid)</div><div class="ttdef"><b>Definition:</b> freebsd.hpp:30</div></div>
<div class="ttc" id="classprocess_1_1ProcessReference_html_a17fba74dbc68ffb7aca4b0b4d04531ff"><div class="ttname"><a href="classprocess_1_1ProcessReference.html#a17fba74dbc68ffb7aca4b0b4d04531ff">process::ProcessReference::ProcessReference</a></div><div class="ttdeci">ProcessReference()</div><div class="ttdef"><b>Definition:</b> process_reference.hpp:24</div></div>
<div class="ttc" id="classprocess_1_1ProcessReference_html_a9643b9ab539969b547510cdc5fdd688a"><div class="ttname"><a href="classprocess_1_1ProcessReference.html#a9643b9ab539969b547510cdc5fdd688a">process::ProcessReference::ProcessReference</a></div><div class="ttdeci">ProcessReference(const ProcessReference &amp;that)</div><div class="ttdef"><b>Definition:</b> process_reference.hpp:31</div></div>
<div class="ttc" id="namespaceutils_html_ac8be4e5e1fedfabe178ca20b6a37349c"><div class="ttname"><a href="namespaceutils.html#ac8be4e5e1fedfabe178ca20b6a37349c">utils::copy</a></div><div class="ttdeci">T copy(const T &amp;t)</div><div class="ttdef"><b>Definition:</b> utils.hpp:21</div></div>
<div class="ttc" id="libprocess_2include_2process_2process_8hpp_html"><div class="ttname"><a href="libprocess_2include_2process_2process_8hpp.html">process.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>