blob: 92562752226f3a1c6398ae200ff91ede90ede898 [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: src/linux/routing/route.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_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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">route.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="route_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 __LINUX_ROUTING_ROUTE_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __LINUX_ROUTING_ROUTE_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;string&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="3rdparty_2stout_2include_2stout_2ip_8hpp.html">stout/ip.hpp</a>&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="option_8hpp.html">stout/option.hpp</a>&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="result_8hpp.html">stout/result.hpp</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="try_8hpp.html">stout/try.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="keyword">namespace </span>routing {</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacerouting_1_1route.html"> 29</a></span>&#160;<span class="keyword">namespace </span>route {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// Represents a rule in the routing table (for IPv4).</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structrouting_1_1route_1_1Rule.html"> 32</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structrouting_1_1route_1_1Rule.html">Rule</a></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structrouting_1_1route_1_1Rule.html#a26067eb74967a0f4397f47a575bdbda5"> 34</a></span>&#160; <a class="code" href="structrouting_1_1route_1_1Rule.html#a26067eb74967a0f4397f47a575bdbda5">Rule</a>(<span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;net::IPNetwork&gt;</a>&amp; _destination,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;net::IP&gt;</a>&amp; _gateway,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">const</span> std::string&amp; _link)</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; : <a class="code" href="structrouting_1_1route_1_1Rule.html#adf73ee97c86fa8359ccb37c1717ae810">destination</a>(_destination),</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="structrouting_1_1route_1_1Rule.html#afea5e7dd74f72f865f2a3415afe9751c">gateway</a>(_gateway),</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structrouting_1_1route_1_1Rule.html#a92b75fc5d519586b2f19c601e0755d2e">link</a>(_link) {}</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structrouting_1_1route_1_1Rule.html#adf73ee97c86fa8359ccb37c1717ae810"> 41</a></span>&#160; <a class="code" href="classOption.html">Option&lt;net::IPNetwork&gt;</a> <a class="code" href="structrouting_1_1route_1_1Rule.html#adf73ee97c86fa8359ccb37c1717ae810">destination</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structrouting_1_1route_1_1Rule.html#afea5e7dd74f72f865f2a3415afe9751c"> 42</a></span>&#160; <a class="code" href="classOption.html">Option&lt;net::IP&gt;</a> <a class="code" href="structrouting_1_1route_1_1Rule.html#afea5e7dd74f72f865f2a3415afe9751c">gateway</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structrouting_1_1route_1_1Rule.html#a92b75fc5d519586b2f19c601e0755d2e"> 43</a></span>&#160; std::string <a class="code" href="structrouting_1_1route_1_1Rule.html#a92b75fc5d519586b2f19c601e0755d2e">link</a>;</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">// Returns the main routing table of this host.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<a class="code" href="classTry.html">Try&lt;std::vector&lt;Rule&gt;</a>&gt; <a class="code" href="namespacerouting_1_1route.html#a33bac2d496d055b5aa399998f162d41e">table</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment">// Returns the default gateway of this host.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<a class="code" href="classResult.html">Result&lt;net::IP&gt;</a> <a class="code" href="namespacerouting_1_1route.html#a21e80951b64e4b909431e2d989e4b6dd">defaultGateway</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;} <span class="comment">// namespace route {</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;} <span class="comment">// namespace routing {</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif // __LINUX_ROUTING_ROUTE_HPP__</span></div>
<div class="ttc" id="structrouting_1_1route_1_1Rule_html_afea5e7dd74f72f865f2a3415afe9751c"><div class="ttname"><a href="structrouting_1_1route_1_1Rule.html#afea5e7dd74f72f865f2a3415afe9751c">routing::route::Rule::gateway</a></div><div class="ttdeci">Option&lt; net::IP &gt; gateway</div><div class="ttdef"><b>Definition:</b> route.hpp:42</div></div>
<div class="ttc" id="namespacerouting_1_1route_html_a21e80951b64e4b909431e2d989e4b6dd"><div class="ttname"><a href="namespacerouting_1_1route.html#a21e80951b64e4b909431e2d989e4b6dd">routing::route::defaultGateway</a></div><div class="ttdeci">Result&lt; net::IP &gt; defaultGateway()</div></div>
<div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option&lt; net::IPNetwork &gt;</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="3rdparty_2stout_2include_2stout_2ip_8hpp_html"><div class="ttname"><a href="3rdparty_2stout_2include_2stout_2ip_8hpp.html">ip.hpp</a></div></div>
<div class="ttc" id="structrouting_1_1route_1_1Rule_html"><div class="ttname"><a href="structrouting_1_1route_1_1Rule.html">routing::route::Rule</a></div><div class="ttdef"><b>Definition:</b> route.hpp:32</div></div>
<div class="ttc" id="structrouting_1_1route_1_1Rule_html_a26067eb74967a0f4397f47a575bdbda5"><div class="ttname"><a href="structrouting_1_1route_1_1Rule.html#a26067eb74967a0f4397f47a575bdbda5">routing::route::Rule::Rule</a></div><div class="ttdeci">Rule(const Option&lt; net::IPNetwork &gt; &amp;_destination, const Option&lt; net::IP &gt; &amp;_gateway, const std::string &amp;_link)</div><div class="ttdef"><b>Definition:</b> route.hpp:34</div></div>
<div class="ttc" id="result_8hpp_html"><div class="ttname"><a href="result_8hpp.html">result.hpp</a></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="option_8hpp_html"><div class="ttname"><a href="option_8hpp.html">option.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="structrouting_1_1route_1_1Rule_html_a92b75fc5d519586b2f19c601e0755d2e"><div class="ttname"><a href="structrouting_1_1route_1_1Rule.html#a92b75fc5d519586b2f19c601e0755d2e">routing::route::Rule::link</a></div><div class="ttdeci">std::string link</div><div class="ttdef"><b>Definition:</b> route.hpp:43</div></div>
<div class="ttc" id="namespacerouting_1_1route_html_a33bac2d496d055b5aa399998f162d41e"><div class="ttname"><a href="namespacerouting_1_1route.html#a33bac2d496d055b5aa399998f162d41e">routing::route::table</a></div><div class="ttdeci">Try&lt; std::vector&lt; Rule &gt; &gt; table()</div></div>
<div class="ttc" id="structrouting_1_1route_1_1Rule_html_adf73ee97c86fa8359ccb37c1717ae810"><div class="ttname"><a href="structrouting_1_1route_1_1Rule.html#adf73ee97c86fa8359ccb37c1717ae810">routing::route::Rule::destination</a></div><div class="ttdeci">Option&lt; net::IPNetwork &gt; destination</div><div class="ttdef"><b>Definition:</b> route.hpp:41</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>