add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _layout / nepi.resources.planetlab.ns3.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 package &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   </head>
28   <body>
29     <div class="related">
30       <h3>Navigation</h3>
31       <ul>
32         <li class="right" style="margin-right: 10px">
33           <a href="../genindex.html" title="General Index"
34              accesskey="I">index</a></li>
35         <li class="right" >
36           <a href="../py-modindex.html" title="Python Module Index"
37              >modules</a> |</li>
38         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li> 
39       </ul>
40     </div>
41       <div class="sphinxsidebar">
42         <div class="sphinxsidebarwrapper">
43   <h3><a href="../index.html">Table Of Contents</a></h3>
44   <ul>
45 <li><a class="reference internal" href="#">nepi.resources.planetlab.ns3 package</a><ul>
46 <li><a class="reference internal" href="#submodules">Submodules</a></li>
47 <li><a class="reference internal" href="#module-nepi.resources.planetlab.ns3.fdudptunnel">nepi.resources.planetlab.ns3.fdudptunnel module</a></li>
48 <li><a class="reference internal" href="#module-nepi.resources.planetlab.ns3.tuntapfdlink">nepi.resources.planetlab.ns3.tuntapfdlink module</a></li>
49 <li><a class="reference internal" href="#module-nepi.resources.planetlab.ns3">Module contents</a></li>
50 </ul>
51 </li>
52 </ul>
53
54   <h3>This Page</h3>
55   <ul class="this-page-menu">
56     <li><a href="../_sources/_layout/nepi.resources.planetlab.ns3.txt"
57            rel="nofollow">Show Source</a></li>
58   </ul>
59 <div id="searchbox" style="display: none">
60   <h3>Quick search</h3>
61     <form class="search" action="../search.html" method="get">
62       <input type="text" name="q" />
63       <input type="submit" value="Go" />
64       <input type="hidden" name="check_keywords" value="yes" />
65       <input type="hidden" name="area" value="default" />
66     </form>
67     <p class="searchtip" style="font-size: 90%">
68     Enter search terms or a module, class or function name.
69     </p>
70 </div>
71 <script type="text/javascript">$('#searchbox').show(0);</script>
72         </div>
73       </div>
74
75     <div class="document">
76       <div class="documentwrapper">
77         <div class="bodywrapper">
78           <div class="body">
79             
80   <div class="section" id="nepi-resources-planetlab-ns3-package">
81 <h1>nepi.resources.planetlab.ns3 package<a class="headerlink" href="#nepi-resources-planetlab-ns3-package" title="Permalink to this headline">¶</a></h1>
82 <div class="section" id="submodules">
83 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
84 </div>
85 <div class="section" id="module-nepi.resources.planetlab.ns3.fdudptunnel">
86 <span id="nepi-resources-planetlab-ns3-fdudptunnel-module"></span><h2>nepi.resources.planetlab.ns3.fdudptunnel module<a class="headerlink" href="#module-nepi.resources.planetlab.ns3.fdudptunnel" title="Permalink to this headline">¶</a></h2>
87 <dl class="class">
88 <dt id="nepi.resources.planetlab.ns3.fdudptunnel.PlanetlabNs3FdUdpTunnel">
89 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.ns3.fdudptunnel.</tt><tt class="descname">PlanetlabNs3FdUdpTunnel</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/ns3/fdudptunnel.html#PlanetlabNs3FdUdpTunnel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.ns3.fdudptunnel.PlanetlabNs3FdUdpTunnel" title="Permalink to this definition">¶</a></dt>
90 <dd><p>Bases: <a class="reference internal" href="nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.fdudptunnel.LinuxNs3FdUdpTunnel" title="nepi.resources.linux.ns3.fdudptunnel.LinuxNs3FdUdpTunnel"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.linux.ns3.fdudptunnel.LinuxNs3FdUdpTunnel</span></tt></a></p>
91 <dl class="method">
92 <dt id="nepi.resources.planetlab.ns3.fdudptunnel.PlanetlabNs3FdUdpTunnel.get_endpoints">
93 <tt class="descname">get_endpoints</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/ns3/fdudptunnel.html#PlanetlabNs3FdUdpTunnel.get_endpoints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.ns3.fdudptunnel.PlanetlabNs3FdUdpTunnel.get_endpoints" title="Permalink to this definition">¶</a></dt>
94 <dd><p>Returns the list of RM that are endpoints to the tunnel</p>
95 </dd></dl>
96
97 </dd></dl>
98
99 </div>
100 <div class="section" id="module-nepi.resources.planetlab.ns3.tuntapfdlink">
101 <span id="nepi-resources-planetlab-ns3-tuntapfdlink-module"></span><h2>nepi.resources.planetlab.ns3.tuntapfdlink module<a class="headerlink" href="#module-nepi.resources.planetlab.ns3.tuntapfdlink" title="Permalink to this headline">¶</a></h2>
102 <dl class="class">
103 <dt id="nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink">
104 <em class="property">class </em><tt class="descclassname">nepi.resources.planetlab.ns3.tuntapfdlink.</tt><tt class="descname">PlanetlabTunTapFdLink</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/ns3/tuntapfdlink.html#PlanetlabTunTapFdLink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink" title="Permalink to this definition">¶</a></dt>
105 <dd><p>Bases: <a class="reference internal" href="nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink" title="nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink</span></tt></a></p>
106 <p>Interconnects a TAP or TUN PlanetLab device to a FdNetDevice</p>
107 <dl class="attribute">
108 <dt id="nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink.fdnetdevice">
109 <tt class="descname">fdnetdevice</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/ns3/tuntapfdlink.html#PlanetlabTunTapFdLink.fdnetdevice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink.fdnetdevice" title="Permalink to this definition">¶</a></dt>
110 <dd></dd></dl>
111
112 <dl class="attribute">
113 <dt id="nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink.tap">
114 <tt class="descname">tap</tt><a class="reference internal" href="../_modules/nepi/resources/planetlab/ns3/tuntapfdlink.html#PlanetlabTunTapFdLink.tap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink.tap" title="Permalink to this definition">¶</a></dt>
115 <dd></dd></dl>
116
117 <dl class="method">
118 <dt id="nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink.upload_sources">
119 <tt class="descname">upload_sources</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/planetlab/ns3/tuntapfdlink.html#PlanetlabTunTapFdLink.upload_sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.planetlab.ns3.tuntapfdlink.PlanetlabTunTapFdLink.upload_sources" title="Permalink to this definition">¶</a></dt>
120 <dd></dd></dl>
121
122 </dd></dl>
123
124 </div>
125 <div class="section" id="module-nepi.resources.planetlab.ns3">
126 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.resources.planetlab.ns3" title="Permalink to this headline">¶</a></h2>
127 </div>
128 </div>
129
130
131           </div>
132         </div>
133       </div>
134       <div class="clearer"></div>
135     </div>
136     <div class="related">
137       <h3>Navigation</h3>
138       <ul>
139         <li class="right" style="margin-right: 10px">
140           <a href="../genindex.html" title="General Index"
141              >index</a></li>
142         <li class="right" >
143           <a href="../py-modindex.html" title="Python Module Index"
144              >modules</a> |</li>
145         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li> 
146       </ul>
147     </div>
148     <div class="footer">
149         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
150       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
151     </div>
152   </body>
153 </html>