Merge commit '655eefc07db57c1d21cbf11487876c7d8ad6dc11'
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / ns3 / classes / ipv4l3protocol.html
diff --git a/doc/sphinx/_build/html/_modules/nepi/resources/ns3/classes/ipv4l3protocol.html b/doc/sphinx/_build/html/_modules/nepi/resources/ns3/classes/ipv4l3protocol.html
new file mode 100644 (file)
index 0000000..94e5da6
--- /dev/null
@@ -0,0 +1,206 @@
+<!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/html; charset=utf-8" />
+    
+    <title>nepi.resources.ns3.classes.ipv4l3protocol &mdash; NEPI 3.2 documentation</title>
+    
+    <link rel="stylesheet" href="../../../../../_static/sphinxdoc.css" type="text/css" />
+    <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../../../../',
+        VERSION:     '3.2',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
+    <link rel="top" title="NEPI 3.2 documentation" href="../../../../../index.html" />
+    <link rel="up" title="Module code" href="../../../../index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
+          <li><a href="../../../../index.html" accesskey="U">Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../../../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <h1>Source code for nepi.resources.ns3.classes.ipv4l3protocol</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c">#    NEPI, a framework to manage network experiments</span>
+<span class="c">#    Copyright (C) 2014 INRIA</span>
+<span class="c">#</span>
+<span class="c">#    This program is free software: you can redistribute it and/or modify</span>
+<span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
+<span class="c">#    published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c">#    This program is distributed in the hope that it will be useful,</span>
+<span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<span class="c">#    GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c">#    You should have received a copy of the GNU General Public License</span>
+<span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+<span class="c">#</span>
+
+<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>
+<span class="kn">from</span> <span class="nn">nepi.execution.trace</span> <span class="kn">import</span> <span class="n">Trace</span><span class="p">,</span> <span class="n">TraceAttr</span>
+<span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">ResourceManager</span><span class="p">,</span> <span class="n">clsinit_copy</span><span class="p">,</span> \
+        <span class="n">ResourceState</span>
+<span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3ipv4l3protocol</span> <span class="kn">import</span> <span class="n">NS3BaseIpv4L3Protocol</span> 
+
+<span class="nd">@clsinit_copy</span>
+<div class="viewcode-block" id="NS3Ipv4L3Protocol"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.ns3.classes.html#nepi.resources.ns3.classes.ipv4l3protocol.NS3Ipv4L3Protocol">[docs]</a><span class="k">class</span> <span class="nc">NS3Ipv4L3Protocol</span><span class="p">(</span><span class="n">NS3BaseIpv4L3Protocol</span><span class="p">):</span>
+    <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;ns3::Ipv4L3Protocol&quot;</span>
+
+    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
+        
+        <span class="n">attr_defaulttos</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;DefaultTos&quot;</span><span class="p">,</span>
+            <span class="s">&quot;The TOS value set by default on all outgoing packets generated on this node.&quot;</span><span class="p">,</span>
+            <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span>
+            <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>  
+            <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+            <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>    
+            <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Reserved</span> <span class="o">|</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Construct</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_defaulttos</span><span class="p">)</span>
+
+        <span class="n">attr_defaultttl</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;DefaultTtl&quot;</span><span class="p">,</span>
+            <span class="s">&quot;The TTL value set by default on all outgoing packets generated on this node.&quot;</span><span class="p">,</span>
+            <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span>
+            <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;64&quot;</span><span class="p">,</span>  
+            <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+            <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>    
+            <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Reserved</span> <span class="o">|</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Construct</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_defaultttl</span><span class="p">)</span>
+
+        <span class="n">attr_fragmentexpirationtimeout</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;FragmentExpirationTimeout&quot;</span><span class="p">,</span>
+            <span class="s">&quot;When this timeout expires, the fragments will be cleared from the buffer.&quot;</span><span class="p">,</span>
+            <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">String</span><span class="p">,</span>
+            <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;+30000000000.0ns&quot;</span><span class="p">,</span>  
+            <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+            <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>    
+            <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Reserved</span> <span class="o">|</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Construct</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_fragmentexpirationtimeout</span><span class="p">)</span>
+
+        <span class="n">attr_ipforward</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;IpForward&quot;</span><span class="p">,</span>
+            <span class="s">&quot;Globally enable or disable IP forwarding for all current and future Ipv4 devices.&quot;</span><span class="p">,</span>
+            <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
+            <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;True&quot;</span><span class="p">,</span>  
+            <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+            <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>    
+            <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Reserved</span> <span class="o">|</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Construct</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_ipforward</span><span class="p">)</span>
+
+        <span class="n">attr_weakesmodel</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;WeakEsModel&quot;</span><span class="p">,</span>
+            <span class="s">&quot;RFC1122 term for whether host accepts datagram with a dest. address on another interface&quot;</span><span class="p">,</span>
+            <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
+            <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;True&quot;</span><span class="p">,</span>  
+            <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+            <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>    
+            <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Reserved</span> <span class="o">|</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Construct</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_weakesmodel</span><span class="p">)</span>
+
+
+
+    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">_register_traces</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
+        
+        <span class="n">tx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;Tx&quot;</span><span class="p">,</span> <span class="s">&quot;Send ipv4 packet to outgoing interface.&quot;</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">tx</span><span class="p">)</span>
+
+        <span class="n">rx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;Rx&quot;</span><span class="p">,</span> <span class="s">&quot;Receive ipv4 packet from incoming interface.&quot;</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">rx</span><span class="p">)</span>
+
+        <span class="n">drop</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;Drop&quot;</span><span class="p">,</span> <span class="s">&quot;Drop ipv4 packet&quot;</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">drop</span><span class="p">)</span>
+
+        <span class="n">sendoutgoing</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;SendOutgoing&quot;</span><span class="p">,</span> <span class="s">&quot;A newly-generated packet by this node is about to be queued for transmission&quot;</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">sendoutgoing</span><span class="p">)</span>
+
+        <span class="n">unicastforward</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;UnicastForward&quot;</span><span class="p">,</span> <span class="s">&quot;A unicast IPv4 packet was received by this node and is being forwarded to another node&quot;</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">unicastforward</span><span class="p">)</span>
+
+        <span class="n">localdeliver</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;LocalDeliver&quot;</span><span class="p">,</span> <span class="s">&quot;An IPv4 packet was received by/for this node, and it is being forward up the stack&quot;</span><span class="p">)</span>
+
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">localdeliver</span><span class="p">)</span>
+
+
+
+    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
+        <span class="nb">super</span><span class="p">(</span><span class="n">NS3Ipv4L3Protocol</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ns3-ipv4l3protocol-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span></div>
+</pre></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
+          <li><a href="../../../../index.html" >Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+    </div>
+  </body>
+</html>
\ No newline at end of file