add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / linux / ccn / fibentry.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.fibentry &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.fibentry</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.trace</span> <span class="kn">import</span> <span class="n">Trace</span><span class="p">,</span> <span class="n">TraceAttr</span>
87 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span><span class="p">,</span> <span class="n">ResourceState</span><span class="p">,</span> \
88     <span class="n">ResourceAction</span>
89 <span class="kn">from</span> <span class="nn">nepi.resources.linux.application</span> <span class="kn">import</span> <span class="n">LinuxApplication</span>
90 <span class="kn">from</span> <span class="nn">nepi.resources.linux.ccn.ccnd</span> <span class="kn">import</span> <span class="n">LinuxCCND</span>
91 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span>
92
93 <span class="kn">import</span> <span class="nn">os</span>
94 <span class="kn">import</span> <span class="nn">socket</span>
95 <span class="kn">import</span> <span class="nn">time</span>
96
97
98 <span class="c"># TODO: Add rest of options for ccndc!!!</span>
99 <span class="c">#       Implement ENTRY DELETE!!</span>
100
101 <span class="nd">@clsinit_copy</span>
102 <div class="viewcode-block" id="LinuxFIBEntry"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry">[docs]</a><span class="k">class</span> <span class="nc">LinuxFIBEntry</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
103     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::FIBEntry&quot;</span>
104
105     <span class="nd">@classmethod</span>
106     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
107         <span class="n">uri</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;uri&quot;</span><span class="p">,</span>
108                 <span class="s">&quot;URI prefix to match and route for this FIB entry&quot;</span><span class="p">,</span>
109                 <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;ccnx:/&quot;</span><span class="p">,</span>
110                 <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>
111
112         <span class="n">protocol</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;protocol&quot;</span><span class="p">,</span>
113                 <span class="s">&quot;Transport protocol used in network connection to peer &quot;</span>
114                 <span class="s">&quot;for this FIB entry. One of &#39;udp&#39; or &#39;tcp&#39;.&quot;</span><span class="p">,</span>
115                 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Enumerate</span><span class="p">,</span> 
116                 <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;udp&quot;</span><span class="p">,</span>
117                 <span class="n">allowed</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;udp&quot;</span><span class="p">,</span> <span class="s">&quot;tcp&quot;</span><span class="p">],</span>
118                 <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>
119
120         <span class="n">host</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;host&quot;</span><span class="p">,</span>
121                 <span class="s">&quot;Peer hostname used in network connection for this FIB entry. &quot;</span><span class="p">,</span>
122                 <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>
123
124         <span class="n">port</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;port&quot;</span><span class="p">,</span>
125                 <span class="s">&quot;Peer port address used in network connection to peer &quot;</span>
126                 <span class="s">&quot;for this FIB entry.&quot;</span><span class="p">,</span>
127                 <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>
128
129         <span class="n">ip</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;ip&quot;</span><span class="p">,</span>
130                 <span class="s">&quot;Peer host public IP used in network connection for this FIB entry. &quot;</span><span class="p">,</span>
131                 <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>
132
133         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span>
134         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">protocol</span><span class="p">)</span>
135         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
136         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">port</span><span class="p">)</span>
137         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">ip</span><span class="p">)</span>
138
139     <span class="nd">@classmethod</span>
140     <span class="k">def</span> <span class="nf">_register_traces</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
141         <span class="n">ping</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;ping&quot;</span><span class="p">,</span> <span class="s">&quot;Ping to the peer end&quot;</span><span class="p">)</span>
142         <span class="n">mtr</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;mtr&quot;</span><span class="p">,</span> <span class="s">&quot;Mtr to the peer end&quot;</span><span class="p">)</span>
143         <span class="n">traceroute</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;traceroute&quot;</span><span class="p">,</span> <span class="s">&quot;Tracerout to the peer end&quot;</span><span class="p">)</span>
144
145         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">ping</span><span class="p">)</span>
146         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">mtr</span><span class="p">)</span>
147         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">traceroute</span><span class="p">)</span>
148
149     <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>
150         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxFIBEntry</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>
151         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;fib-</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>
152         <span class="bp">self</span><span class="o">.</span><span class="n">_ping</span> <span class="o">=</span> <span class="bp">None</span>
153         <span class="bp">self</span><span class="o">.</span><span class="n">_traceroute</span> <span class="o">=</span> <span class="bp">None</span>
154         <span class="bp">self</span><span class="o">.</span><span class="n">_ccnd</span> <span class="o">=</span> <span class="bp">None</span>
155
156     <span class="nd">@property</span>
157 <div class="viewcode-block" id="LinuxFIBEntry.ccnd"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.ccnd">[docs]</a>    <span class="k">def</span> <span class="nf">ccnd</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
158         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ccnd</span><span class="p">:</span>
159             <span class="n">ccnd</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">LinuxCCND</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
160             <span class="k">if</span> <span class="n">ccnd</span><span class="p">:</span> 
161                 <span class="bp">self</span><span class="o">.</span><span class="n">_ccnd</span> <span class="o">=</span> <span class="n">ccnd</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
162             
163         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ccnd</span>
164 </div>
165     <span class="nd">@property</span>
166 <div class="viewcode-block" id="LinuxFIBEntry.ping"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.ping">[docs]</a>    <span class="k">def</span> <span class="nf">ping</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
167         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ping</span><span class="p">:</span>
168             <span class="kn">from</span> <span class="nn">nepi.resources.linux.ping</span> <span class="kn">import</span> <span class="n">LinuxPing</span>
169             <span class="n">ping</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">LinuxPing</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
170             <span class="k">if</span> <span class="n">ping</span><span class="p">:</span> 
171                 <span class="bp">self</span><span class="o">.</span><span class="n">_ping</span> <span class="o">=</span> <span class="n">ping</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
172             
173         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ping</span>
174 </div>
175     <span class="nd">@property</span>
176 <div class="viewcode-block" id="LinuxFIBEntry.traceroute"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.traceroute">[docs]</a>    <span class="k">def</span> <span class="nf">traceroute</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
177         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_traceroute</span><span class="p">:</span>
178             <span class="kn">from</span> <span class="nn">nepi.resources.linux.traceroute</span> <span class="kn">import</span> <span class="n">LinuxTraceroute</span>
179             <span class="n">traceroute</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">LinuxTraceroute</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
180             <span class="k">if</span> <span class="n">traceroute</span><span class="p">:</span> 
181                 <span class="bp">self</span><span class="o">.</span><span class="n">_traceroute</span> <span class="o">=</span> <span class="n">traceroute</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
182             
183         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_traceroute</span>
184 </div>
185     <span class="nd">@property</span>
186 <div class="viewcode-block" id="LinuxFIBEntry.node"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.node">[docs]</a>    <span class="k">def</span> <span class="nf">node</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
187         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnd</span><span class="p">:</span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnd</span><span class="o">.</span><span class="n">node</span>
188         <span class="k">return</span> <span class="bp">None</span>
189 </div>
190 <div class="viewcode-block" id="LinuxFIBEntry.trace"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.trace">[docs]</a>    <span class="k">def</span> <span class="nf">trace</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">attr</span> <span class="o">=</span> <span class="n">TraceAttr</span><span class="o">.</span><span class="n">ALL</span><span class="p">,</span> <span class="n">block</span> <span class="o">=</span> <span class="mi">512</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
191         <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="s">&quot;ping&quot;</span><span class="p">:</span>
192             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ping</span><span class="p">:</span>
193                 <span class="k">return</span> <span class="bp">None</span>
194             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ping</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span> <span class="s">&quot;stdout&quot;</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">block</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span>
195
196         <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="s">&quot;traceroute&quot;</span><span class="p">:</span>
197             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">traceroute</span><span class="p">:</span>
198                 <span class="k">return</span> <span class="bp">None</span>
199             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">traceroute</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span> <span class="s">&quot;stdout&quot;</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">block</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span>
200
201         <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">LinuxFIBEntry</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">block</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span>
202     </div>
203 <div class="viewcode-block" id="LinuxFIBEntry.do_deploy"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.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>
204         <span class="c"># Wait until associated ccnd is provisioned</span>
205         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnd</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnd</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">READY</span><span class="p">:</span>
206             <span class="c"># ccnr needs to wait until ccnd is deployed and running</span>
207             <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">deploy</span><span class="p">)</span>
208         <span class="k">else</span><span class="p">:</span>
209             <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;ip&quot;</span><span class="p">):</span>
210                 <span class="n">host</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;host&quot;</span><span class="p">)</span>
211                 <span class="n">ip</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostbyname</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
212                 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;ip&quot;</span><span class="p">,</span> <span class="n">ip</span><span class="p">)</span>
213
214             <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>
215                 <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>
216
217             <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>
218                 <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>
219
220             <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>
221
222             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Deploying 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>
223
224             <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
225             <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
226             <span class="bp">self</span><span class="o">.</span><span class="n">configure</span><span class="p">()</span>
227
228             <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
229 </div>
230 <div class="viewcode-block" id="LinuxFIBEntry.upload_start_command"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.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>
231         <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>
232         <span class="n">env</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;env&quot;</span><span class="p">)</span>
233
234         <span class="c"># We want to make sure the FIB entries are created</span>
235         <span class="c"># before the experiment starts.</span>
236         <span class="c"># Run the command as a bash script in the background, </span>
237         <span class="c"># in the host ( but wait until the command has</span>
238         <span class="c"># finished to continue )</span>
239         <span class="n">env</span> <span class="o">=</span> <span class="n">env</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_paths</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
240         <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_paths</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
241
242         <span class="c"># ccndc seems to return exitcode OK even if a (dns) error</span>
243         <span class="c"># occurred, so we need to account for this case here. </span>
244         <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute_command</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> 
245                 <span class="n">env</span><span class="p">,</span> <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
246
247         <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
248             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Failed to execute command&quot;</span>
249             <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>
250             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
251         </div>
252 <div class="viewcode-block" id="LinuxFIBEntry.configure"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.configure">[docs]</a>    <span class="k">def</span> <span class="nf">configure</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
253         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">trace_enabled</span><span class="p">(</span><span class="s">&quot;ping&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ping</span><span class="p">:</span>
254             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Configuring PING trace&quot;</span><span class="p">)</span>
255             <span class="n">ping</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_resource</span><span class="p">(</span><span class="s">&quot;linux::Ping&quot;</span><span class="p">)</span>
256             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">ping</span><span class="p">,</span> <span class="s">&quot;printTimestamp&quot;</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
257             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">ping</span><span class="p">,</span> <span class="s">&quot;target&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;host&quot;</span><span class="p">))</span>
258             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">ping</span><span class="p">,</span> <span class="s">&quot;earlyStart&quot;</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
259             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_connection</span><span class="p">(</span><span class="n">ping</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">guid</span><span class="p">)</span>
260             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_connection</span><span class="p">(</span><span class="n">ping</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
261             <span class="c"># schedule ping deploy</span>
262             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">deploy</span><span class="p">(</span><span class="n">guids</span><span class="o">=</span><span class="p">[</span><span class="n">ping</span><span class="p">],</span> <span class="n">group</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">deployment_group</span><span class="p">)</span>
263
264         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">trace_enabled</span><span class="p">(</span><span class="s">&quot;traceroute&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">traceroute</span><span class="p">:</span>
265             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Configuring TRACEROUTE trace&quot;</span><span class="p">)</span>
266             <span class="n">traceroute</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_resource</span><span class="p">(</span><span class="s">&quot;linux::Traceroute&quot;</span><span class="p">)</span>
267             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">traceroute</span><span class="p">,</span> <span class="s">&quot;printTimestamp&quot;</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
268             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">traceroute</span><span class="p">,</span> <span class="s">&quot;continuous&quot;</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
269             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">traceroute</span><span class="p">,</span> <span class="s">&quot;target&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;host&quot;</span><span class="p">))</span>
270             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">traceroute</span><span class="p">,</span> <span class="s">&quot;earlyStart&quot;</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
271             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_connection</span><span class="p">(</span><span class="n">traceroute</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">guid</span><span class="p">)</span>
272             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_connection</span><span class="p">(</span><span class="n">traceroute</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
273             <span class="c"># schedule mtr deploy</span>
274             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">deploy</span><span class="p">(</span><span class="n">guids</span><span class="o">=</span><span class="p">[</span><span class="n">traceroute</span><span class="p">],</span> <span class="n">group</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">deployment_group</span><span class="p">)</span>
275 </div>
276 <div class="viewcode-block" id="LinuxFIBEntry.do_start"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.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>
277         <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>
278             <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>
279             <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>
280
281             <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
282         <span class="k">else</span><span class="p">:</span>
283             <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>
284             <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>
285             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
286 </div>
287 <div class="viewcode-block" id="LinuxFIBEntry.do_stop"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.do_stop">[docs]</a>    <span class="k">def</span> <span class="nf">do_stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
288         <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">&#39;command&#39;</span><span class="p">)</span>
289         <span class="n">env</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">&#39;env&#39;</span><span class="p">)</span>
290         
291         <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">STARTED</span><span class="p">:</span>
292             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Stopping 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>
293
294             <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_command</span>
295             <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">execute_command</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">env</span><span class="p">,</span>
296                     <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
297
298             <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
299
300             <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
301                 <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>
302                 <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>
303                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
304 </div>
305     <span class="nd">@property</span>
306     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
307         <span class="n">uri</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;uri&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span>
308         <span class="n">protocol</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;protocol&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span>
309         <span class="n">ip</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;ip&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span> 
310         <span class="n">port</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;port&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span>
311
312         <span class="c"># add ccnx:/example.com/ udp 224.0.0.204 52428</span>
313         <span class="k">return</span> <span class="s">&quot;ccndc add </span><span class="si">%(uri)s</span><span class="s"> </span><span class="si">%(protocol)s</span><span class="s"> </span><span class="si">%(host)s</span><span class="s"> </span><span class="si">%(port)s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">({</span>
314             <span class="s">&quot;uri&quot;</span> <span class="p">:</span> <span class="n">uri</span><span class="p">,</span>
315             <span class="s">&quot;protocol&quot;</span><span class="p">:</span> <span class="n">protocol</span><span class="p">,</span>
316             <span class="s">&quot;host&quot;</span><span class="p">:</span> <span class="n">ip</span><span class="p">,</span>
317             <span class="s">&quot;port&quot;</span><span class="p">:</span> <span class="n">port</span>
318             <span class="p">})</span>
319
320     <span class="nd">@property</span>
321     <span class="k">def</span> <span class="nf">_stop_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
322         <span class="n">uri</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;uri&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span>
323         <span class="n">protocol</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;protocol&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span>
324         <span class="n">ip</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;ip&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span>
325         <span class="n">port</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;port&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&quot;&quot;</span>
326
327         <span class="c"># add ccnx:/example.com/ udp 224.0.0.204 52428</span>
328         <span class="k">return</span> <span class="s">&quot;ccndc del </span><span class="si">%(uri)s</span><span class="s"> </span><span class="si">%(protocol)s</span><span class="s"> </span><span class="si">%(host)s</span><span class="s"> </span><span class="si">%(port)s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">({</span>
329             <span class="s">&quot;uri&quot;</span> <span class="p">:</span> <span class="n">uri</span><span class="p">,</span>
330             <span class="s">&quot;protocol&quot;</span><span class="p">:</span> <span class="n">protocol</span><span class="p">,</span>
331             <span class="s">&quot;host&quot;</span><span class="p">:</span> <span class="n">ip</span><span class="p">,</span>
332             <span class="s">&quot;port&quot;</span><span class="p">:</span> <span class="n">port</span>
333             <span class="p">})</span>
334
335     <span class="nd">@property</span>
336     <span class="k">def</span> <span class="nf">_environment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
337         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ccnd</span><span class="o">.</span><span class="n">path</span>
338        
339 <div class="viewcode-block" id="LinuxFIBEntry.valid_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ccn.html#nepi.resources.linux.ccn.fibentry.LinuxFIBEntry.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>
340         <span class="c"># TODO: Validate!</span>
341         <span class="k">return</span> <span class="bp">True</span>
342 </pre></div></div></div>
343
344           </div>
345         </div>
346       </div>
347       <div class="clearer"></div>
348     </div>
349     <div class="related">
350       <h3>Navigation</h3>
351       <ul>
352         <li class="right" style="margin-right: 10px">
353           <a href="../../../../../genindex.html" title="General Index"
354              >index</a></li>
355         <li class="right" >
356           <a href="../../../../../py-modindex.html" title="Python Module Index"
357              >modules</a> |</li>
358         <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
359           <li><a href="../../../../index.html" >Module code</a> &raquo;</li> 
360       </ul>
361     </div>
362     <div class="footer">
363         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
364       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
365     </div>
366   </body>
367 </html>