| <!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/internal.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> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">internal.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="internal_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_INTERNAL_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_INTERNAL_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 <netlink/cache.h></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <netlink/errno.h></span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <netlink/netlink.h></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <netlink/socket.h></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 <memory></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="error_8hpp.html">stout/error.hpp</a>></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="code" href="try_8hpp.html">stout/try.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="keyword">namespace </span>routing {</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="comment">// Customized deallocation functions for netlink objects.</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> <a class="code" href="namespacerouting.html#a728e253aba8e42f601752ddc771e9902">cleanup</a>(T* t);</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> </div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">template</span> <></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespacerouting.html#a31ce7b8c4c1c41c5d23cf9612098150c"> 39</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="namespacerouting.html#a728e253aba8e42f601752ddc771e9902">cleanup</a>(<span class="keyword">struct</span> nl_cache* cache)</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>  nl_cache_free(cache);</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">template</span> <></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacerouting.html#aff13c5cce149d72bea8d202bc7183fa8"> 46</a></span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="namespacerouting.html#a728e253aba8e42f601752ddc771e9902">cleanup</a>(<span class="keyword">struct</span> nl_sock* sock)</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>  nl_socket_free(sock);</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> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// A helper class for managing netlink objects (e.g., rtnl_link,</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// nl_sock, etc.). It manages the life cycle of a netlink object. It</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// is copyable and assignable, and multiple copies share the same</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// underlying netlink object. A netlink object specific cleanup</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// function will be invoked when the last copy of this wrapper is</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// being deleted (similar to Future<T>). We use this class to simplify</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">// our code, especially for error handling.</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classrouting_1_1Netlink.html"> 60</a></span> <span class="keyword">class </span><a class="code" href="classrouting_1_1Netlink.html">Netlink</a></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="keyword">public</span>:</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classrouting_1_1Netlink.html#a49f5365ef1c5c21f7c7dc4f8cd0f11c9"> 63</a></span>  <span class="keyword">explicit</span> <a class="code" href="classrouting_1_1Netlink.html#a49f5365ef1c5c21f7c7dc4f8cd0f11c9">Netlink</a>(T* <span class="keywordtype">object</span>) : data(new Data(object)) {}</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classrouting_1_1Netlink.html#aed276efbe5490b33b471783504b5f89e"> 65</a></span>  T* <span class="keyword">get</span>() <span class="keyword">const</span> { <span class="keywordflow">return</span> data->object; }</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="keyword">private</span>:</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">struct </span>Data</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">explicit</span> Data(T* _object) : object(_object) {}</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  ~Data()</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="keywordflow">if</span> (<span class="keywordtype">object</span> != <span class="keyword">nullptr</span>) {</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="namespacerouting.html#a728e253aba8e42f601752ddc771e9902">cleanup</a>(<span class="keywordtype">object</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>  }</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  T* object;</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</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>  std::shared_ptr<Data> data;</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> };</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// Returns a netlink socket for communicating with the kernel. This</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// socket is needed for most of the operations. The default protocol</span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// of the netlink socket is NETLINK_ROUTE, but you can optionally</span></div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// provide a different one.</span></div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">// TODO(chzhcn): Consider renaming 'routing' to 'netlink'.</span></div> |
| <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="namespacerouting.html#aee51d4e36a57bab7d6ada56e15467370"> 91</a></span> <span class="keyword">inline</span> <a class="code" href="classTry.html">Try<Netlink<struct nl_sock></a>> <a class="code" href="namespacerouting.html#aee51d4e36a57bab7d6ada56e15467370">socket</a>(<span class="keywordtype">int</span> protocol = NETLINK_ROUTE)</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> {</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">struct </span>nl_sock* s = nl_socket_alloc();</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">if</span> (s == <span class="keyword">nullptr</span>) {</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(<span class="stringliteral">"Failed to allocate netlink socket"</span>);</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="classrouting_1_1Netlink.html">Netlink<struct nl_sock></a> sock(s);</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">int</span> <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">error</a> = nl_connect(sock.<a class="code" href="classrouting_1_1Netlink.html#aed276efbe5490b33b471783504b5f89e">get</a>(), protocol);</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">if</span> (error != 0) {</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> <a class="code" href="classError.html">Error</a>(</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="stringliteral">"Failed to connect to netlink protocol: "</span> +</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  std::string(nl_geterror(error)));</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">return</span> sock;</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> }</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> } <span class="comment">// namespace routing {</span></div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#endif // __LINUX_ROUTING_INTERNAL_HPP__</span></div> |
| <div class="ttc" id="classError_html"><div class="ttname"><a href="classError.html">Error</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:35</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="classrouting_1_1Netlink_html_a49f5365ef1c5c21f7c7dc4f8cd0f11c9"><div class="ttname"><a href="classrouting_1_1Netlink.html#a49f5365ef1c5c21f7c7dc4f8cd0f11c9">routing::Netlink::Netlink</a></div><div class="ttdeci">Netlink(T *object)</div><div class="ttdef"><b>Definition:</b> internal.hpp:63</div></div> |
| <div class="ttc" id="classrouting_1_1Netlink_html_aed276efbe5490b33b471783504b5f89e"><div class="ttname"><a href="classrouting_1_1Netlink.html#aed276efbe5490b33b471783504b5f89e">routing::Netlink::get</a></div><div class="ttdeci">T * get() const </div><div class="ttdef"><b>Definition:</b> internal.hpp:65</div></div> |
| <div class="ttc" id="classrouting_1_1Netlink_html"><div class="ttname"><a href="classrouting_1_1Netlink.html">routing::Netlink</a></div><div class="ttdef"><b>Definition:</b> internal.hpp:60</div></div> |
| <div class="ttc" id="error_8hpp_html"><div class="ttname"><a href="error_8hpp.html">error.hpp</a></div></div> |
| <div class="ttc" id="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec_html_ae58e703656ab4a1bd5d9870441236727"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave_1_1cni_1_1spec.html#ae58e703656ab4a1bd5d9870441236727">mesos::internal::slave::cni::spec::error</a></div><div class="ttdeci">std::string error(const std::string &msg, uint32_t code)</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="namespacerouting_html_a728e253aba8e42f601752ddc771e9902"><div class="ttname"><a href="namespacerouting.html#a728e253aba8e42f601752ddc771e9902">routing::cleanup</a></div><div class="ttdeci">void cleanup(struct rtnl_cls *cls)</div><div class="ttdef"><b>Definition:</b> internal.hpp:64</div></div> |
| <div class="ttc" id="namespacerouting_html_aee51d4e36a57bab7d6ada56e15467370"><div class="ttname"><a href="namespacerouting.html#aee51d4e36a57bab7d6ada56e15467370">routing::socket</a></div><div class="ttdeci">Try< Netlink< struct nl_sock > > socket(int protocol=NETLINK_ROUTE)</div><div class="ttdef"><b>Definition:</b> internal.hpp:91</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> |
