blob: 1f754c78bd2ddf361aa618e1d90e3438d51ab56e [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: include/mesos/v1/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&#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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_a00cdca4cac44d29e96ac7c7cae2bc86.html">mesos</a></li><li class="navelem"><a class="el" href="dir_6d69388fc21a704f6b1f466469252a76.html">v1</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="include_2mesos_2v1_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>&#160;<span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</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="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef __MESOS_V1_EXECUTOR_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __MESOS_V1_EXECUTOR_HPP__</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;queue&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2http_8hpp.html">mesos/http.hpp</a>&gt;</span></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"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2v1_2mesos_8hpp.html">mesos/v1/mesos.hpp</a>&gt;</span></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;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2v1_2executor_2executor_8hpp.html">mesos/v1/executor/executor.hpp</a>&gt;</span></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;<span class="preprocessor">#include &lt;<a class="code" href="owned_8hpp.html">process/owned.hpp</a>&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span>v1 {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">namespace </span>executor {</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"> 36</span>&#160;<span class="keyword">class </span>MesosProcess; <span class="comment">// Forward declaration.</span></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"><a class="line" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html"> 38</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html">MesosBase</a></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;{</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// Empty virtual destructor (necessary to instantiate subclasses).</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#ae29a0e0423556d7ea07d36e4d3abf185"> 42</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#ae29a0e0423556d7ea07d36e4d3abf185">~MesosBase</a>() {}</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#a21bd78cd127c8a8565b6432318a55dd3">send</a>(<span class="keyword">const</span> <a class="code" href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#acb18ceaa5f6f2338f2a9727af398eb79">Call</a>&amp; call) = 0;</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;</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;<span class="comment">// Interface to Mesos for an executor.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment">// Expects three callbacks, &#39;connected&#39;, &#39;disconnected&#39;, and</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">// &#39;received&#39; which will get invoked _serially_ when it&#39;s determined</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment">// that we&#39;ve connected (i.e. established TCP connection), disconnected</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment">// (i.e, connection is broken), or received events from the agent.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment">// Note that we drop events while disconnected.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1executor_1_1Mesos.html"> 54</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html">Mesos</a> : <span class="keyword">public</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html">MesosBase</a></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;{</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html#af16febb5b3604b85f5aa77407c2c4b28">Mesos</a>(<a class="code" href="namespacemesos.html#a13035ce0cc66cca4a467787b4716039e">ContentType</a> contentType,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">const</span> std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)&gt;&amp; connected,</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">const</span> std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)&gt;&amp; disconnected,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">const</span> std::function&lt;<span class="keywordtype">void</span>(<span class="keyword">const</span> std::queue&lt;Event&gt;&amp;)&gt;&amp; received);</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">// Delete copy constructor.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html#af16febb5b3604b85f5aa77407c2c4b28">Mesos</a>(<span class="keyword">const</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html">Mesos</a>&amp; other) = <span class="keyword">delete</span>;</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="comment">// Delete assignment operator.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html">Mesos</a>&amp; <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html#a9a969afb03ff3c7f74677276085f40fc">operator=</a>(<span class="keyword">const</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html">Mesos</a>&amp; other) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html#a7e853376595b1ddf400249b1cd251154">~Mesos</a>();</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; <span class="comment">// Attempts to send a call to the agent.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">// Some local validation of calls is performed which may result in dropped</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="comment">// events without ever being sent to the agent.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html#acaf40a5d2dfdd5318515400d4bddd0bc">send</a>(<span class="keyword">const</span> <a class="code" href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#acb18ceaa5f6f2338f2a9727af398eb79">Call</a>&amp; call) <span class="keyword">override</span>;</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;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="classprocess_1_1Owned.html">process::Owned&lt;MesosProcess&gt;</a> process;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;};</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="comment">// namespace executor {</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;} <span class="comment">// namespace v1 {</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;} <span class="comment">// namespace mesos {</span></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="preprocessor">#endif // __MESOS_V1_EXECUTOR_HPP__</span></div>
<div class="ttc" id="include_2mesos_2http_8hpp_html"><div class="ttname"><a href="include_2mesos_2http_8hpp.html">http.hpp</a></div></div>
<div class="ttc" id="namespacemesos_html_a13035ce0cc66cca4a467787b4716039e"><div class="ttname"><a href="namespacemesos.html#a13035ce0cc66cca4a467787b4716039e">mesos::ContentType</a></div><div class="ttdeci">ContentType</div><div class="ttdef"><b>Definition:</b> http.hpp:43</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1MesosBase_html_a21bd78cd127c8a8565b6432318a55dd3"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#a21bd78cd127c8a8565b6432318a55dd3">mesos::v1::executor::MesosBase::send</a></div><div class="ttdeci">virtual void send(const Call &amp;call)=0</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler_html_acb18ceaa5f6f2338f2a9727af398eb79"><div class="ttname"><a href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#acb18ceaa5f6f2338f2a9727af398eb79">mesos::internal::tests::v1::scheduler::Call</a></div><div class="ttdeci">mesos::v1::scheduler::Call Call</div><div class="ttdef"><b>Definition:</b> mesos.hpp:1864</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1MesosBase_html_ae29a0e0423556d7ea07d36e4d3abf185"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#ae29a0e0423556d7ea07d36e4d3abf185">mesos::v1::executor::MesosBase::~MesosBase</a></div><div class="ttdeci">virtual ~MesosBase()</div><div class="ttdef"><b>Definition:</b> executor.hpp:42</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1Mesos_html_a9a969afb03ff3c7f74677276085f40fc"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1Mesos.html#a9a969afb03ff3c7f74677276085f40fc">mesos::v1::executor::Mesos::operator=</a></div><div class="ttdeci">Mesos &amp; operator=(const Mesos &amp;other)=delete</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1Mesos_html_af16febb5b3604b85f5aa77407c2c4b28"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1Mesos.html#af16febb5b3604b85f5aa77407c2c4b28">mesos::v1::executor::Mesos::Mesos</a></div><div class="ttdeci">Mesos(ContentType contentType, const std::function&lt; void(void)&gt; &amp;connected, const std::function&lt; void(void)&gt; &amp;disconnected, const std::function&lt; void(const std::queue&lt; Event &gt; &amp;)&gt; &amp;received)</div></div>
<div class="ttc" id="include_2mesos_2v1_2executor_2executor_8hpp_html"><div class="ttname"><a href="include_2mesos_2v1_2executor_2executor_8hpp.html">executor.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1Mesos_html"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1Mesos.html">mesos::v1::executor::Mesos</a></div><div class="ttdef"><b>Definition:</b> executor.hpp:54</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1Mesos_html_a7e853376595b1ddf400249b1cd251154"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1Mesos.html#a7e853376595b1ddf400249b1cd251154">mesos::v1::executor::Mesos::~Mesos</a></div><div class="ttdeci">virtual ~Mesos()</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1Mesos_html_acaf40a5d2dfdd5318515400d4bddd0bc"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1Mesos.html#acaf40a5d2dfdd5318515400d4bddd0bc">mesos::v1::executor::Mesos::send</a></div><div class="ttdeci">virtual void send(const Call &amp;call) override</div></div>
<div class="ttc" id="classmesos_1_1v1_1_1executor_1_1MesosBase_html"><div class="ttname"><a href="classmesos_1_1v1_1_1executor_1_1MesosBase.html">mesos::v1::executor::MesosBase</a></div><div class="ttdef"><b>Definition:</b> executor.hpp:38</div></div>
<div class="ttc" id="owned_8hpp_html"><div class="ttname"><a href="owned_8hpp.html">owned.hpp</a></div></div>
<div class="ttc" id="include_2mesos_2v1_2mesos_8hpp_html"><div class="ttname"><a href="include_2mesos_2v1_2mesos_8hpp.html">mesos.hpp</a></div></div>
<div class="ttc" id="classprocess_1_1Owned_html"><div class="ttname"><a href="classprocess_1_1Owned.html">process::Owned&lt; MesosProcess &gt;</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>