update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / ns3 / ns3ccndceapplication.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.ns3ccndceapplication &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.ns3ccndceapplication</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">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>
86 <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>
87 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3dceapplication</span> <span class="kn">import</span> <span class="n">NS3BaseDceApplication</span>
88
89 <span class="kn">import</span> <span class="nn">os</span>
90 <span class="kn">import</span> <span class="nn">threading</span>
91
92 <span class="nd">@clsinit_copy</span>
93 <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>
94     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;abstract::ns3::CCNDceApplication&quot;</span>
95
96     <span class="c"># Lock used to synchronize usage of CcnClientHelper </span>
97     <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>
98     <span class="n">_ccn_client_helper_uuid</span> <span class="o">=</span> <span class="bp">None</span>
99
100     <span class="nd">@property</span>
101 <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>
102         <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>
103             <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>
104         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ccn_client_helper_uuid</span>
105 </div>
106     <span class="k">def</span> <span class="nf">_instantiate_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
107         <span class="k">pass</span>
108
109     <span class="k">def</span> <span class="nf">_connect_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
110         <span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span>
111         <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>
112             <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>
113
114             <span class="c"># Preventing concurrent access to the DceApplicationHelper</span>
115             <span class="c"># from different DceApplication RMs</span>
116             <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>
117                 <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>
118                         <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
119                         <span class="s">&quot;ResetArguments&quot;</span><span class="p">)</span> 
120
121                 <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>
122                         <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
123                         <span class="s">&quot;ResetEnvironment&quot;</span><span class="p">)</span> 
124
125                 <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>
126                         <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
127                         <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> 
128
129                 <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>
130                         <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
131                         <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> 
132
133                 <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>
134                 <span class="k">if</span> <span class="n">arguments</span><span class="p">:</span>
135                     <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>
136                         <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>
137                                  <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
138                                 <span class="s">&quot;AddArgument&quot;</span><span class="p">,</span> <span class="n">arg</span><span class="p">)</span>
139
140                 <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>
141                 <span class="k">if</span> <span class="n">environment</span><span class="p">:</span>
142                     <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>
143                         <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>
144                         <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>
145                                 <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
146                                <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>
147
148                 <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>
149                     <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>
150                     <span class="k">if</span> <span class="n">files</span><span class="p">:</span>
151                         <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>
152                             <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>
153                             <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> 
154                                     <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>
155                             <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>
156                                     <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
157                                     <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>
158
159                 <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>
160                     <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>
161                     <span class="k">if</span> <span class="n">stdinfile</span><span class="p">:</span>
162                         <span class="c"># stdinfile might be an empty text that should be set as</span>
163                         <span class="c"># stdin</span>
164                         <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>
165                                 <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
166                                 <span class="s">&quot;SetStdinFile&quot;</span><span class="p">,</span> <span class="n">stdinfile</span><span class="p">)</span>
167
168                 <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>
169                         <span class="bp">self</span><span class="o">.</span><span class="n">ccn_client_helper_uuid</span><span class="p">,</span> 
170                         <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>
171
172                 <span class="sd">&quot;&quot;&quot;</span>
173 <span class="sd">                container_uuid = self.simulation.create(&quot;NodeContainer&quot;)</span>
174 <span class="sd">                self.simulation.invoke(container_uuid, &quot;Add&quot;, self.node.uuid)</span>
175 <span class="sd">                apps_uuid = self.simulation.invoke(</span>
176 <span class="sd">                        self.ccn_client_helper_uuid, </span>
177 <span class="sd">                        &quot;Install&quot;, container_uuid)</span>
178 <span class="sd">                &quot;&quot;&quot;</span>
179
180             <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>
181
182             <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>
183                 <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>
184
185             <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>
186                 <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>
187 </pre></div></div>
188
189           </div>
190         </div>
191       </div>
192       <div class="clearer"></div>
193     </div>
194     <div class="related">
195       <h3>Navigation</h3>
196       <ul>
197         <li class="right" style="margin-right: 10px">
198           <a href="../../../../genindex.html" title="General Index"
199              >index</a></li>
200         <li class="right" >
201           <a href="../../../../py-modindex.html" title="Python Module Index"
202              >modules</a> |</li>
203         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
204           <li><a href="../../../index.html" >Module code</a> &raquo;</li> 
205       </ul>
206     </div>
207     <div class="footer">
208         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
209       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
210     </div>
211   </body>
212 </html>