| <!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/include/process/executor.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_eac18f7a64f6f8afbd1493ef4e09abdb.html">include</a></li><li class="navelem"><a class="el" href="dir_1894286df79cf582d947dbc4268b06cf.html">process</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">executor.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="3rdparty_2libprocess_2include_2process_2executor_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 __PROCESS_EXECUTOR_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __PROCESS_EXECUTOR_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 <<a class="code" href="deferred_8hpp.html">process/deferred.hpp</a>></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="id_8hpp.html">process/id.hpp</a>></span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <<a class="code" href="libprocess_2include_2process_2process_8hpp.html">process/process.hpp</a>></span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="thread__local_8hpp.html">stout/thread_local.hpp</a>></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span><a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// Provides an abstraction that can take a standard function object</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// and defer it without needing a process. Each converted function</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// object will get execute serially with respect to one another when</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// invoked.</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classprocess_1_1Executor.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classprocess_1_1Executor.html">Executor</a></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classprocess_1_1Executor.html#a06c30cb0a50b9c129ab2eec111d75da9"> 31</a></span>  <a class="code" href="classprocess_1_1Executor.html#a06c30cb0a50b9c129ab2eec111d75da9">Executor</a>() : process(ID::<a class="code" href="namespaceprocess_1_1ID.html#aeb11a48c9def1da169d8455a30d0ee39">generate</a>(<span class="stringliteral">"__executor__"</span>))</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="namespaceprocess.html#aff22904a83567125d3b4d0d88e5a2270">spawn</a>(process);</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> </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classprocess_1_1Executor.html#a478fbabdcc0832b3e7520fbaaa390d2c"> 36</a></span>  <a class="code" href="classprocess_1_1Executor.html#a478fbabdcc0832b3e7520fbaaa390d2c">~Executor</a>()</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="namespaceprocess.html#a20443908afa3212215166e26065349e5">terminate</a>(process);</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="namespaceprocess.html#a07833fb41a8b0c1f18fa5485ca8c18d4">wait</a>(process);</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> </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classprocess_1_1Executor.html#a43a9df131ecc0e5fb3c3015c118407da"> 42</a></span>  <span class="keywordtype">void</span> <a class="code" href="classprocess_1_1Executor.html#a43a9df131ecc0e5fb3c3015c118407da">stop</a>()</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="namespaceprocess.html#a20443908afa3212215166e26065349e5">terminate</a>(&process);</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// TODO(benh): Note that this doesn't wait because that could</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// cause a deadlock ... thus, the semantics here are that no more</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// dispatches will occur after this function returns but one may</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// be occurring concurrently.</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> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> F></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classprocess_1_1Executor.html#aa129606e06f0a2cf30f5b198ad826400"> 53</a></span>  <a class="code" href="structprocess_1_1__Deferred.html">_Deferred<F></a> <a class="code" href="classprocess_1_1Executor.html#aa129606e06f0a2cf30f5b198ad826400">defer</a>(F&& <a class="code" href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">f</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="keywordflow">return</span> <a class="code" href="structprocess_1_1__Deferred.html">_Deferred<F></a>(process.<a class="code" href="classprocess_1_1ProcessBase.html#adc5a9a47e9c36edb42e03bfb6adfee65">self</a>(), std::forward<F>(<a class="code" href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">f</a>));</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// Not copyable, not assignable.</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classprocess_1_1Executor.html#a06c30cb0a50b9c129ab2eec111d75da9">Executor</a>(<span class="keyword">const</span> <a class="code" href="classprocess_1_1Executor.html">Executor</a>&);</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classprocess_1_1Executor.html">Executor</a>& operator=(<span class="keyword">const</span> <a class="code" href="classprocess_1_1Executor.html">Executor</a>&);</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>  <a class="code" href="classprocess_1_1ProcessBase.html">ProcessBase</a> process;</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// Per thread executor pointer. We use a pointer to lazily construct the</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// actual executor.</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">extern</span> <a class="code" href="thread__local_8hpp.html#af8556c37f3acfa45992b8697930c501b">THREAD_LOCAL</a> Executor* <a class="code" href="namespaceprocess.html#ac3d2dec24c6b5a7a80beefebf8113d48">_executor_</a>;</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="3rdparty_2libprocess_2include_2process_2executor_8hpp.html#a4c307fc4c2f22e9a9a1a01fe059e1979"> 72</a></span> <span class="preprocessor">#define __executor__ \</span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> (_executor_ == nullptr ? _executor_ = new Executor() : _executor_)</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> } <span class="comment">// namespace process {</span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif // __PROCESS_EXECUTOR_HPP__</span></div> |
| <div class="ttc" id="namespaceprocess_1_1ID_html_aeb11a48c9def1da169d8455a30d0ee39"><div class="ttname"><a href="namespaceprocess_1_1ID.html#aeb11a48c9def1da169d8455a30d0ee39">process::ID::generate</a></div><div class="ttdeci">std::string generate(const std::string &prefix="")</div><div class="ttdoc">Returns &#39;prefix(N)&#39; where N represents the number of instances where the same prefix (wrt...</div></div> |
| <div class="ttc" id="namespaceprocess_html_a62d5333e8ec1817c249cf83e15d568b4"><div class="ttname"><a href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">process::f</a></div><div class="ttdeci">F && f</div><div class="ttdef"><b>Definition:</b> defer.hpp:239</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:69</div></div> |
| <div class="ttc" id="namespaceprocess_html_aff22904a83567125d3b4d0d88e5a2270"><div class="ttname"><a href="namespaceprocess.html#aff22904a83567125d3b4d0d88e5a2270">process::spawn</a></div><div class="ttdeci">UPID spawn(ProcessBase *process, bool manage=false)</div><div class="ttdoc">Spawn a new process. </div></div> |
| <div class="ttc" id="namespaceprocess_html_a20443908afa3212215166e26065349e5"><div class="ttname"><a href="namespaceprocess.html#a20443908afa3212215166e26065349e5">process::terminate</a></div><div class="ttdeci">void terminate(const UPID &pid, bool inject=true)</div><div class="ttdoc">Sends a TerminateEvent to the given process. </div></div> |
| <div class="ttc" id="classprocess_1_1Executor_html_aa129606e06f0a2cf30f5b198ad826400"><div class="ttname"><a href="classprocess_1_1Executor.html#aa129606e06f0a2cf30f5b198ad826400">process::Executor::defer</a></div><div class="ttdeci">_Deferred< F > defer(F &&f)</div><div class="ttdef"><b>Definition:</b> executor.hpp:53</div></div> |
| <div class="ttc" id="thread__local_8hpp_html"><div class="ttname"><a href="thread__local_8hpp.html">thread_local.hpp</a></div></div> |
| <div class="ttc" id="structprocess_1_1__Deferred_html"><div class="ttname"><a href="structprocess_1_1__Deferred.html">process::_Deferred</a></div><div class="ttdef"><b>Definition:</b> deferred.hpp:64</div></div> |
| <div class="ttc" id="namespaceprocess_html_a07833fb41a8b0c1f18fa5485ca8c18d4"><div class="ttname"><a href="namespaceprocess.html#a07833fb41a8b0c1f18fa5485ca8c18d4">process::wait</a></div><div class="ttdeci">bool wait(const UPID &pid, const Duration &duration=Seconds(-1))</div><div class="ttdoc">Wait for the process to exit for no more than the specified seconds. </div></div> |
| <div class="ttc" id="classprocess_1_1Executor_html_a06c30cb0a50b9c129ab2eec111d75da9"><div class="ttname"><a href="classprocess_1_1Executor.html#a06c30cb0a50b9c129ab2eec111d75da9">process::Executor::Executor</a></div><div class="ttdeci">Executor()</div><div class="ttdef"><b>Definition:</b> executor.hpp:31</div></div> |
| <div class="ttc" id="classprocess_1_1Executor_html_a43a9df131ecc0e5fb3c3015c118407da"><div class="ttname"><a href="classprocess_1_1Executor.html#a43a9df131ecc0e5fb3c3015c118407da">process::Executor::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdef"><b>Definition:</b> executor.hpp:42</div></div> |
| <div class="ttc" id="namespaceprocess_html_ac3d2dec24c6b5a7a80beefebf8113d48"><div class="ttname"><a href="namespaceprocess.html#ac3d2dec24c6b5a7a80beefebf8113d48">process::_executor_</a></div><div class="ttdeci">THREAD_LOCAL Executor * _executor_</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< Process > process(pid_t pid)</div><div class="ttdef"><b>Definition:</b> freebsd.hpp:30</div></div> |
| <div class="ttc" id="thread__local_8hpp_html_af8556c37f3acfa45992b8697930c501b"><div class="ttname"><a href="thread__local_8hpp.html#af8556c37f3acfa45992b8697930c501b">THREAD_LOCAL</a></div><div class="ttdeci">#define THREAD_LOCAL</div><div class="ttdef"><b>Definition:</b> thread_local.hpp:26</div></div> |
| <div class="ttc" id="deferred_8hpp_html"><div class="ttname"><a href="deferred_8hpp.html">deferred.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1ProcessBase_html_adc5a9a47e9c36edb42e03bfb6adfee65"><div class="ttname"><a href="classprocess_1_1ProcessBase.html#adc5a9a47e9c36edb42e03bfb6adfee65">process::ProcessBase::self</a></div><div class="ttdeci">UPID self() const </div><div class="ttdef"><b>Definition:</b> process.hpp:76</div></div> |
| <div class="ttc" id="id_8hpp_html"><div class="ttname"><a href="id_8hpp.html">id.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Executor_html"><div class="ttname"><a href="classprocess_1_1Executor.html">process::Executor</a></div><div class="ttdef"><b>Definition:</b> executor.hpp:28</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 class="ttc" id="classprocess_1_1Executor_html_a478fbabdcc0832b3e7520fbaaa390d2c"><div class="ttname"><a href="classprocess_1_1Executor.html#a478fbabdcc0832b3e7520fbaaa390d2c">process::Executor::~Executor</a></div><div class="ttdeci">~Executor()</div><div class="ttdef"><b>Definition:</b> executor.hpp:36</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> |
