add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / ns3 / ns3ccndceapplication.html
diff --git a/doc/sphinx/_build/html/_modules/nepi/resources/ns3/ns3ccndceapplication.html b/doc/sphinx/_build/html/_modules/nepi/resources/ns3/ns3ccndceapplication.html
new file mode 100644 (file)
index 0000000..273de63
--- /dev/null
@@ -0,0 +1,212 @@
+<!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.ns3ccndceapplication &mdash; NEPI 3.0 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.0',
+        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.0 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.0 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.ns3ccndceapplication</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="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</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.resource</span> <span class="kn">import</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.ns3dceapplication</span> <span class="kn">import</span> <span class="n">NS3BaseDceApplication</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">threading</span>
+
+<span class="nd">@clsinit_copy</span>
+<div class="viewcode-block" id="NS3BaseCCNDceApplication"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3ccndceapplication.NS3BaseCCNDceApplication">[docs]</a><span class="k">class</span> <span class="nc">NS3BaseCCNDceApplication</span><span class="p">(</span><span class="n">NS3BaseDceApplication</span><span class="p">):</span>
+    <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;abstract::ns3::CCNDceApplication&quot;</span>
+
+    <span class="c"># Lock used to synchronize usage of CcnClientHelper </span>
+    <span class="n">ccn_client_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
+    <span class="n">_ccn_client_helper_uuid</span> <span class="o">=</span> <span class="bp">None</span>
+
+    <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3BaseCCNDceApplication.ccn_client_helper_uuid"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3ccndceapplication.NS3BaseCCNDceApplication.ccn_client_helper_uuid">[docs]</a>    <span class="k">def</span> <span class="nf">ccn_client_helper_uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ccn_client_helper_uuid</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_ccn_client_helper_uuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="s">&quot;CcnClientHelper&quot;</span><span class="p">)</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ccn_client_helper_uuid</span>
+</div>
+    <span class="k">def</span> <span class="nf">_instantiate_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">pass</span>
+
+    <span class="k">def</span> <span class="nf">_connect_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span>
+        <span class="k">if</span> <span class="n">node</span><span class="o">.</span><span class="n">uuid</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_connected</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">uuid</span><span class="p">)</span>
+
+            <span class="c"># Preventing concurrent access to the DceApplicationHelper</span>
+            <span class="c"># from different DceApplication RMs</span>
+            <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_lock</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                        <span class="s">&quot;ResetArguments&quot;</span><span class="p">)</span> 
+
+                <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                        <span class="s">&quot;ResetEnvironment&quot;</span><span class="p">)</span> 
+
+                <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                        <span class="s">&quot;SetBinary&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;binary&quot;</span><span class="p">))</span> 
+
+                <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                        <span class="s">&quot;SetStackSize&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;stackSize&quot;</span><span class="p">))</span> 
+
+                <span class="n">arguments</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;arguments&quot;</span><span class="p">)</span>
+                <span class="k">if</span> <span class="n">arguments</span><span class="p">:</span>
+                    <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">strip</span><span class="p">,</span> <span class="n">arguments</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;;&quot;</span><span class="p">)):</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                                 <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                                <span class="s">&quot;AddArgument&quot;</span><span class="p">,</span> <span class="n">arg</span><span class="p">)</span>
+
+                <span class="n">environment</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;environment&quot;</span><span class="p">)</span>
+                <span class="k">if</span> <span class="n">environment</span><span class="p">:</span>
+                    <span class="k">for</span> <span class="n">env</span> <span class="ow">in</span> <span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">strip</span><span class="p">,</span> <span class="n">environment</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;;&quot;</span><span class="p">)):</span>
+                        <span class="n">key</span><span class="p">,</span> <span class="n">val</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;=&quot;</span><span class="p">)</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                                <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                               <span class="s">&quot;AddEnvironment&quot;</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
+
+                <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_attribute</span><span class="p">(</span><span class="s">&quot;files&quot;</span><span class="p">):</span>
+                    <span class="n">files</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;files&quot;</span><span class="p">)</span>
+                    <span class="k">if</span> <span class="n">files</span><span class="p">:</span>
+                        <span class="k">for</span> <span class="nb">file</span> <span class="ow">in</span> <span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="o">.</span><span class="n">strip</span><span class="p">,</span> <span class="n">files</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;;&quot;</span><span class="p">)):</span>
+                            <span class="n">remotepath</span><span class="p">,</span> <span class="n">dcepath</span> <span class="o">=</span> <span class="nb">file</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;=&quot;</span><span class="p">)</span>
+                            <span class="n">localpath</span> <span class="o">=</span>  <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">app_home</span><span class="p">,</span> 
+                                    <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">remotepath</span><span class="p">))</span>
+                            <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                                    <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                                    <span class="s">&quot;AddFile&quot;</span><span class="p">,</span> <span class="n">localpath</span><span class="p">,</span> <span class="n">dcepath</span><span class="p">)</span>
+
+                <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_attribute</span><span class="p">(</span><span class="s">&quot;stdinFile&quot;</span><span class="p">):</span>
+                    <span class="n">stdinfile</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;stdinFile&quot;</span><span class="p">)</span>
+                    <span class="k">if</span> <span class="n">stdinfile</span><span class="p">:</span>
+                        <span class="c"># stdinfile might be an empty text that should be set as</span>
+                        <span class="c"># stdin</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                                <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                                <span class="s">&quot;SetStdinFile&quot;</span><span class="p">,</span> <span class="n">stdinfile</span><span class="p">)</span>
+
+                <span class="n">apps_uuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                        <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
+                        <span class="s">&quot;InstallInNode&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">uuid</span><span class="p">)</span>
+
+                <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">                container_uuid = self.simulation.create(&quot;NodeContainer&quot;)</span>
+<span class="sd">                self.simulation.invoke(container_uuid, &quot;Add&quot;, self.node.uuid)</span>
+<span class="sd">                apps_uuid = self.simulation.invoke(</span>
+<span class="sd">                        self.ccn_client_helper_uuid, </span>
+<span class="sd">                        &quot;Install&quot;, container_uuid)</span>
+<span class="sd">                &quot;&quot;&quot;</span>
+
+            <span class="bp">self</span><span class="o">.</span><span class="n">_uuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="n">apps_uuid</span><span class="p">,</span> <span class="s">&quot;Get&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
+
+            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_changed</span><span class="p">(</span><span class="s">&quot;StartTime&quot;</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">ns3_set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span> <span class="s">&quot;StartTime&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;StartTime&quot;</span><span class="p">))</span>
+
+            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_changed</span><span class="p">(</span><span class="s">&quot;StopTime&quot;</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">ns3_set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span> <span class="s">&quot;StopTime&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;StopTime&quot;</span><span class="p">))</span>
+</pre></div></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.0 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