doc/sphinx/_build/html/_modules/nepi/resources/ns3/ns3server.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.ns3server &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.ns3server</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 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84
  85 <span class="kn">import</span> <span class="nn">base64</span>
  86 <span class="kn">import</span> <span class="nn">cPickle</span>
  87 <span class="kn">import</span> <span class="nn">errno</span>
  88 <span class="kn">import</span> <span class="nn">logging</span>
  89 <span class="kn">import</span> <span class="nn">os</span>
  90 <span class="kn">import</span> <span class="nn">socket</span>
  91 <span class="kn">import</span> <span class="nn">sys</span>
  92
  93 <span class="kn">from</span> <span class="nn">optparse</span> <span class="kn">import</span> <span class="n">OptionParser</span><span class="p">,</span> <span class="n">SUPPRESS_HELP</span>
  94
  95 <span class="kn">from</span> <span class="nn">ns3wrapper</span> <span class="kn">import</span> <span class="n">NS3Wrapper</span>
  96
  97 <div class="viewcode-block" id="NS3WrapperMessage"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.NS3WrapperMessage">[docs]</a><span class="k">class</span> <span class="nc">NS3WrapperMessage</span><span class="p">:</span>
  98     <span class="n">CREATE</span> <span class="o">=</span> <span class="s">&quot;CREATE&quot;</span>
  99     <span class="n">FACTORY</span> <span class="o">=</span> <span class="s">&quot;FACTORY&quot;</span>
 100     <span class="n">INVOKE</span> <span class="o">=</span> <span class="s">&quot;INVOKE&quot;</span>
 101     <span class="n">SET</span> <span class="o">=</span> <span class="s">&quot;SET&quot;</span>
 102     <span class="n">GET</span> <span class="o">=</span> <span class="s">&quot;GET&quot;</span>
 103     <span class="n">FLUSH</span> <span class="o">=</span> <span class="s">&quot;FLUSH&quot;</span>
 104     <span class="n">START</span> <span class="o">=</span> <span class="s">&quot;START&quot;</span>
 105     <span class="n">STOP</span> <span class="o">=</span> <span class="s">&quot;STOP&quot;</span>
 106     <span class="n">SHUTDOWN</span> <span class="o">=</span> <span class="s">&quot;SHUTDOWN&quot;</span>
 107 </div>
 108 <div class="viewcode-block" id="handle_message"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.handle_message">[docs]</a><span class="k">def</span> <span class="nf">handle_message</span><span class="p">(</span><span class="n">ns3_wrapper</span><span class="p">,</span> <span class="n">msg_type</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">):</span>
 109     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">SHUTDOWN</span><span class="p">:</span>
 110         <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
 111
 112         <span class="k">return</span> <span class="s">&quot;BYEBYE&quot;</span>
 113
 114     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">STOP</span><span class="p">:</span>
 115         <span class="n">time</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;time&quot;</span><span class="p">)</span>
 116
 117         <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">stop</span><span class="p">(</span><span class="n">time</span><span class="o">=</span><span class="n">time</span><span class="p">)</span>
 118
 119         <span class="k">return</span> <span class="s">&quot;STOPPED&quot;</span>
 120
 121     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">START</span><span class="p">:</span>
 122         <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
 123
 124         <span class="k">return</span> <span class="s">&quot;STARTED&quot;</span>
 125
 126     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">CREATE</span><span class="p">:</span>
 127         <span class="n">clazzname</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 128
 129         <span class="k">return</span> <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">clazzname</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>
 130
 131     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">FACTORY</span><span class="p">:</span>
 132         <span class="n">type_name</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 133
 134         <span class="k">return</span> <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">factory</span><span class="p">(</span><span class="n">type_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 135
 136     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">INVOKE</span><span class="p">:</span>
 137         <span class="n">uuid</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 138         <span class="n">operation</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 139
 140         <span class="k">return</span> <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
 141
 142     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">GET</span><span class="p">:</span>
 143         <span class="n">uuid</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 144         <span class="n">name</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 145
 146         <span class="k">return</span> <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
 147
 148     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">SET</span><span class="p">:</span>
 149         <span class="n">uuid</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 150         <span class="n">name</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 151         <span class="n">value</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 152
 153         <span class="k">return</span> <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 154
 155     <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">FLUSH</span><span class="p">:</span>
 156         <span class="c"># Forces flushing output and error streams.</span>
 157         <span class="c"># NS-3 output will stay unflushed until the program exits or </span>
 158         <span class="c"># explicit invocation flush is done</span>
 159         <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
 160         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
 161
 162         <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;FLUSHED&quot;</span><span class="p">)</span>
 163
 164         <span class="k">return</span> <span class="s">&quot;FLUSHED&quot;</span>
 165 </div>
 166 <div class="viewcode-block" id="open_socket"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.open_socket">[docs]</a><span class="k">def</span> <span class="nf">open_socket</span><span class="p">(</span><span class="n">socket_name</span><span class="p">):</span>
 167     <span class="n">sock</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_UNIX</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">SOCK_STREAM</span><span class="p">)</span>
 168     <span class="n">sock</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="n">socket_name</span><span class="p">)</span>
 169     <span class="k">return</span> <span class="n">sock</span>
 170 </div>
 171 <div class="viewcode-block" id="close_socket"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.close_socket">[docs]</a><span class="k">def</span> <span class="nf">close_socket</span><span class="p">(</span><span class="n">sock</span><span class="p">):</span>
 172     <span class="k">try</span><span class="p">:</span>
 173         <span class="n">sock</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 174     <span class="k">except</span><span class="p">:</span>
 175         <span class="k">pass</span>
 176 </div>
 177 <div class="viewcode-block" id="recv_msg"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.recv_msg">[docs]</a><span class="k">def</span> <span class="nf">recv_msg</span><span class="p">(</span><span class="n">conn</span><span class="p">):</span>
 178     <span class="n">msg</span> <span class="o">=</span> <span class="p">[]</span>
 179     <span class="n">chunk</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
 180
 181     <span class="k">while</span> <span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">chunk</span><span class="p">:</span>
 182         <span class="k">try</span><span class="p">:</span>
 183             <span class="n">chunk</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">recv</span><span class="p">(</span><span class="mi">1024</span><span class="p">)</span>
 184         <span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">),</span> <span class="n">e</span><span class="p">:</span>
 185             <span class="k">if</span> <span class="n">e</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EINTR</span><span class="p">:</span>
 186                 <span class="k">raise</span>
 187             <span class="c"># Ignore eintr errors</span>
 188             <span class="k">continue</span>
 189
 190         <span class="k">if</span> <span class="n">chunk</span><span class="p">:</span>
 191             <span class="n">msg</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
 192         <span class="k">else</span><span class="p">:</span>
 193             <span class="c"># empty chunk = EOF</span>
 194             <span class="k">break</span>
 195
 196     <span class="n">msg</span> <span class="o">=</span> <span class="s">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 197
 198     <span class="c"># The message is formatted as follows:</span>
 199     <span class="c">#   MESSAGE_TYPE|args|kwargs</span>
 200     <span class="c">#</span>
 201     <span class="c">#   where MESSAGE_TYPE, args and kwargs are pickld and enoded in base64</span>
 202
 203     <span class="k">def</span> <span class="nf">decode</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
 204         <span class="n">item</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64decode</span><span class="p">(</span><span class="n">item</span><span class="p">)</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>
 205         <span class="k">return</span> <span class="n">cPickle</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
 206
 207     <span class="n">decoded</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="n">decode</span><span class="p">,</span> <span class="n">msg</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;|&quot;</span><span class="p">))</span>
 208
 209     <span class="c"># decoded message</span>
 210     <span class="n">dmsg_type</span> <span class="o">=</span> <span class="n">decoded</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 211     <span class="n">dargs</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">decoded</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span> <span class="c"># transforming touple into list</span>
 212     <span class="n">dkwargs</span> <span class="o">=</span> <span class="n">decoded</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 213
 214     <span class="k">return</span> <span class="p">(</span><span class="n">dmsg_type</span><span class="p">,</span> <span class="n">dargs</span><span class="p">,</span> <span class="n">dkwargs</span><span class="p">)</span>
 215 </div>
 216 <div class="viewcode-block" id="send_reply"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.send_reply">[docs]</a><span class="k">def</span> <span class="nf">send_reply</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">reply</span><span class="p">):</span>
 217     <span class="n">encoded</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="n">cPickle</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">reply</span><span class="p">))</span>
 218     <span class="n">conn</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="s">&quot;</span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">encoded</span><span class="p">)</span>
 219 </div>
 220 <div class="viewcode-block" id="get_options"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.get_options">[docs]</a><span class="k">def</span> <span class="nf">get_options</span><span class="p">():</span>
 221     <span class="n">usage</span> <span class="o">=</span> <span class="p">(</span><span class="s">&quot;usage: %prog -S &lt;socket-name&gt; -L &lt;ns-log&gt;  -D &lt;enable-dump&gt; -v &quot;</span><span class="p">)</span>
 222
 223     <span class="n">parser</span> <span class="o">=</span> <span class="n">OptionParser</span><span class="p">(</span><span class="n">usage</span> <span class="o">=</span> <span class="n">usage</span><span class="p">)</span>
 224
 225     <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">&quot;-S&quot;</span><span class="p">,</span> <span class="s">&quot;--socket-name&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s">&quot;socket_name&quot;</span><span class="p">,</span>
 226         <span class="n">help</span> <span class="o">=</span> <span class="s">&quot;Name for the unix socket used to interact with this process&quot;</span><span class="p">,</span>
 227         <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;tap.sock&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s">&quot;str&quot;</span><span class="p">)</span>
 228
 229     <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">&quot;-L&quot;</span><span class="p">,</span> <span class="s">&quot;--ns-log&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s">&quot;ns_log&quot;</span><span class="p">,</span>
 230         <span class="n">help</span> <span class="o">=</span> <span class="s">&quot;NS_LOG environmental variable to be set&quot;</span><span class="p">,</span>
 231         <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s">&quot;str&quot;</span><span class="p">)</span>
 232
 233     <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">&quot;-D&quot;</span><span class="p">,</span> <span class="s">&quot;--enable-dump&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s">&quot;enable_dump&quot;</span><span class="p">,</span>
 234         <span class="n">help</span> <span class="o">=</span> <span class="s">&quot;Enable dumping the remote executed ns-3 commands to a script &quot;</span>
 235             <span class="s">&quot;in order to later reproduce and debug the experiment&quot;</span><span class="p">,</span>
 236         <span class="n">action</span> <span class="o">=</span> <span class="s">&quot;store_true&quot;</span><span class="p">,</span>
 237         <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
 238
 239     <span class="n">parser</span><span class="o">.</span><span class="n">add_option</span><span class="p">(</span><span class="s">&quot;-v&quot;</span><span class="p">,</span> <span class="s">&quot;--verbose&quot;</span><span class="p">,</span>
 240         <span class="n">help</span><span class="o">=</span><span class="s">&quot;Print debug output&quot;</span><span class="p">,</span>
 241         <span class="n">action</span><span class="o">=</span><span class="s">&quot;store_true&quot;</span><span class="p">,</span>
 242         <span class="n">dest</span><span class="o">=</span><span class="s">&quot;verbose&quot;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
 243
 244     <span class="p">(</span><span class="n">options</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
 245
 246     <span class="k">return</span> <span class="p">(</span><span class="n">options</span><span class="o">.</span><span class="n">socket_name</span><span class="p">,</span> <span class="n">options</span><span class="o">.</span><span class="n">verbose</span><span class="p">,</span> <span class="n">options</span><span class="o">.</span><span class="n">ns_log</span><span class="p">,</span>
 247             <span class="n">options</span><span class="o">.</span><span class="n">enable_dump</span><span class="p">)</span>
 248 </div>
 249 <div class="viewcode-block" id="run_server"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3server.run_server">[docs]</a><span class="k">def</span> <span class="nf">run_server</span><span class="p">(</span><span class="n">socket_name</span><span class="p">,</span> <span class="n">level</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span> <span class="n">ns_log</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 250         <span class="n">enable_dump</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
 251
 252     <span class="c"># Sets NS_LOG environmental variable for NS debugging</span>
 253     <span class="k">if</span> <span class="n">ns_log</span><span class="p">:</span>
 254         <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">&quot;NS_LOG&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ns_log</span>
 255
 256     <span class="c">###### ns-3 wrapper instantiation</span>
 257
 258     <span class="n">ns3_wrapper</span> <span class="o">=</span> <span class="n">NS3Wrapper</span><span class="p">(</span><span class="n">loglevel</span><span class="o">=</span><span class="n">level</span><span class="p">,</span> <span class="n">enable_dump</span> <span class="o">=</span> <span class="n">enable_dump</span><span class="p">)</span>
 259
 260     <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;STARTING...&quot;</span><span class="p">)</span>
 261
 262     <span class="c"># create unix socket to receive instructions</span>
 263     <span class="n">sock</span> <span class="o">=</span> <span class="n">open_socket</span><span class="p">(</span><span class="n">socket_name</span><span class="p">)</span>
 264     <span class="n">sock</span><span class="o">.</span><span class="n">listen</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
 265
 266     <span class="c"># wait for messages to arrive and process them</span>
 267     <span class="n">stop</span> <span class="o">=</span> <span class="bp">False</span>
 268
 269     <span class="k">while</span> <span class="ow">not</span> <span class="n">stop</span><span class="p">:</span>
 270         <span class="n">conn</span><span class="p">,</span> <span class="n">addr</span> <span class="o">=</span> <span class="n">sock</span><span class="o">.</span><span class="n">accept</span><span class="p">()</span>
 271         <span class="n">conn</span><span class="o">.</span><span class="n">settimeout</span><span class="p">(</span><span class="mi">30</span><span class="p">)</span>
 272
 273         <span class="k">try</span><span class="p">:</span>
 274             <span class="p">(</span><span class="n">msg_type</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span> <span class="o">=</span> <span class="n">recv_msg</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
 275         <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
 276             <span class="c"># Ingore time-out</span>
 277             <span class="n">close_socket</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
 278             <span class="k">continue</span>
 279
 280         <span class="k">if</span> <span class="ow">not</span> <span class="n">msg_type</span><span class="p">:</span>
 281             <span class="c"># Ignore - connection lost</span>
 282             <span class="n">close_socket</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
 283             <span class="k">continue</span>
 284
 285         <span class="k">if</span> <span class="n">msg_type</span> <span class="o">==</span> <span class="n">NS3WrapperMessage</span><span class="o">.</span><span class="n">SHUTDOWN</span><span class="p">:</span>
 286            <span class="n">stop</span> <span class="o">=</span> <span class="bp">True</span>
 287
 288         <span class="k">try</span><span class="p">:</span>
 289             <span class="n">reply</span> <span class="o">=</span> <span class="n">handle_message</span><span class="p">(</span><span class="n">ns3_wrapper</span><span class="p">,</span> <span class="n">msg_type</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
 290         <span class="k">except</span><span class="p">:</span>
 291             <span class="kn">import</span> <span class="nn">traceback</span>
 292             <span class="n">err</span> <span class="o">=</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">()</span>
 293             <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">err</span><span class="p">)</span>
 294             <span class="n">close_socket</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
 295             <span class="k">raise</span>
 296
 297         <span class="k">try</span><span class="p">:</span>
 298             <span class="n">send_reply</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">reply</span><span class="p">)</span>
 299         <span class="k">except</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">:</span>
 300             <span class="kn">import</span> <span class="nn">traceback</span>
 301             <span class="n">err</span> <span class="o">=</span> <span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">()</span>
 302             <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">err</span><span class="p">)</span>
 303             <span class="n">close_socket</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
 304             <span class="k">raise</span>
 305
 306         <span class="n">close_socket</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
 307
 308     <span class="n">close_socket</span><span class="p">(</span><span class="n">sock</span><span class="p">)</span>
 309
 310     <span class="n">ns3_wrapper</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;EXITING...&quot;</span><span class="p">)</span>
 311 </div>
 312 <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;__main__&#39;</span><span class="p">:</span>
 313
 314     <span class="p">(</span><span class="n">socket_name</span><span class="p">,</span> <span class="n">verbose</span><span class="p">,</span> <span class="n">ns_log</span><span class="p">,</span> <span class="n">enable_dump</span><span class="p">)</span> <span class="o">=</span> <span class="n">get_options</span><span class="p">()</span>
 315
 316     <span class="c">## configure logging</span>
 317     <span class="n">FORMAT</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%(asctime)s</span><span class="s"> </span><span class="si">%(name)s</span><span class="s"> </span><span class="si">%(levelname)-4s</span><span class="s"> </span><span class="si">%(message)s</span><span class="s">&quot;</span>
 318     <span class="n">level</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span> <span class="k">if</span> <span class="n">verbose</span> <span class="k">else</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span>
 319
 320     <span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">format</span> <span class="o">=</span> <span class="n">FORMAT</span><span class="p">,</span> <span class="n">level</span> <span class="o">=</span> <span class="n">level</span><span class="p">)</span>
 321
 322     <span class="c">## Run the server</span>
 323     <span class="n">run_server</span><span class="p">(</span><span class="n">socket_name</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">ns_log</span><span class="p">,</span> <span class="n">enable_dump</span><span class="p">)</span>
 324 </pre></div>
 325
 326           </div>
 327         </div>
 328       </div>
 329       <div class="clearer"></div>
 330     </div>
 331     <div class="related">
 332       <h3>Navigation</h3>
 333       <ul>
 334         <li class="right" style="margin-right: 10px">
 335           <a href="../../../../genindex.html" title="General Index"
 336              >index</a></li>
 337         <li class="right" >
 338           <a href="../../../../py-modindex.html" title="Python Module Index"
 339              >modules</a> |</li>
 340         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 341           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 342       </ul>
 343     </div>
 344     <div class="footer">
 345         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 346       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 347     </div>
 348   </body>
 349 </html>