| <!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/slave/qos_controller.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_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_3b9235db7fa06071d6ce5b50fc217da3.html">slave</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">qos_controller.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="slave_2qos__controller_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_SLAVE_QOS_CONTROLLER_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __MESOS_SLAVE_QOS_CONTROLLER_HPP__</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <list></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <string></span></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="preprocessor">#include <<a class="code" href="resources_8hpp.html">mesos/resources.hpp</a>></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="oversubscription_8hpp.html">mesos/slave/oversubscription.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="future_8hpp.html">process/future.hpp</a>></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="queue_8hpp.html">process/queue.hpp</a>></span></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="preprocessor">#include <<a class="code" href="lambda_8hpp.html">stout/lambda.hpp</a>></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <<a class="code" href="nothing_8hpp.html">stout/nothing.hpp</a>></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <<a class="code" href="option_8hpp.html">stout/option.hpp</a>></span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.hpp</a>></span></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> <span class="keyword">namespace </span>mesos {</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>slave {</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> <span class="comment">// A slave component used for oversubscription. When the revocable</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// tasks are running, it is important to constantly monitor the</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// original tasks running on those resources and guarantee performance</span></div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// based on an SLA. In order to react to detected interference, the</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// QoS controller needs to be able to kill or throttle running</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// revocable tasks.</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classmesos_1_1slave_1_1QoSController.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classmesos_1_1slave_1_1QoSController.html">QoSController</a></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="keyword">public</span>:</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// Create a QoS Controller instance of the given type specified</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// by the user. If the type is not specified, a default resource</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// estimator instance will be created.</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">static</span> <a class="code" href="classTry.html">Try<QoSController*></a> <a class="code" href="classmesos_1_1slave_1_1QoSController.html#ab6e9f5cbef4c49786372467678baa27c">create</a>(<span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& <a class="code" href="namespacemesos_1_1internal_1_1fs.html#a2343e2642db514496ba8380776487fba">type</a>);</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classmesos_1_1slave_1_1QoSController.html#a7190ee21e6dc56947ca9221124e023c5"> 52</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmesos_1_1slave_1_1QoSController.html#a7190ee21e6dc56947ca9221124e023c5">~QoSController</a>() {}</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Initializes this QoS Controller. This method needs to be</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// called before any other member method is called. It registers</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// a callback in the QoS Controller. The callback allows the</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// QoS Controller to fetch the current resource usage for each</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// executor on slave.</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">virtual</span> <a class="code" href="classTry.html">Try<Nothing></a> <a class="code" href="classmesos_1_1slave_1_1QoSController.html#aba35ec151522f91bc8d20e4dc91162aa">initialize</a>(</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">const</span> lambda::function<<a class="code" href="classprocess_1_1Future.html">process::Future<ResourceUsage></a>()>& <a class="code" href="namespacemesos_1_1internal.html#a91a5bc5e418e8712bb512721b5abc46d">usage</a>) = 0;</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// A QoS Controller informs the slave about corrections to carry</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// out, but returning futures to QoSCorrection objects. For more</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// information, please refer to mesos.proto.</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">process::Future<std::list<QoSCorrection></a>> <a class="code" href="classmesos_1_1slave_1_1QoSController.html#a6a49a5ed1ffa3b9b11eea1e892cb5b90">corrections</a>() = 0;</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">// namespace slave {</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">// namespace mesos {</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif // __MESOS_SLAVE_QOS_CONTROLLER_HPP__</span></div> |
| <div class="ttc" id="resources_8hpp_html"><div class="ttname"><a href="resources_8hpp.html">resources.hpp</a></div></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< std::string ></a></div></div> |
| <div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> try.hpp:34</div></div> |
| <div class="ttc" id="classmesos_1_1slave_1_1QoSController_html_aba35ec151522f91bc8d20e4dc91162aa"><div class="ttname"><a href="classmesos_1_1slave_1_1QoSController.html#aba35ec151522f91bc8d20e4dc91162aa">mesos::slave::QoSController::initialize</a></div><div class="ttdeci">virtual Try< Nothing > initialize(const lambda::function< process::Future< ResourceUsage >()> &usage)=0</div></div> |
| <div class="ttc" id="classmesos_1_1slave_1_1QoSController_html_a7190ee21e6dc56947ca9221124e023c5"><div class="ttname"><a href="classmesos_1_1slave_1_1QoSController.html#a7190ee21e6dc56947ca9221124e023c5">mesos::slave::QoSController::~QoSController</a></div><div class="ttdeci">virtual ~QoSController()</div><div class="ttdef"><b>Definition:</b> qos_controller.hpp:52</div></div> |
| <div class="ttc" id="classmesos_1_1slave_1_1QoSController_html_ab6e9f5cbef4c49786372467678baa27c"><div class="ttname"><a href="classmesos_1_1slave_1_1QoSController.html#ab6e9f5cbef4c49786372467678baa27c">mesos::slave::QoSController::create</a></div><div class="ttdeci">static Try< QoSController * > create(const Option< std::string > &type)</div></div> |
| <div class="ttc" id="oversubscription_8hpp_html"><div class="ttname"><a href="oversubscription_8hpp.html">oversubscription.hpp</a></div></div> |
| <div class="ttc" id="lambda_8hpp_html"><div class="ttname"><a href="lambda_8hpp.html">lambda.hpp</a></div></div> |
| <div class="ttc" id="classmesos_1_1slave_1_1QoSController_html_a6a49a5ed1ffa3b9b11eea1e892cb5b90"><div class="ttname"><a href="classmesos_1_1slave_1_1QoSController.html#a6a49a5ed1ffa3b9b11eea1e892cb5b90">mesos::slave::QoSController::corrections</a></div><div class="ttdeci">virtual process::Future< std::list< QoSCorrection > > corrections()=0</div></div> |
| <div class="ttc" id="namespacemesos_1_1internal_html_a91a5bc5e418e8712bb512721b5abc46d"><div class="ttname"><a href="namespacemesos_1_1internal.html#a91a5bc5e418e8712bb512721b5abc46d">mesos::internal::usage</a></div><div class="ttdeci">Try< ResourceStatistics > usage(pid_t pid, bool mem=true, bool cpus=true)</div></div> |
| <div class="ttc" id="nothing_8hpp_html"><div class="ttname"><a href="nothing_8hpp.html">nothing.hpp</a></div></div> |
| <div class="ttc" id="option_8hpp_html"><div class="ttname"><a href="option_8hpp.html">option.hpp</a></div></div> |
| <div class="ttc" id="future_8hpp_html"><div class="ttname"><a href="future_8hpp.html">future.hpp</a></div></div> |
| <div class="ttc" id="try_8hpp_html"><div class="ttname"><a href="try_8hpp.html">try.hpp</a></div></div> |
| <div class="ttc" id="namespacemesos_1_1internal_1_1fs_html_a2343e2642db514496ba8380776487fba"><div class="ttname"><a href="namespacemesos_1_1internal_1_1fs.html#a2343e2642db514496ba8380776487fba">mesos::internal::fs::type</a></div><div class="ttdeci">Try< uint32_t > type(const std::string &path)</div></div> |
| <div class="ttc" id="classmesos_1_1slave_1_1QoSController_html"><div class="ttname"><a href="classmesos_1_1slave_1_1QoSController.html">mesos::slave::QoSController</a></div><div class="ttdef"><b>Definition:</b> qos_controller.hpp:44</div></div> |
| <div class="ttc" id="queue_8hpp_html"><div class="ttname"><a href="queue_8hpp.html">queue.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future</a></div><div class="ttdef"><b>Definition:</b> future.hpp:56</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> |
