You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by gi...@apache.org on 2018/08/01 20:48:57 UTC
[15/29] mesos-site git commit: Updated the website built from mesos
SHA: 1b6b6f6.
http://git-wip-us.apache.org/repos/asf/mesos-site/blob/cfbae833/content/api/latest/c++/include_2mesos_2v1_2executor_8hpp_source.html
----------------------------------------------------------------------
diff --git a/content/api/latest/c++/include_2mesos_2v1_2executor_8hpp_source.html b/content/api/latest/c++/include_2mesos_2v1_2executor_8hpp_source.html
index 04fab2e..f5e3053 100644
--- a/content/api/latest/c++/include_2mesos_2v1_2executor_8hpp_source.html
+++ b/content/api/latest/c++/include_2mesos_2v1_2executor_8hpp_source.html
@@ -55,8 +55,8 @@
<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> <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> <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> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <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> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <span class="
comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <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> <span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __MESOS_V1_EXECUTOR_HPP__</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define __MESOS_V1_EXECUTOR_HPP__</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 <functional></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <queue></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <map></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="include_2mesos_2http_8hpp.html">mesos/http.hpp</a>></span></div><div class="line"><a name="l00026"></a><span class="
lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="include_2mesos_2v1_2mesos_8hpp.html">mesos/v1/mesos.hpp</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="code" href="include_2mesos_2v1_2executor_2executor_8hpp.html">mesos/v1/executor/executor.hpp</a>></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <<a class="code" href="owned_8hpp.html">process/owned.hpp</a>></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> <span class="keyword">namespace </span><a class="code" href="namespacemesos.html">mesos</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>executor {</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="keyword">class </span>MesosProcess; <span class="comment">// Forward declaration.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html"> 39</a></span> <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="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Empty virtual destructor (necessary to instantiate subclasses).</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#ae29a0e0423556d7ea07d36e4d3abf185"> 43</a></span>  <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="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#a21bd78cd127c8a8565b64323
18a55dd3">send</a>(<span class="keyword">const</span> <a class="code" href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#acb18ceaa5f6f2338f2a9727af398eb79">Call</a>& call) = 0;</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> </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> <span class="comment">// Interface to Mesos for an executor.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">//</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// Expects three callbacks, 'connected', 'disconnected', and</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span cla
ss="comment">// 'received' which will get invoked _serially_ when it's determined</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// that we've connected (i.e. established TCP connection), disconnected</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// (i.e, connection is broken), or received events from the agent.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// Note that we drop events while disconnected.</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classmesos_1_1v1_1_1executor_1_1Mesos.html"> 55</a></span> <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.htm
l">MesosBase</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> <span class="keyword">public</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// The other constructor overload that accepts `environment`</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// argument is preferable to this one in a multithreaded environment,</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// because the implementation of this one accesses global environment</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// which is unsafe due to a potential concurrent modification of the</span></div><div class="line"><a name="l00062"></a><span
class="lineno"> 62</span>  <span class="comment">// environment by another thread.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#ab87ee31e10bdc282bae31a2c973602df">Mesos</a>(<a class="code" href="namespacemesos.html#a13035ce0cc66cca4a467787b4716039e">ContentType</a> contentType,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)>& connected,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)>& disconnected,</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span
class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> std::queue<Event>&)>& received);</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>  <a class="code" href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#ab87ee31e10bdc282bae31a2c973602df">Mesos</a>(<a class="code" href="namespacemesos.html#a13035ce0cc66cca4a467787b4716039e">ContentType</a> contentType,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span class="keywordtype">void</span>)>& connected,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span
class="keywordtype">void</span>)>& disconnected,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> std::queue<Event>&)>& received,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> std::map<std::string, std::string>& <a class="code" href="namespacemesos_1_1internal_1_1tests.html#a1396c5e3b0a179220de2792d74770ec2">environment</a>);</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>  <span class="comment">// Delete copy constructor.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler
.html#ab87ee31e10bdc282bae31a2c973602df">Mesos</a>(<span class="keyword">const</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html">Mesos</a>& other) = <span class="keyword">delete</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="comment">// Delete assignment operator.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html">Mesos</a>& operator=(<span class="keyword">const</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1Mesos.html">Mesos</a>& other) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  ~<a class="code" href="classmesos_1_1v1_1_1execu
tor_1_1Mesos.html">Mesos</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Attempts to send a call to the agent.</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">//</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// Some local validation of calls is performed which may result in dropped</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// events without ever being sent to the agent.</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">void</span> <a class="code" href="classmesos_1_1v1_1_1executor_1_1MesosBase.html#a21bd78cd127c8a8565b6432318a
55dd3">send</a>(<span class="keyword">const</span> <a class="code" href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#acb18ceaa5f6f2338f2a9727af398eb79">Call</a>& call) <span class="keyword">override</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> <span class="keyword">private</span>:</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="classprocess_1_1Owned.html">process::Owned<MesosProcess></a> <a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a>;</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="comment">// namespace executor {</sp
an></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> } <span class="comment">// namespace v1 {</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> } <span class="comment">// namespace mesos {</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <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 &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:2611</div></div>
-<div class="ttc" id="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler_html_ab87ee31e10bdc282bae31a2c973602df"><div class="ttname"><a href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#ab87ee31e10bdc282bae31a2c973602df">mesos::internal::tests::v1::scheduler::Mesos</a></div><div class="ttdeci">mesos::v1::scheduler::Mesos Mesos</div><div class="ttdef"><b>Definition:</b> mesos.hpp:2613</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:2616</div></div>
+<div class="ttc" id="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler_html_ab87ee31e10bdc282bae31a2c973602df"><div class="ttname"><a href="namespacemesos_1_1internal_1_1tests_1_1v1_1_1scheduler.html#ab87ee31e10bdc282bae31a2c973602df">mesos::internal::tests::v1::scheduler::Mesos</a></div><div class="ttdeci">mesos::v1::scheduler::Mesos Mesos</div><div class="ttdef"><b>Definition:</b> mesos.hpp:2618</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:43</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1tests_html_a1396c5e3b0a179220de2792d74770ec2"><div class="ttname"><a href="namespacemesos_1_1internal_1_1tests.html#a1396c5e3b0a179220de2792d74770ec2">mesos::internal::tests::environment</a></div><div class="ttdeci">Environment * environment</div></div>
<div class="ttc" id="namespacemesos_html"><div class="ttname"><a href="namespacemesos.html">mesos</a></div><div class="ttdef"><b>Definition:</b> spec.hpp:30</div></div>