| <!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/slave/containerizer/mesos/isolators/network/cni/plugins/port_mapper/port_mapper.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_80f0d4a0945c74dfa611dba2ec326a39.html">slave</a></li><li class="navelem"><a class="el" href="dir_fbb1f3397356a940a2dbc4baf07ee5bb.html">containerizer</a></li><li class="navelem"><a class="el" href="dir_06602996fd31a3e264808d1450975cb2.html">mesos</a></li><li class="navelem"><a class="el" href="dir_7c165478aec9e654f08f29fd2fd0a034.html">isolators</a></li><li class="navelem"><a class="el" href="dir_cad20a54f7e86c299014df60d07982ce.html">network</a></li><li class="navelem"><a class="el" href="dir_22258b2806d789550974ea33c504be99.html">cni</a></li><li class="navelem"><a class="el" href="dir_1f2c991da89398be6af2e7ffd2c45e31.html">plugins</a></li><li class="navelem"><a class="el" href="dir_f00e901499d154ec09950234dd4b6079.html">port_mapper</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">port_mapper.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="port__mapper_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 __NETWORK_CNI_PLUGIN_PORTMAPPER_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __NETWORK_CNI_PLUGIN_PORTMAPPER_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 <map></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="json_8hpp.html">stout/json.hpp</a>></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="option_8hpp.html">stout/option.hpp</a>></span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="future_8hpp.html">process/future.hpp</a>></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="owned_8hpp.html">process/owned.hpp</a>></span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="libprocess_2include_2process_2process_8hpp.html">process/process.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="include_2mesos_2mesos_8hpp.html">mesos/mesos.hpp</a>></span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="src_2slave_2containerizer_2mesos_2isolators_2network_2cni_2spec_8hpp.html">slave/containerizer/mesos/isolators/network/cni/spec.hpp</a>"</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>mesos {</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>internal {</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> <span class="keyword">namespace </span>cni {</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_1internal_1_1slave_1_1cni_1_1PortMapper.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html">PortMapper</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">// Error codes for the port mapper plugin.</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// NOTE: Plugin specific erros should use Values of 100+.</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#a8d0d2235ccd8bcc62fce6b4f6213b3aa"> 44</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">int</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#a8d0d2235ccd8bcc62fce6b4f6213b3aa">ERROR_READ_FAILURE</a> = 100; <span class="comment">// Fail to read from stdin.</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#aae5c42a434b6bd5ab8bb9e6a3f381031"> 45</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">int</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#aae5c42a434b6bd5ab8bb9e6a3f381031">ERROR_BAD_ARGS</a> = 101; <span class="comment">// Miss or invalid arguments.</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#acabfc11c561d82f5704620dea441d40f"> 46</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">int</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#acabfc11c561d82f5704620dea441d40f">ERROR_DELEGATE_FAILURE</a> = 102;</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#aa05364e554107c12f4777e179c4f4657"> 47</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">int</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#aa05364e554107c12f4777e179c4f4657">ERROR_PORTMAP_FAILURE</a> = 103;</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ada06e30659b136a690e6921e991f866c"> 48</a></span>  <span class="keyword">static</span> constexpr <span class="keywordtype">int</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ada06e30659b136a690e6921e991f866c">ERROR_UNSUPPORTED_COMMAND</a> = 104;</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>  <span class="comment">// Takes in a JSON formatted string, validates that the following</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// fields are present:</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// * 'name' : Name of the CNI configuration that will be passed</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// to the CNI plugin used for delegation.</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// * 'chain' : The iptables chain to use for setting up DNAT.</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// * 'delegate': The port-mapper should always be used in</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// conjunction with another CNI plugin that sets up</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// the interfaces and IP address on the container.</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// This field holds the CNI configuration of the</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// plugin to which the port-mapper delegates the</span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// functionality of connecting the container to the</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// network.</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// * 'args' : The port-mapper uses the `NetworkInfo` passed by</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Mesos as meta-data in the "args" field to decipher</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// the ports for which DNAT needs to bet setup. To</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// understand how Mesos uses this field please read</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// the documentation for "CNI support in Mesos":</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// http://mesos.apache.org/documentation/latest/cni/</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">//</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// In case of an error returns a JSON formatted string of type</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// `spec::Error` as the error message for the `Try`.</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">static</span> <a class="code" href="classTry.html">Try<process::Owned<PortMapper></a>, <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1spec_1_1PluginError.html">spec::PluginError</a>> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#a1d990c4ea1b3543a069355c41fc17a1e">create</a>(</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> std::string& cniConfig);</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">// Executes the CNI plugin specified in 'delegate'. When</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// `cniCommand` is set to `spec::CNI_CMD_ADD` successful execution</span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// of the 'delegate' plugin will install port-forwarding rules, if</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// any, that are specified in `NetworkInfo`. On success will return</span></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// a JSON string seen in the successful execution of the 'delegate'</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// plugin. When `cniCommand` is set to `spec::CNI_CMD_DEL`</span></div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// successful execution of the delegate plugin will return `None`.</span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classTry.html">Try<Option<std::string></a>, <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1spec_1_1PluginError.html">spec::PluginError</a>> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ae62dd526a944038b8076aa82c2229700">execute</a>();</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ac14ff20fc60825b7e34f017bcaf2996c"> 83</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ac14ff20fc60825b7e34f017bcaf2996c">~PortMapper</a>() {};</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> <span class="keyword">protected</span>:</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// Used to invoke the plugin specified in 'delegate'. The possible</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// values for `command` are `spec::CNI_CMD_ADD` or</span></div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// `spec::CNI_CMD_DEL`. The `command` is used in</span></div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">// setting the CNI_COMMAND environment variable before invoking the</span></div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// 'delegate' plugin.</span></div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">//</span></div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// When `command` is set to `spec::CNI_CMD_ADD` returns a</span></div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// `spec::NetworkInfo` on successful execution of the 'delegate'</span></div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// plugin. When command is set to `spec::CNI_CMD_DEL` returns `None`</span></div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// on successful execution of the plugin.</span></div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">//</span></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// NOTE: Defining `delegate` as a virtual method so that we can mock it.</span></div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">virtual</span> <a class="code" href="classResult.html">Result<spec::NetworkInfo></a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ad70ef5e38395b447b347260fbf67e90c">delegate</a>(<span class="keyword">const</span> std::string& command);</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="keyword">private</span>:</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html">PortMapper</a>(</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">const</span> std::string& _cniCommand, <span class="comment">// ADD, DEL or VERSION.</span></div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">const</span> std::string& _cniContainerId, <span class="comment">// Container ID.</span></div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> std::string& _cniNetNs, <span class="comment">// Path to network namespace file.</span></div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> std::string& _cniIfName, <span class="comment">// Interface name to set up.</span></div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& _cniArgs, <span class="comment">// Extra arguments.</span></div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">const</span> std::string& _cniPath, <span class="comment">// Paths to search for CNI plugins.</span></div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">const</span> mesos::NetworkInfo& _networkInfo,</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">const</span> std::string& _delegatePlugin,</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">const</span> <a class="code" href="structJSON_1_1Object.html">JSON::Object</a>& _delegateConfig,</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">const</span> std::string& _chain,</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">const</span> std::vector<std::string>& _excludeDevices)</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  : cniCommand(_cniCommand),</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  cniContainerId(_cniContainerId),</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  cniNetNs(_cniNetNs),</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  cniIfName(_cniIfName),</div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  cniArgs(_cniArgs),</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  cniPath(_cniPath),</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  networkInfo(_networkInfo),</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  delegatePlugin(_delegatePlugin),</div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  delegateConfig(_delegateConfig),</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  chain(_chain),</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  excludeDevices(_excludeDevices){};</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="comment">// Returns a tag that will be appended to every DNAT rule in the</span></div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="comment">// iptables associated with this container. Currently the tag is of</span></div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// the form: 'container_id: <CNI_CONTAINERID>'.</span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  std::string getIptablesRuleTag();</div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  std::string getIptablesRule(</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">const</span> <a class="code" href="classnet_1_1IP.html">net::IP</a>& ip,</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">const</span> mesos::NetworkInfo::PortMapping& portMapping);</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="classTry.html">Try<Nothing></a> addPortMapping(</div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">const</span> <a class="code" href="classnet_1_1IP.html">net::IP</a>& ip,</div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> mesos::NetworkInfo::PortMapping& portMapping);</div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href="classTry.html">Try<Nothing></a> delPortMapping();</div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <a class="code" href="classTry.html">Try<std::string, spec::PluginError></a> handleAddCommand();</div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="classTry.html">Try<Nothing, spec::PluginError></a> handleDelCommand();</div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">const</span> std::string cniCommand;</div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">const</span> std::string cniContainerId;</div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">const</span> std::string cniNetNs;</div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">const</span> std::string cniIfName;</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a> cniArgs;</div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">const</span> std::string cniPath;</div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keyword">const</span> mesos::NetworkInfo networkInfo;</div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">const</span> std::string delegatePlugin;</div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">const</span> <a class="code" href="structJSON_1_1Object.html">JSON::Object</a> delegateConfig;</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="comment">// The iptable chain to which the DNAT rules need to be added. We</span></div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// need a separate chain, so that we can group the DNAT rules</span></div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="comment">// specific to this CNI network under this chain. It makes it easier</span></div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">// for the operator to analyze the ownership of these rules if they</span></div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment">// are grouped under a chain that the operator is aware is used by</span></div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">// the CNI plugin.</span></div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">const</span> std::string chain;</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment">// List of ingress devices that should be excluded from the DNAT</span></div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="comment">// rules.</span></div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">const</span> std::vector<std::string> excludeDevices;</div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> };</div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> } <span class="comment">// namespace cni {</span></div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> } <span class="comment">// namespace slave {</span></div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> } <span class="comment">// namespace internal {</span></div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> } <span class="comment">// namespace mesos {</span></div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor">#endif // __NETWORK_CNI_PLUGIN_PORTMAPPER_HPP__</span></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< std::string ></a></div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_a1d990c4ea1b3543a069355c41fc17a1e"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#a1d990c4ea1b3543a069355c41fc17a1e">mesos::internal::slave::cni::PortMapper::create</a></div><div class="ttdeci">static Try< process::Owned< PortMapper >, spec::PluginError > create(const std::string &cniConfig)</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_1internal_1_1slave_1_1cni_1_1spec_1_1PluginError_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1spec_1_1PluginError.html">mesos::internal::slave::cni::spec::PluginError</a></div><div class="ttdef"><b>Definition:</b> spec.hpp:65</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_ac14ff20fc60825b7e34f017bcaf2996c"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ac14ff20fc60825b7e34f017bcaf2996c">mesos::internal::slave::cni::PortMapper::~PortMapper</a></div><div class="ttdeci">virtual ~PortMapper()</div><div class="ttdef"><b>Definition:</b> port_mapper.hpp:83</div></div> |
| <div class="ttc" id="include_2mesos_2mesos_8hpp_html"><div class="ttname"><a href="include_2mesos_2mesos_8hpp.html">mesos.hpp</a></div></div> |
| <div class="ttc" id="json_8hpp_html"><div class="ttname"><a href="json_8hpp.html">json.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="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_aa05364e554107c12f4777e179c4f4657"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#aa05364e554107c12f4777e179c4f4657">mesos::internal::slave::cni::PortMapper::ERROR_PORTMAP_FAILURE</a></div><div class="ttdeci">static constexpr int ERROR_PORTMAP_FAILURE</div><div class="ttdef"><b>Definition:</b> port_mapper.hpp:47</div></div> |
| <div class="ttc" id="structJSON_1_1Object_html"><div class="ttname"><a href="structJSON_1_1Object.html">JSON::Object</a></div><div class="ttdef"><b>Definition:</b> json.hpp:151</div></div> |
| <div class="ttc" id="classnet_1_1IP_html"><div class="ttname"><a href="classnet_1_1IP.html">net::IP</a></div><div class="ttdef"><b>Definition:</b> ip.hpp:73</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_acabfc11c561d82f5704620dea441d40f"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#acabfc11c561d82f5704620dea441d40f">mesos::internal::slave::cni::PortMapper::ERROR_DELEGATE_FAILURE</a></div><div class="ttdeci">static constexpr int ERROR_DELEGATE_FAILURE</div><div class="ttdef"><b>Definition:</b> port_mapper.hpp:46</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_aae5c42a434b6bd5ab8bb9e6a3f381031"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#aae5c42a434b6bd5ab8bb9e6a3f381031">mesos::internal::slave::cni::PortMapper::ERROR_BAD_ARGS</a></div><div class="ttdeci">static constexpr int ERROR_BAD_ARGS</div><div class="ttdef"><b>Definition:</b> port_mapper.hpp:45</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_ae62dd526a944038b8076aa82c2229700"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ae62dd526a944038b8076aa82c2229700">mesos::internal::slave::cni::PortMapper::execute</a></div><div class="ttdeci">Try< Option< std::string >, spec::PluginError > execute()</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="owned_8hpp_html"><div class="ttname"><a href="owned_8hpp.html">owned.hpp</a></div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_ada06e30659b136a690e6921e991f866c"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ada06e30659b136a690e6921e991f866c">mesos::internal::slave::cni::PortMapper::ERROR_UNSUPPORTED_COMMAND</a></div><div class="ttdeci">static constexpr int ERROR_UNSUPPORTED_COMMAND</div><div class="ttdef"><b>Definition:</b> port_mapper.hpp:48</div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_ad70ef5e38395b447b347260fbf67e90c"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#ad70ef5e38395b447b347260fbf67e90c">mesos::internal::slave::cni::PortMapper::delegate</a></div><div class="ttdeci">virtual Result< spec::NetworkInfo > delegate(const std::string &command)</div></div> |
| <div class="ttc" id="src_2slave_2containerizer_2mesos_2isolators_2network_2cni_2spec_8hpp_html"><div class="ttname"><a href="src_2slave_2containerizer_2mesos_2isolators_2network_2cni_2spec_8hpp.html">spec.hpp</a></div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html">mesos::internal::slave::cni::PortMapper</a></div><div class="ttdef"><b>Definition:</b> port_mapper.hpp:39</div></div> |
| <div class="ttc" id="libprocess_2include_2process_2process_8hpp_html"><div class="ttname"><a href="libprocess_2include_2process_2process_8hpp.html">process.hpp</a></div></div> |
| <div class="ttc" id="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper_html_a8d0d2235ccd8bcc62fce6b4f6213b3aa"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1cni_1_1PortMapper.html#a8d0d2235ccd8bcc62fce6b4f6213b3aa">mesos::internal::slave::cni::PortMapper::ERROR_READ_FAILURE</a></div><div class="ttdeci">static constexpr int ERROR_READ_FAILURE</div><div class="ttdef"><b>Definition:</b> port_mapper.hpp:44</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> |
