update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / linux / ccn / ccnpingserver.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.linux.ccn.ccnpingserver &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.linux.ccn.ccnpingserver</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) 2013 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">ResourceManager</span><span class="p">,</span> <span class="n">clsinit_copy</span><span class="p">,</span> \
87         <span class="n">ResourceState</span>
88 <span class="kn">from</span> <span class="nn">nepi.resources.linux.ccn.ccnapplication</span> <span class="kn">import</span> <span class="n">LinuxCCNApplication</span>
89 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span><span class="p">,</span> <span class="n">tdiffsec</span>
90
91 <span class="kn">import</span> <span class="nn">os</span>
92
93 <span class="nd">@clsinit_copy</span>
94 <div class="viewcode-block" id="LinuxCCNPingServer"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccnpingserver.LinuxCCNPingServer">[docs]</a><span class="k">class</span> <span class="nc">LinuxCCNPingServer</span><span class="p">(</span><span class="n">LinuxCCNApplication</span><span class="p">):</span>
95     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::CCNPingServer&quot;</span>
96
97     <span class="nd">@classmethod</span>
98     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
99         <span class="n">daemon</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;d&quot;</span><span class="p">,</span>
100             <span class="s">&quot;Run ccnping server as a daemon in background&quot;</span><span class="p">,</span>
101             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
102             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
103             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
104
105         <span class="n">freshness</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;x&quot;</span><span class="p">,</span>
106             <span class="s">&quot;Set FreshnessSeconds&quot;</span><span class="p">,</span>
107             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span>
108             <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>
109
110         <span class="n">prefix</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;prefix&quot;</span><span class="p">,</span>
111             <span class="s">&quot;Prefix to serve content (e.g. ccnx:/name/prefix)&quot;</span><span class="p">,</span>
112             <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>
113
114         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">daemon</span><span class="p">)</span>
115         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">freshness</span><span class="p">)</span>
116         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span>
117
118     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
119         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxCCNPingServer</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
120         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ccnping-serv-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
121
122 <div class="viewcode-block" id="LinuxCCNPingServer.do_deploy"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccnpingserver.LinuxCCNPingServer.do_deploy">[docs]</a>    <span class="k">def</span> <span class="nf">do_deploy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
123         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">):</span>
124             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_command</span><span class="p">)</span>
125
126         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;env&quot;</span><span class="p">):</span>
127             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;env&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_environment</span><span class="p">)</span>
128
129         <span class="k">if</span> <span class="ow">not</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>
130             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dependencies</span><span class="p">)</span>
131
132         <span class="k">if</span> <span class="ow">not</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>
133             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;build&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_build</span><span class="p">)</span>
134
135         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;install&quot;</span><span class="p">):</span>
136             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;install&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_install</span><span class="p">)</span>
137
138         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxCCNPingServer</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_deploy</span><span class="p">()</span>
139 </div>
140     <span class="nd">@property</span>
141     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
142         <span class="n">args</span> <span class="o">=</span> <span class="p">[]</span>
143         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;ccnpingserver&quot;</span><span class="p">)</span>
144         <span class="n">args</span><span class="o">.</span><span class="n">append</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;prefix&quot;</span><span class="p">))</span>
145         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;d&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
146             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-d&quot;</span><span class="p">)</span>
147         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;x&quot;</span><span class="p">):</span>
148             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-x </span><span class="si">%d</span><span class="s">&quot;</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;x&quot;</span><span class="p">))</span>
149
150         <span class="n">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">args</span><span class="p">)</span>
151
152         <span class="k">return</span> <span class="n">command</span>
153
154     <span class="nd">@property</span>
155     <span class="k">def</span> <span class="nf">_dependencies</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
156         <span class="k">return</span> <span class="s">&quot;git&quot;</span>
157
158     <span class="nd">@property</span>
159     <span class="k">def</span> <span class="nf">_build</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
160         <span class="k">return</span> <span class="p">(</span>
161             <span class="c"># Evaluate if ccnx binaries are already installed</span>
162             <span class="s">&quot; ( &quot;</span>
163                 <span class="s">&quot; test -f ${BIN}/ccnping &amp;&amp; &quot;</span>
164                 <span class="s">&quot; echo &#39;binaries found, nothing to do&#39; &quot;</span>
165             <span class="s">&quot; ) || ( &quot;</span>
166             <span class="c"># If not, untar and build</span>
167                 <span class="s">&quot; ( &quot;</span>
168                     <span class="s">&quot; git clone git://github.com/NDN-Routing/ccnping ${SRC}/ccnping &quot;</span>
169                  <span class="s">&quot; ) &amp;&amp; &quot;</span>
170                     <span class="c"># build</span>
171                     <span class="s">&quot;cd ${SRC}/ccnping &amp;&amp; &quot;</span>
172                     <span class="s">&quot; ( &quot;</span>
173                     <span class="s">&quot; ./configure LDFLAGS=-L${SRC}/ccnx-0.7.2/lib CFLAGS=-I${SRC}/ccnx-0.7.2/include &quot;</span>
174                     <span class="s">&quot; --prefix=${BIN}/ccnping &amp;&amp; make &quot;</span>
175                     <span class="s">&quot; ) &quot;</span>
176              <span class="s">&quot; )&quot;</span><span class="p">)</span> 
177
178     <span class="nd">@property</span>
179     <span class="k">def</span> <span class="nf">_install</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
180         <span class="k">return</span> <span class="p">(</span>
181             <span class="c"># Evaluate if ccnx binaries are already installed</span>
182             <span class="s">&quot; ( &quot;</span>
183                 <span class="s">&quot; test -f ${BIN}/ccnping &amp;&amp; &quot;</span>
184                 <span class="s">&quot; echo &#39;binaries found, nothing to do&#39; &quot;</span>
185             <span class="s">&quot; ) || ( &quot;</span>
186             <span class="c"># If not, install</span>
187                 <span class="s">&quot;  mkdir -p ${BIN}/ccnping &amp;&amp; &quot;</span>
188                 <span class="s">&quot;  mv ${SRC}/ccnping/ccnping ${BIN}/ccnping/ &amp;&amp; &quot;</span>
189                 <span class="s">&quot;  mv ${SRC}/ccnping/ccnpingserver ${BIN}/ccnping/ &quot;</span>
190             <span class="s">&quot; )&quot;</span>
191             <span class="p">)</span>
192
193     <span class="nd">@property</span>
194     <span class="k">def</span> <span class="nf">_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
195         <span class="k">return</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ccnd</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="s">&quot;${BIN}/ccnping&quot;</span><span class="p">)</span>
196        
197 <div class="viewcode-block" id="LinuxCCNPingServer.valid_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccnpingserver.LinuxCCNPingServer.valid_connection">[docs]</a>    <span class="k">def</span> <span class="nf">valid_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
198         <span class="c"># TODO: Validate!</span>
199         <span class="k">return</span> <span class="bp">True</span>
200 </pre></div></div></div>
201
202           </div>
203         </div>
204       </div>
205       <div class="clearer"></div>
206     </div>
207     <div class="related">
208       <h3>Navigation</h3>
209       <ul>
210         <li class="right" style="margin-right: 10px">
211           <a href="../../../../../genindex.html" title="General Index"
212              >index</a></li>
213         <li class="right" >
214           <a href="../../../../../py-modindex.html" title="Python Module Index"
215              >modules</a> |</li>
216         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
217           <li><a href="../../../../index.html" >Module code</a> &raquo;</li> 
218       </ul>
219     </div>
220     <div class="footer">
221         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
222       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
223     </div>
224   </body>
225 </html>