doc/sphinx/_build/html/_modules/nepi/resources/ns3/classes/fd_net_device.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.ns3.classes.fd_net_device &mdash; NEPI 3.2 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.2',
  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.2 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.2 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.ns3.classes.fd_net_device</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) 2014 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
  84 <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>
  85 <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>
  86 <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> \
  87         <span class="n">ResourceState</span>
  88 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3fdnetdevice</span> <span class="kn">import</span> <span class="n">NS3BaseFdNetDevice</span>
  89
  90 <span class="nd">@clsinit_copy</span>
  91 <div class="viewcode-block" id="NS3FdNetDevice"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.ns3.classes.html#nepi.resources.ns3.classes.fd_net_device.NS3FdNetDevice">[docs]</a><span class="k">class</span> <span class="nc">NS3FdNetDevice</span><span class="p">(</span><span class="n">NS3BaseFdNetDevice</span><span class="p">):</span>
  92     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;ns3::FdNetDevice&quot;</span>
  93
  94     <span class="nd">@classmethod</span>
  95     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
  96
  97         <span class="n">attr_address</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;Address&quot;</span><span class="p">,</span>
  98             <span class="s">&quot;The MAC address of this device.&quot;</span><span class="p">,</span>
  99             <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>
 100             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;ff:ff:ff:ff:ff:ff&quot;</span><span class="p">,</span>
 101             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 102             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 103             <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>
 104
 105         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_address</span><span class="p">)</span>
 106
 107         <span class="n">attr_start</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;Start&quot;</span><span class="p">,</span>
 108             <span class="s">&quot;The simulation time at which to spin up the device thread.&quot;</span><span class="p">,</span>
 109             <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>
 110             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;+0.0ns&quot;</span><span class="p">,</span>
 111             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 112             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 113             <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>
 114
 115         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_start</span><span class="p">)</span>
 116
 117         <span class="n">attr_stop</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;Stop&quot;</span><span class="p">,</span>
 118             <span class="s">&quot;The simulation time at which to tear down the device thread.&quot;</span><span class="p">,</span>
 119             <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>
 120             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;+0.0ns&quot;</span><span class="p">,</span>
 121             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 122             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 123             <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>
 124
 125         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_stop</span><span class="p">)</span>
 126
 127         <span class="n">attr_encapsulationmode</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;EncapsulationMode&quot;</span><span class="p">,</span>
 128             <span class="s">&quot;The link-layer encapsulation type to use.&quot;</span><span class="p">,</span>
 129             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Enumerate</span><span class="p">,</span>
 130             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;Dix&quot;</span><span class="p">,</span>
 131             <span class="n">allowed</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;Dix&quot;</span><span class="p">,</span><span class="s">&quot;Llc&quot;</span><span class="p">,</span><span class="s">&quot;DixPi&quot;</span><span class="p">],</span>
 132             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 133             <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>
 134
 135         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_encapsulationmode</span><span class="p">)</span>
 136
 137         <span class="n">attr_rxqueuesize</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;RxQueueSize&quot;</span><span class="p">,</span>
 138             <span class="s">&quot;Maximum size of the read queue.  This value limits number of packets that have been read from the network into a memory buffer but have not yet been processed by the simulator.&quot;</span><span class="p">,</span>
 139             <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>
 140             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;1000&quot;</span><span class="p">,</span>
 141             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 142             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 143             <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>
 144
 145         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_rxqueuesize</span><span class="p">)</span>
 146
 147
 148
 149     <span class="nd">@classmethod</span>
 150     <span class="k">def</span> <span class="nf">_register_traces</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
 151
 152         <span class="n">mactx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;MacTx&quot;</span><span class="p">,</span> <span class="s">&quot;Trace source indicating a packet has arrived for transmission by this device&quot;</span><span class="p">)</span>
 153
 154         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">mactx</span><span class="p">)</span>
 155
 156         <span class="n">mactxdrop</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;MacTxDrop&quot;</span><span class="p">,</span> <span class="s">&quot;Trace source indicating a packet has been dropped by the device before transmission&quot;</span><span class="p">)</span>
 157
 158         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">mactxdrop</span><span class="p">)</span>
 159
 160         <span class="n">macpromiscrx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;MacPromiscRx&quot;</span><span class="p">,</span> <span class="s">&quot;A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a promiscuous trace,&quot;</span><span class="p">)</span>
 161
 162         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">macpromiscrx</span><span class="p">)</span>
 163
 164         <span class="n">macrx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;MacRx&quot;</span><span class="p">,</span> <span class="s">&quot;A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a non-promiscuous trace,&quot;</span><span class="p">)</span>
 165
 166         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">macrx</span><span class="p">)</span>
 167
 168         <span class="n">sniffer</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;Sniffer&quot;</span><span class="p">,</span> <span class="s">&quot;Trace source simulating a non-promiscuous packet sniffer attached to the device&quot;</span><span class="p">)</span>
 169
 170         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">sniffer</span><span class="p">)</span>
 171
 172         <span class="n">promiscsniffer</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;PromiscSniffer&quot;</span><span class="p">,</span> <span class="s">&quot;Trace source simulating a promiscuous packet sniffer attached to the device&quot;</span><span class="p">)</span>
 173
 174         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">promiscsniffer</span><span class="p">)</span>
 175
 176
 177
 178     <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>
 179         <span class="nb">super</span><span class="p">(</span><span class="n">NS3FdNetDevice</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>
 180         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ns3-fd-net-device-</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>
 181 </pre></div>
 182
 183           </div>
 184         </div>
 185       </div>
 186       <div class="clearer"></div>
 187     </div>
 188     <div class="related">
 189       <h3>Navigation</h3>
 190       <ul>
 191         <li class="right" style="margin-right: 10px">
 192           <a href="../../../../../genindex.html" title="General Index"
 193              >index</a></li>
 194         <li class="right" >
 195           <a href="../../../../../py-modindex.html" title="Python Module Index"
 196              >modules</a> |</li>
 197         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 198           <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
 199       </ul>
 200     </div>
 201     <div class="footer">
 202         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 203       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 204     </div>
 205   </body>
 206 </html>