add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / linux / ccn / ccnping.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.ccnping &mdash; NEPI 3.0 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.0',
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.0 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.0 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.ccnping</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.ccnpingserver</span> <span class="kn">import</span> <span class="n">LinuxCCNPingServer</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="LinuxCCNPing"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccnping.LinuxCCNPing">[docs]</a><span class="k">class</span> <span class="nc">LinuxCCNPing</span><span class="p">(</span><span class="n">LinuxCCNPingServer</span><span class="p">):</span>
95     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::CCNPing&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">interval</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;i&quot;</span><span class="p">,</span>
100             <span class="s">&quot;Set ping interval in seconds (minimum 0.10 second) &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">Integer</span><span class="p">,</span>
102             <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>
103
104         <span class="n">count</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;c&quot;</span><span class="p">,</span>
105             <span class="s">&quot;Total number of pings&quot;</span><span class="p">,</span>
106             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Double</span><span class="p">,</span>
107             <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>
108
109         <span class="n">number</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;n&quot;</span><span class="p">,</span>
110             <span class="s">&quot;Set the starting number, the number is incremented by 1 after each Interest &quot;</span><span class="p">,</span>
111             <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>
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">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>
115             <span class="s">&quot;Prefix to serve content (e.g. ccnx:/name/prefix)&quot;</span><span class="p">,</span>
116             <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>
117
118         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">interval</span><span class="p">)</span>
119         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">count</span><span class="p">)</span>
120         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">number</span><span class="p">)</span>
121         <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>
122
123     <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>
124         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxCCNPing</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>
125         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ccnping-</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>
126
127     <span class="nd">@property</span>
128 <div class="viewcode-block" id="LinuxCCNPing.ccnpingserver"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccnping.LinuxCCNPing.ccnpingserver">[docs]</a>    <span class="k">def</span> <span class="nf">ccnpingserver</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
129         <span class="n">ccnpingserver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">LinuxCCNPingServer</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
130         <span class="k">if</span> <span class="n">ccnpingserver</span><span class="p">:</span> <span class="k">return</span> <span class="n">ccnpingserver</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
131         <span class="k">return</span> <span class="bp">None</span>
132 </div>
133 <div class="viewcode-block" id="LinuxCCNPing.do_start"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccnping.LinuxCCNPing.do_start">[docs]</a>    <span class="k">def</span> <span class="nf">do_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
134         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnpingserver</span> <span class="ow">or</span> \
135                 <span class="bp">self</span><span class="o">.</span><span class="n">ccnpingserver</span><span class="o">.</span><span class="n">state</span> <span class="o">&lt;</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">STARTED</span><span class="p">:</span>
136             <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;---- RESCHEDULING START----  ccnpingserver state </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> \
137                     <span class="bp">self</span><span class="o">.</span><span class="n">ccnpingserver</span><span class="o">.</span><span class="n">state</span> <span class="p">)</span>
138             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">)</span>
139         <span class="k">else</span><span class="p">:</span>
140             <span class="nb">super</span><span class="p">(</span><span class="n">LinuxCCNPing</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_start</span><span class="p">()</span>
141  </div>
142     <span class="nd">@property</span>
143     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
144         <span class="n">args</span> <span class="o">=</span> <span class="p">[]</span>
145         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;ccnping&quot;</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="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>
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;c&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;-c </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;c&quot;</span><span class="p">))</span>
149         <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;n&quot;</span><span class="p">):</span>
150             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-n </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;n&quot;</span><span class="p">))</span>
151         <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;i&quot;</span><span class="p">):</span>
152             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-i </span><span class="si">%.2f</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;i&quot;</span><span class="p">))</span>
153
154         <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>
155
156         <span class="k">return</span> <span class="n">command</span>
157
158 <div class="viewcode-block" id="LinuxCCNPing.valid_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.ccnping.LinuxCCNPing.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>
159         <span class="c"># TODO: Validate!</span>
160         <span class="k">return</span> <span class="bp">True</span>
161 </pre></div></div></div>
162
163           </div>
164         </div>
165       </div>
166       <div class="clearer"></div>
167     </div>
168     <div class="related">
169       <h3>Navigation</h3>
170       <ul>
171         <li class="right" style="margin-right: 10px">
172           <a href="../../../../../genindex.html" title="General Index"
173              >index</a></li>
174         <li class="right" >
175           <a href="../../../../../py-modindex.html" title="Python Module Index"
176              >modules</a> |</li>
177         <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
178           <li><a href="../../../../index.html" >Module code</a> &raquo;</li> 
179       </ul>
180     </div>
181     <div class="footer">
182         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
183       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
184     </div>
185   </body>
186 </html>