add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / linux / ping.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.ping &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.ping</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">clsinit_copy</span><span class="p">,</span> <span class="n">ResourceState</span> 
87 <span class="kn">from</span> <span class="nn">nepi.resources.linux.application</span> <span class="kn">import</span> <span class="n">LinuxApplication</span>
88 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span>
89
90 <span class="kn">import</span> <span class="nn">os</span>
91
92 <span class="nd">@clsinit_copy</span>
93 <div class="viewcode-block" id="LinuxPing"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.ping.LinuxPing">[docs]</a><span class="k">class</span> <span class="nc">LinuxPing</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
94     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::Ping&quot;</span>
95
96     <span class="nd">@classmethod</span>
97     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
98         <span class="n">count</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;count&quot;</span><span class="p">,</span>
99             <span class="s">&quot;Sets ping -c option. Determines the number of ECHO_REQUEST &quot;</span>
100             <span class="s">&quot;packates to send before stopping.&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">mark</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;mark&quot;</span><span class="p">,</span>
105             <span class="s">&quot;Sets ping -m option. Uses &#39;mark&#39; to tag outgoing packets. &quot;</span><span class="p">,</span>
106             <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>
107
108         <span class="n">interval</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;interval&quot;</span><span class="p">,</span>
109             <span class="s">&quot;Sets ping -i option. Leaves interval seconds between &quot;</span>
110             <span class="s">&quot;successive ECHO_REUQEST packets. &quot;</span><span class="p">,</span>
111             <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>
112
113         <span class="n">address</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;address&quot;</span><span class="p">,</span>
114             <span class="s">&quot;Sets ping -I option. Sets ECHO_REQUEST packets souce address &quot;</span>
115             <span class="s">&quot;to the specified interface address &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">preload</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;preload&quot;</span><span class="p">,</span>
119             <span class="s">&quot;Sets ping -l option. Sends preload amount of packets &quot;</span>
120             <span class="s">&quot;without waiting for a reply &quot;</span><span class="p">,</span>
121             <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>
122
123         <span class="n">numeric</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;numeric&quot;</span><span class="p">,</span>
124             <span class="s">&quot;Sets ping -n option. Disables resolution of host addresses into &quot;</span>
125             <span class="s">&quot;symbolic names. &quot;</span><span class="p">,</span>
126             <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>
127             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
128             <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>
129
130         <span class="n">pattern</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;pattern&quot;</span><span class="p">,</span>
131             <span class="s">&quot;Sets ping -p option. Species a up to 16 &#39;&#39;pad&#39;&#39; bytes to fill &quot;</span>
132             <span class="s">&quot;out sent packets. &quot;</span><span class="p">,</span>
133             <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>
134
135         <span class="n">printtmp</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;printTimestamp&quot;</span><span class="p">,</span>
136             <span class="s">&quot;Sets ping -D option. Prints timestamp befor each line as: &quot;</span>
137             <span class="s">&quot;unix time + microseconds as in gettimeofday &quot;</span><span class="p">,</span>
138             <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>
139             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
140             <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>
141
142         <span class="n">tos</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;tos&quot;</span><span class="p">,</span>
143             <span class="s">&quot;Sets ping -Q option. Sets Quality of Service related bits in ICMP &quot;</span>
144             <span class="s">&quot;datagrams. tos can be either a decimal or hexadecime number &quot;</span><span class="p">,</span>
145             <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>
146
147         <span class="n">quiet</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;quiet&quot;</span><span class="p">,</span>
148             <span class="s">&quot;Sets ping -q option. Disables ping standard output &quot;</span><span class="p">,</span>
149             <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>
150             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
151             <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>
152
153         <span class="n">rec_route</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;recordRoute&quot;</span><span class="p">,</span>
154             <span class="s">&quot;Sets ping -R option. Includes the RECORD_ROUTE option in the &quot;</span>
155             <span class="s">&quot;ECHO REQUEST packet and displays route buffer on the Disables &quot;</span>
156             <span class="s">&quot;ping standard output.&quot;</span><span class="p">,</span>
157             <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>
158             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
159             <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>
160
161         <span class="n">route_bypass</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;routeBypass&quot;</span><span class="p">,</span>
162             <span class="s">&quot;Sets ping -r option. Bypasses normal routing tables and sends &quot;</span>
163             <span class="s">&quot;ECHO REQUEST packets directly yo a host on an attached interface. &quot;</span><span class="p">,</span>
164             <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>
165             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
166             <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>
167
168         <span class="n">packetsize</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;packetSize&quot;</span><span class="p">,</span>
169             <span class="s">&quot;Sets ping -s option. Specifies the number of data bytes to be &quot;</span>
170             <span class="s">&quot;sent. Defaults to 56. &quot;</span><span class="p">,</span>
171             <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>
172
173         <span class="n">sendbuff</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;sendBuff&quot;</span><span class="p">,</span>
174             <span class="s">&quot;Sets ping -S option. Specifies the number of packets to buffer. &quot;</span>
175             <span class="s">&quot;Defaults to one. &quot;</span><span class="p">,</span>
176             <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>
177
178         <span class="n">ttl</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;ttl&quot;</span><span class="p">,</span>
179             <span class="s">&quot;Sets ping -t option. Specifies the IP Time to Live for the &quot;</span>
180             <span class="s">&quot;packets. &quot;</span><span class="p">,</span>
181             <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>
182
183         <span class="n">timestamp</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;timestamp&quot;</span><span class="p">,</span>
184             <span class="s">&quot;Sets ping -T option. Sets special IP timestamp options. &quot;</span><span class="p">,</span>
185             <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>
186
187         <span class="n">hint</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;hint&quot;</span><span class="p">,</span>
188             <span class="s">&quot;Sets ping -M option. Selects Path MTU Discovery strategy. &quot;</span><span class="p">,</span>
189             <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>
190
191         <span class="n">full_latency</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;fullLatency&quot;</span><span class="p">,</span>
192             <span class="s">&quot;Sets ping -U option. Calculates round trip time taking into &quot;</span>
193             <span class="s">&quot;account the full user-to-user latency instead of only the &quot;</span>
194             <span class="s">&quot;network round trip time. &quot;</span><span class="p">,</span>
195             <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>
196             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
197             <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>
198
199         <span class="n">verbose</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;verbose&quot;</span><span class="p">,</span>
200             <span class="s">&quot;Sets ping -v option. Verbose output. &quot;</span><span class="p">,</span>
201             <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>
202             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
203             <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>
204
205         <span class="n">flood</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;flood&quot;</span><span class="p">,</span>
206             <span class="s">&quot;Sets ping -f option. Flood ping. &quot;</span><span class="p">,</span>
207             <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>
208             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
209             <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>
210
211         <span class="n">deadline</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;deadline&quot;</span><span class="p">,</span>
212             <span class="s">&quot;Sets ping -w option. Specify a timeout, in seconds, before ping &quot;</span>
213             <span class="s">&quot;exits regardless of how many packets have been sent or received.&quot;</span><span class="p">,</span>
214             <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>
215
216         <span class="n">timeout</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;timeout&quot;</span><span class="p">,</span>
217             <span class="s">&quot;Sets ping -W option. Time to wait for a respone in seconds .&quot;</span><span class="p">,</span>
218             <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>
219
220         <span class="n">target</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">,</span>
221             <span class="s">&quot;The host to ping .&quot;</span><span class="p">,</span>
222             <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>
223
224         <span class="n">early_start</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;earlyStart&quot;</span><span class="p">,</span>
225             <span class="s">&quot;Start ping as early as deployment. &quot;</span><span class="p">,</span>
226             <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>
227             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
228             <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>
229
230         <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>
231         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">mark</span><span class="p">)</span>
232         <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>
233         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
234         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">preload</span><span class="p">)</span>
235         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">numeric</span><span class="p">)</span>
236         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">pattern</span><span class="p">)</span>
237         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">printtmp</span><span class="p">)</span>
238         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">tos</span><span class="p">)</span>
239         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">quiet</span><span class="p">)</span>
240         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">rec_route</span><span class="p">)</span>
241         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">route_bypass</span><span class="p">)</span>
242         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">packetsize</span><span class="p">)</span>
243         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">sendbuff</span><span class="p">)</span>
244         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">ttl</span><span class="p">)</span>
245         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">timestamp</span><span class="p">)</span>
246         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">hint</span><span class="p">)</span>
247         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">full_latency</span><span class="p">)</span>
248         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">verbose</span><span class="p">)</span>
249         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">flood</span><span class="p">)</span>
250         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">deadline</span><span class="p">)</span>
251         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span>
252         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
253         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">early_start</span><span class="p">)</span>
254
255     <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>
256         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxPing</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>
257         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ping-</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>
258
259 <div class="viewcode-block" id="LinuxPing.upload_start_command"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.ping.LinuxPing.upload_start_command">[docs]</a>    <span class="k">def</span> <span class="nf">upload_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
260         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxPing</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">upload_start_command</span><span class="p">()</span>
261         
262         <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;earlyStart&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
263             <span class="bp">self</span><span class="o">.</span><span class="n">_run_in_background</span><span class="p">()</span>
264 </div>
265 <div class="viewcode-block" id="LinuxPing.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.ping.LinuxPing.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>
266         <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>
267             <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>
268
269         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxPing</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>
270 </div>
271 <div class="viewcode-block" id="LinuxPing.do_start"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.ping.LinuxPing.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>
272         <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;earlyStart&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
273             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
274                 <span class="n">command</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;command&quot;</span><span class="p">)</span>
275                 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Starting command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
276
277                 <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
278             <span class="k">else</span><span class="p">:</span>
279                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to execute command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span>
280                 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
281                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
282         <span class="k">else</span><span class="p">:</span>
283            <span class="nb">super</span><span class="p">(</span><span class="n">LinuxPing</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>
284 </div>
285     <span class="nd">@property</span>
286     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
287         <span class="n">args</span> <span class="o">=</span> <span class="p">[]</span>
288
289         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;echo &#39;Starting PING to </span><span class="si">%s</span><span class="s">&#39; ;&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;target&quot;</span><span class="p">))</span>
290
291         <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;printTimestamp&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
292             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;&quot;&quot;echo &quot;`date +&#39;%Y%m</span><span class="si">%d</span><span class="s">%H%M%S&#39;`&quot;;&quot;&quot;&quot;</span><span class="p">)</span>
293
294         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;ping &quot;</span><span class="p">)</span>
295         
296         <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;count&quot;</span><span class="p">):</span>
297             <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">%s</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;count&quot;</span><span class="p">))</span>
298         <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;mark&quot;</span><span class="p">):</span>
299             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-m </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">get</span><span class="p">(</span><span class="s">&quot;mark&quot;</span><span class="p">))</span>
300         <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;interval&quot;</span><span class="p">):</span>
301             <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">%s</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;interval&quot;</span><span class="p">))</span>
302         <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;address&quot;</span><span class="p">):</span>
303             <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">%s</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;address&quot;</span><span class="p">))</span>
304         <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;preload&quot;</span><span class="p">):</span>
305             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-l </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">get</span><span class="p">(</span><span class="s">&quot;preload&quot;</span><span class="p">))</span>
306         <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;numeric&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
307             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-n&quot;</span><span class="p">)</span>
308         <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;pattern&quot;</span><span class="p">):</span>
309             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-p </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">get</span><span class="p">(</span><span class="s">&quot;pattern&quot;</span><span class="p">))</span>
310         <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;tos&quot;</span><span class="p">):</span>
311             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-Q </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">get</span><span class="p">(</span><span class="s">&quot;tos&quot;</span><span class="p">))</span>
312         <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;quiet&quot;</span><span class="p">):</span>
313             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-q </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">get</span><span class="p">(</span><span class="s">&quot;quiet&quot;</span><span class="p">))</span>
314         <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;recordRoute&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
315             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-R&quot;</span><span class="p">)</span>
316         <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;routeBypass&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
317             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-r&quot;</span><span class="p">)</span>
318         <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;packetSize&quot;</span><span class="p">):</span>
319             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-s </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">get</span><span class="p">(</span><span class="s">&quot;packetSize&quot;</span><span class="p">))</span>
320         <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;sendBuff&quot;</span><span class="p">):</span>
321             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-S </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">get</span><span class="p">(</span><span class="s">&quot;sendBuff&quot;</span><span class="p">))</span>
322         <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;ttl&quot;</span><span class="p">):</span>
323             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-t </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">get</span><span class="p">(</span><span class="s">&quot;ttl&quot;</span><span class="p">))</span>
324         <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;timestamp&quot;</span><span class="p">):</span>
325             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-T </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">get</span><span class="p">(</span><span class="s">&quot;timestamp&quot;</span><span class="p">))</span>
326         <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;hint&quot;</span><span class="p">):</span>
327             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-M </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">get</span><span class="p">(</span><span class="s">&quot;hint&quot;</span><span class="p">))</span>
328         <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;fullLatency&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
329             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-U&quot;</span><span class="p">)</span>
330         <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;verbose&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
331             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-v&quot;</span><span class="p">)</span>
332         <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;flood&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
333             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-f&quot;</span><span class="p">)</span>
334         <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;deadline&quot;</span><span class="p">):</span>
335             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-w </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">get</span><span class="p">(</span><span class="s">&quot;deadline&quot;</span><span class="p">))</span>
336         <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;timeout&quot;</span><span class="p">):</span>
337             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-W </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">get</span><span class="p">(</span><span class="s">&quot;timeout&quot;</span><span class="p">))</span>
338         <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;target&quot;</span><span class="p">))</span>
339
340         <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>
341
342         <span class="k">return</span> <span class="n">command</span>
343
344 <div class="viewcode-block" id="LinuxPing.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.ping.LinuxPing.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>
345         <span class="c"># TODO: Validate!</span>
346         <span class="k">return</span> <span class="bp">True</span>
347 </pre></div></div></div>
348
349           </div>
350         </div>
351       </div>
352       <div class="clearer"></div>
353     </div>
354     <div class="related">
355       <h3>Navigation</h3>
356       <ul>
357         <li class="right" style="margin-right: 10px">
358           <a href="../../../../genindex.html" title="General Index"
359              >index</a></li>
360         <li class="right" >
361           <a href="../../../../py-modindex.html" title="Python Module Index"
362              >modules</a> |</li>
363         <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
364           <li><a href="../../../index.html" >Module code</a> &raquo;</li> 
365       </ul>
366     </div>
367     <div class="footer">
368         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
369       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
370     </div>
371   </body>
372 </html>