add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / planetlab / ns3 / fdudptunnel.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>nepi.resources.planetlab.ns3.fdudptunnel &mdash; NEPI 3.0 documentation</title>
10     
11     <link rel="stylesheet" href="../../../../../_static/sphinxdoc.css" type="text/css" />
12     <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    '../../../../../',
17         VERSION:     '3.0',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
23     <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
24     <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
25     <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
26     <link rel="top" title="NEPI 3.0 documentation" href="../../../../../index.html" />
27     <link rel="up" title="Module code" href="../../../../index.html" /> 
28   </head>
29   <body>
30     <div class="related">
31       <h3>Navigation</h3>
32       <ul>
33         <li class="right" style="margin-right: 10px">
34           <a href="../../../../../genindex.html" title="General Index"
35              accesskey="I">index</a></li>
36         <li class="right" >
37           <a href="../../../../../py-modindex.html" title="Python Module Index"
38              >modules</a> |</li>
39         <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
40           <li><a href="../../../../index.html" accesskey="U">Module code</a> &raquo;</li> 
41       </ul>
42     </div>
43       <div class="sphinxsidebar">
44         <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
46   <h3>Quick search</h3>
47     <form class="search" action="../../../../../search.html" method="get">
48       <input type="text" name="q" />
49       <input type="submit" value="Go" />
50       <input type="hidden" name="check_keywords" value="yes" />
51       <input type="hidden" name="area" value="default" />
52     </form>
53     <p class="searchtip" style="font-size: 90%">
54     Enter search terms or a module, class or function name.
55     </p>
56 </div>
57 <script type="text/javascript">$('#searchbox').show(0);</script>
58         </div>
59       </div>
60
61     <div class="document">
62       <div class="documentwrapper">
63         <div class="bodywrapper">
64           <div class="body">
65             
66   <h1>Source code for nepi.resources.planetlab.ns3.fdudptunnel</h1><div class="highlight"><pre>
67 <span class="c">#</span>
68 <span class="c">#    NEPI, a framework to manage network experiments</span>
69 <span class="c">#    Copyright (C) 2013 INRIA</span>
70 <span class="c">#</span>
71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
73 <span class="c">#    published by the Free Software Foundation;</span>
74 <span class="c">#</span>
75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
78 <span class="c">#    GNU General Public License for more details.</span>
79 <span class="c">#</span>
80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
84
85 <span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span><span class="p">,</span> <span class="n">Types</span>
86 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span><span class="p">,</span> <span class="n">ResourceState</span>
87 <span class="kn">from</span> <span class="nn">nepi.resources.linux.ns3.fdudptunnel</span> <span class="kn">import</span> <span class="n">LinuxNs3FdUdpTunnel</span>
88 <span class="kn">from</span> <span class="nn">nepi.util.sshfuncs</span> <span class="kn">import</span> <span class="n">ProcStatus</span>
89 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span><span class="p">,</span> <span class="n">tdiffsec</span>
90
91 <span class="kn">import</span> <span class="nn">base64</span>
92 <span class="kn">import</span> <span class="nn">os</span>
93 <span class="kn">import</span> <span class="nn">socket</span>
94 <span class="kn">import</span> <span class="nn">time</span>
95
96 <span class="nd">@clsinit_copy</span>
97 <div class="viewcode-block" id="PlanetlabNs3FdUdpTunnel"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.ns3.html#nepi.resources.planetlab.ns3.fdudptunnel.PlanetlabNs3FdUdpTunnel">[docs]</a><span class="k">class</span> <span class="nc">PlanetlabNs3FdUdpTunnel</span><span class="p">(</span><span class="n">LinuxNs3FdUdpTunnel</span><span class="p">):</span>
98     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;planetlab::ns3::FdUdpTunnel&quot;</span>
99     <span class="n">_help</span> <span class="o">=</span> <span class="s">&quot;Constructs a tunnel between two Ns-3 FdNetdevices &quot;</span> \
100             <span class="s">&quot;located in remote PlanetLab nodes using a UDP connection &quot;</span>
101     <span class="n">_platform</span> <span class="o">=</span> <span class="s">&quot;planetlab::ns3&quot;</span>
102
103 <div class="viewcode-block" id="PlanetlabNs3FdUdpTunnel.get_endpoints"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.ns3.html#nepi.resources.planetlab.ns3.fdudptunnel.PlanetlabNs3FdUdpTunnel.get_endpoints">[docs]</a>    <span class="k">def</span> <span class="nf">get_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
104         <span class="sd">&quot;&quot;&quot; Returns the list of RM that are endpoints to the tunnel </span>
105 <span class="sd">        &quot;&quot;&quot;</span>
106         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fd2</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fd1</span><span class="p">:</span>
107             <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3fdnetdevice</span> <span class="kn">import</span> <span class="n">NS3BaseFdNetDevice</span>
108             <span class="n">devices</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">NS3BaseFdNetDevice</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
109             <span class="k">if</span> <span class="ow">not</span> <span class="n">devices</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">devices</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span> 
110                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Tunnel must be connected to exactly two FdNetDevices&quot;</span>
111                 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
112                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
113
114             <span class="bp">self</span><span class="o">.</span><span class="n">_fd1</span> <span class="o">=</span> <span class="n">devices</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
115             <span class="bp">self</span><span class="o">.</span><span class="n">_fd2</span> <span class="o">=</span> <span class="n">devices</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
116             <span class="bp">self</span><span class="o">.</span><span class="n">_pi</span> <span class="o">=</span> <span class="bp">True</span>
117  
118             <span class="c"># Set PI headers on</span>
119             <span class="bp">self</span><span class="o">.</span><span class="n">_fd1</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;EncapsulationMode&quot;</span><span class="p">,</span> <span class="s">&quot;DixPi&quot;</span><span class="p">)</span>
120             <span class="bp">self</span><span class="o">.</span><span class="n">_fd2</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;EncapsulationMode&quot;</span><span class="p">,</span> <span class="s">&quot;DixPi&quot;</span><span class="p">)</span>
121         
122             <span class="n">simu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fd1</span><span class="o">.</span><span class="n">simulation</span>
123             <span class="kn">from</span> <span class="nn">nepi.resources.linux.node</span> <span class="kn">import</span> <span class="n">LinuxNode</span>
124             <span class="n">nodes</span> <span class="o">=</span> <span class="n">simu</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">LinuxNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
125             <span class="bp">self</span><span class="o">.</span><span class="n">_fd1node</span> <span class="o">=</span> <span class="n">nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
126      
127             <span class="n">simu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fd2</span><span class="o">.</span><span class="n">simulation</span>
128             <span class="kn">from</span> <span class="nn">nepi.resources.linux.node</span> <span class="kn">import</span> <span class="n">LinuxNode</span>
129             <span class="n">nodes</span> <span class="o">=</span> <span class="n">simu</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">LinuxNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
130             <span class="bp">self</span><span class="o">.</span><span class="n">_fd2node</span> <span class="o">=</span> <span class="n">nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
131
132             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fd1node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;hostname&quot;</span><span class="p">)</span> <span class="o">==</span> \
133                     <span class="bp">self</span><span class="o">.</span><span class="n">_fd2node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;hostname&quot;</span><span class="p">):</span>
134                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Tunnel requires endpoints on different hosts&quot;</span>
135                 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
136                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
137
138         <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_fd1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fd2</span><span class="p">]</span>
139 </pre></div></div></div>
140
141           </div>
142         </div>
143       </div>
144       <div class="clearer"></div>
145     </div>
146     <div class="related">
147       <h3>Navigation</h3>
148       <ul>
149         <li class="right" style="margin-right: 10px">
150           <a href="../../../../../genindex.html" title="General Index"
151              >index</a></li>
152         <li class="right" >
153           <a href="../../../../../py-modindex.html" title="Python Module Index"
154              >modules</a> |</li>
155         <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
156           <li><a href="../../../../index.html" >Module code</a> &raquo;</li> 
157       </ul>
158     </div>
159     <div class="footer">
160         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
161       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
162     </div>
163   </body>
164 </html>