Merge commit '655eefc07db57c1d21cbf11487876c7d8ad6dc11'
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / linux / ns3 / ccn / ns3ccndceapplication.html
diff --git a/doc/sphinx/_build/html/_modules/nepi/resources/linux/ns3/ccn/ns3ccndceapplication.html b/doc/sphinx/_build/html/_modules/nepi/resources/linux/ns3/ccn/ns3ccndceapplication.html
new file mode 100644 (file)
index 0000000..516ec61
--- /dev/null
@@ -0,0 +1,198 @@
+<!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.linux.ns3.ccn.ns3ccndceapplication &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.linux.ns3.ccn.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.ns3ccndceapplication</span> <span class="kn">import</span> <span class="n">NS3BaseCCNDceApplication</span>
+
+<span class="nd">@clsinit_copy</span>
+<div class="viewcode-block" id="LinuxNS3CCNDceApplication"><a class="viewcode-back" href="../../../../../../_layout/nepi.resources.linux.ns3.ccn.html#nepi.resources.linux.ns3.ccn.ns3ccndceapplication.LinuxNS3CCNDceApplication">[docs]</a><span class="k">class</span> <span class="nc">LinuxNS3CCNDceApplication</span><span class="p">(</span><span class="n">NS3BaseCCNDceApplication</span><span class="p">):</span>
+    <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::ns3::dce::CCNApplication&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">sources</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;sources&quot;</span><span class="p">,</span>
+                <span class="s">&quot;Path to tar.gz file with sources for the application execute in DCE. &quot;</span>
+                <span class="s">&quot;Sources will be uploaded to ${SRC} and it is the responsibility of &quot;</span>
+                <span class="s">&quot;the build instructions (in the build attribute) to copy the compiled &quot;</span>
+                <span class="s">&quot;binaries to the ${BIN_DCE} directory&quot;</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">Design</span><span class="p">)</span>
+
+        <span class="n">build</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;build&quot;</span><span class="p">,</span>
+                <span class="s">&quot;Instructions to compile sources DCE-compatible way. &quot;</span>
+                <span class="s">&quot;Note that sources will be uploaded to ${SRC} and the &quot;</span>
+                <span class="s">&quot;build instructions are responsible for copying the &quot;</span>
+                <span class="s">&quot;binaries to the ${BIN_DCE} directory. &quot;</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">Design</span><span class="p">)</span>
+
+        <span class="n">depends</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">,</span> 
+                <span class="s">&quot;Space-separated list of packages required to run the application&quot;</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">Design</span><span class="p">)</span>
+
+        <span class="n">files</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;files&quot;</span><span class="p">,</span> 
+                <span class="s">&quot;Semi-colon separated list of &#39;key=value&#39; pairs to set as &quot;</span>
+                <span class="s">&quot;DCE files (AddFile). The key should be a path to a local file &quot;</span>
+                <span class="s">&quot;and the key is the path to be set in DCE for that file&quot;</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">Design</span><span class="p">)</span>
+
+        <span class="n">stdinfile</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;stdinFile&quot;</span><span class="p">,</span> 
+                <span class="s">&quot;File to set as StdinFile. The value shoudl be either an empty &quot;</span>
+                <span class="s">&quot;or a path to a local file &quot;</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">Design</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">sources</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">build</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">depends</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">files</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">stdinfile</span><span class="p">)</span>
+
+    <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="n">command</span> <span class="o">=</span> <span class="p">[]</span>
+
+        <span class="c"># Install package dependencies required to run the binary </span>
+        <span class="n">depends</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;depends&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">depends</span><span class="p">:</span>
+            <span class="n">dcmd</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">install_dependencies</span><span class="p">(</span><span class="n">depends</span> <span class="o">=</span> <span class="n">depends</span><span class="p">)</span>
+            <span class="k">if</span> <span class="n">dcmd</span><span class="p">:</span>
+                <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dcmd</span><span class="p">)</span>
+       
+        <span class="c"># Upload sources to generate the binary</span>
+        <span class="n">sources</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;sources&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">sources</span><span class="p">:</span>
+            <span class="n">scmd</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">upload_extra_sources</span><span class="p">(</span><span class="n">sources</span> <span class="o">=</span> <span class="n">sources</span><span class="p">)</span>
+            <span class="k">if</span> <span class="n">scmd</span><span class="p">:</span>
+                <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">scmd</span><span class="p">)</span>
+                
+        <span class="c"># Upload instructions to build the binary</span>
+        <span class="n">build</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;build&quot;</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">build</span><span class="p">:</span>
+            <span class="n">bcmd</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">build</span><span class="p">(</span><span class="n">build</span> <span class="o">=</span> <span class="n">build</span><span class="p">)</span>
+            <span class="k">if</span> <span class="n">bcmd</span><span class="p">:</span>
+                <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">bcmd</span><span class="p">)</span>
+
+        <span class="c"># Upload CCN files (e.g. repo)</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="n">upload</span> <span class="o">=</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">localpath</span><span class="p">,</span> <span class="n">dcepath</span> <span class="o">=</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">upload</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">localpath</span><span class="p">)</span>
+
+            <span class="n">sources</span> <span class="o">=</span> <span class="s">&quot;;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">upload</span><span class="p">)</span>
+            <span class="n">fcmd</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">upload_extra_sources</span><span class="p">(</span><span class="n">sources</span> <span class="o">=</span> <span class="n">sources</span><span class="p">,</span>
+                    <span class="n">src_dir</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">app_home</span><span class="p">)</span>
+
+            <span class="k">if</span> <span class="n">fcmd</span><span class="p">:</span>
+                <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fcmd</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="n">command</span><span class="p">:</span>
+            <span class="n">deploy_command</span> <span class="o">=</span> <span class="s">&quot;;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+            <span class="n">prefix</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%d</span><span class="s">_deploy&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span> 
+            <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">execute_deploy_command</span><span class="p">(</span><span class="n">deploy_command</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="n">prefix</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.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