| <!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: src/linux/routing/queueing/htb.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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_a18918b93668b435612395bbc2e8b82b.html">linux</a></li><li class="navelem"><a class="el" href="dir_cfcc063d6e54f12d25bee1413151fa14.html">routing</a></li><li class="navelem"><a class="el" href="dir_2b418aa842bc2e1431f5ae26c9184a50.html">queueing</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">htb.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="htb_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 __LINUX_ROUTING_QUEUEING_HTB_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __LINUX_ROUTING_QUEUEING_HTB_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 <stdint.h></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="preprocessor">#include <string></span></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="preprocessor">#include <<a class="code" href="hashmap_8hpp.html">stout/hashmap.hpp</a>></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.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="handle_8hpp.html">linux/routing/handle.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="keyword">namespace </span>routing {</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span>queueing {</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacerouting_1_1queueing_1_1htb.html"> 31</a></span> <span class="keyword">namespace </span>htb {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespacerouting_1_1queueing_1_1htb.html#a9c63f1acf3c6d4ab121a63999fd95bd4"> 33</a></span> constexpr <span class="keywordtype">char</span> <a class="code" href="namespacerouting_1_1queueing_1_1htb.html#a9c63f1acf3c6d4ab121a63999fd95bd4">KIND</a>[] = <span class="stringliteral">"htb"</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="comment">// Returns true if there exists an htb queueing discipline on the</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// egress side of the link.</span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <a class="code" href="classTry.html">Try<bool></a> <a class="code" href="namespacerouting_1_1queueing_1_1htb.html#abd066e04c607951e8aa404551c54a6c3">exists</a>(</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">const</span> std::string& link,</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">const</span> <a class="code" href="classrouting_1_1Handle.html">Handle</a>& parent);</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"> 42</span> <span class="comment">// Creates a new htb queueing discipline on the egress side of</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// the link. Returns false if a queueing discipline already exists which</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// prevents the creation.</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <a class="code" href="classTry.html">Try<bool></a> <a class="code" href="namespacerouting_1_1queueing_1_1htb.html#ad3d6b1ae1396269f0ba73c4258cf8445">create</a>(</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> std::string& link,</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> <a class="code" href="classrouting_1_1Handle.html">Handle</a>& parent,</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<Handle></a>& handle);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</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> <span class="comment">// Removes the htb queueing discipline from the link. Returns</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// false if the htb queueing discipline is not found.</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <a class="code" href="classTry.html">Try<bool></a> <span class="keyword">remove</span>(</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> std::string& link,</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <a class="code" href="classrouting_1_1Handle.html">Handle</a>& parent);</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> <span class="comment">// Returns the set of common Traffic Control statistics for the</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// htb queueing discipline on the link, None() if the link or</span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// qdisc does not exist or an error if we cannot cannot determine the</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// result.</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <a class="code" href="classResult.html">Result<hashmap<std::string, uint64_t></a>> <a class="code" href="namespacerouting_1_1queueing_1_1htb.html#a00bf0ce1ad4eabc8b1d4c03108f49590">statistics</a>(</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">const</span> std::string& link,</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> <a class="code" href="classrouting_1_1Handle.html">Handle</a>& parent);</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> } <span class="comment">// namespace htb {</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">// namespace queueing {</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">// namespace routing {</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 // __LINUX_ROUTING_QUEUEING_HTB_HPP__</span></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option</a></div><div class="ttdef"><b>Definition:</b> option.hpp:24</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="namespacerouting_1_1queueing_1_1htb_html_abd066e04c607951e8aa404551c54a6c3"><div class="ttname"><a href="namespacerouting_1_1queueing_1_1htb.html#abd066e04c607951e8aa404551c54a6c3">routing::queueing::htb::exists</a></div><div class="ttdeci">Try< bool > exists(const std::string &link, const Handle &parent)</div></div> |
| <div class="ttc" id="classrouting_1_1Handle_html"><div class="ttname"><a href="classrouting_1_1Handle.html">routing::Handle</a></div><div class="ttdef"><b>Definition:</b> handle.hpp:38</div></div> |
| <div class="ttc" id="namespacerouting_1_1queueing_1_1htb_html_ad3d6b1ae1396269f0ba73c4258cf8445"><div class="ttname"><a href="namespacerouting_1_1queueing_1_1htb.html#ad3d6b1ae1396269f0ba73c4258cf8445">routing::queueing::htb::create</a></div><div class="ttdeci">Try< bool > create(const std::string &link, const Handle &parent, const Option< Handle > &handle)</div></div> |
| <div class="ttc" id="classResult_html"><div class="ttname"><a href="classResult.html">Result</a></div><div class="ttdef"><b>Definition:</b> result.hpp:40</div></div> |
| <div class="ttc" id="namespacerouting_1_1queueing_1_1htb_html_a00bf0ce1ad4eabc8b1d4c03108f49590"><div class="ttname"><a href="namespacerouting_1_1queueing_1_1htb.html#a00bf0ce1ad4eabc8b1d4c03108f49590">routing::queueing::htb::statistics</a></div><div class="ttdeci">Result< hashmap< std::string, uint64_t > > statistics(const std::string &link, const Handle &parent)</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="handle_8hpp_html"><div class="ttname"><a href="handle_8hpp.html">handle.hpp</a></div></div> |
| <div class="ttc" id="namespacerouting_1_1queueing_1_1htb_html_a9c63f1acf3c6d4ab121a63999fd95bd4"><div class="ttname"><a href="namespacerouting_1_1queueing_1_1htb.html#a9c63f1acf3c6d4ab121a63999fd95bd4">routing::queueing::htb::KIND</a></div><div class="ttdeci">constexpr char KIND[]</div><div class="ttdef"><b>Definition:</b> htb.hpp:33</div></div> |
| <div class="ttc" id="hashmap_8hpp_html"><div class="ttname"><a href="hashmap_8hpp.html">hashmap.hpp</a></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> |
