1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.omf.omf5_api — NEPI 3.2 documentation</title>
11 <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../../',
18 COLLAPSE_INDEX: false,
23 <script type="text/javascript" src="../../../../_static/jquery.js"></script>
24 <script type="text/javascript" src="../../../../_static/underscore.js"></script>
25 <script type="text/javascript" src="../../../../_static/doctools.js"></script>
26 <link rel="top" title="NEPI 3.2 documentation" href="../../../../index.html" />
27 <link rel="up" title="Module code" href="../../../index.html" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../../index.html">NEPI 3.2 documentation</a> »</li>
40 <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
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" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <h1>Source code for nepi.resources.omf.omf5_api</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 <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
84 <span class="c"># Julien Tribino <julien.tribino@inria.fr></span>
86 <span class="kn">import</span> <span class="nn">ssl</span>
87 <span class="kn">import</span> <span class="nn">sys</span>
88 <span class="kn">import</span> <span class="nn">time</span>
90 <span class="kn">from</span> <span class="nn">nepi.util.logger</span> <span class="kn">import</span> <span class="n">Logger</span>
92 <span class="kn">from</span> <span class="nn">nepi.resources.omf.omf_client</span> <span class="kn">import</span> <span class="n">OMFClient</span>
93 <span class="kn">from</span> <span class="nn">nepi.resources.omf.messages_5_4</span> <span class="kn">import</span> <span class="n">MessageHandler</span>
95 <div class="viewcode-block" id="OMF5API"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API">[docs]</a><span class="k">class</span> <span class="nc">OMF5API</span><span class="p">(</span><span class="n">Logger</span><span class="p">):</span>
96 <span class="sd">"""</span>
97 <span class="sd"> .. class:: Class Args :</span>
98 <span class="sd"> </span>
99 <span class="sd"> :param host: Xmpp Server</span>
100 <span class="sd"> :type host: str</span>
101 <span class="sd"> :param slice: Xmpp Slice</span>
102 <span class="sd"> :type slice: str</span>
103 <span class="sd"> :param port: Xmpp Port</span>
104 <span class="sd"> :type port: str</span>
105 <span class="sd"> :param password: Xmpp password</span>
106 <span class="sd"> :type password: str</span>
107 <span class="sd"> :param xmpp_root: Root of the Xmpp Topic Architecture</span>
108 <span class="sd"> :type xmpp_root: str</span>
110 <span class="sd"> .. note::</span>
112 <span class="sd"> This class is the implementation of an OMF 5.4 API. </span>
113 <span class="sd"> Since the version 5.4.1, the Topic Architecture start with OMF_5.4 </span>
114 <span class="sd"> instead of OMF used for OMF5.3</span>
116 <span class="sd"> """</span>
117 <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">host</span><span class="p">,</span> <span class="nb">slice</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">xmpp_root</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
118 <span class="n">exp_id</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
119 <span class="sd">"""</span>
120 <span class="sd"> :param host: Xmpp Server</span>
121 <span class="sd"> :type host: str</span>
122 <span class="sd"> :param slice: Xmpp Slice</span>
123 <span class="sd"> :type slice: str</span>
124 <span class="sd"> :param port: Xmpp Port</span>
125 <span class="sd"> :type port: str</span>
126 <span class="sd"> :param password: Xmpp password</span>
127 <span class="sd"> :type password: str</span>
128 <span class="sd"> :param xmpp_root: Root of the Xmpp Topic Architecture</span>
129 <span class="sd"> :type xmpp_root: str</span>
131 <span class="sd"> """</span>
132 <span class="nb">super</span><span class="p">(</span><span class="n">OMF5API</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="s">"OMF5API"</span><span class="p">)</span>
133 <span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span> <span class="o">=</span> <span class="n">exp_id</span>
134 <span class="bp">self</span><span class="o">.</span><span class="n">_user</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">-</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="nb">slice</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
135 <span class="bp">self</span><span class="o">.</span><span class="n">_slice</span> <span class="o">=</span> <span class="nb">slice</span>
136 <span class="bp">self</span><span class="o">.</span><span class="n">_host</span> <span class="o">=</span> <span class="n">host</span>
137 <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">port</span>
138 <span class="bp">self</span><span class="o">.</span><span class="n">_password</span> <span class="o">=</span> <span class="n">password</span>
139 <span class="bp">self</span><span class="o">.</span><span class="n">_hostnames</span> <span class="o">=</span> <span class="p">[]</span>
140 <span class="bp">self</span><span class="o">.</span><span class="n">_xmpp_root</span> <span class="o">=</span> <span class="n">xmpp_root</span> <span class="ow">or</span> <span class="s">"OMF_5.4"</span>
142 <span class="c"># OMF xmpp client</span>
143 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="bp">None</span>
145 <span class="c"># message handler</span>
146 <span class="bp">self</span><span class="o">.</span><span class="n">_message</span> <span class="o">=</span> <span class="bp">None</span>
148 <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o"><</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">):</span>
149 <span class="nb">reload</span><span class="p">(</span><span class="n">sys</span><span class="p">)</span>
150 <span class="n">sys</span><span class="o">.</span><span class="n">setdefaultencoding</span><span class="p">(</span><span class="s">'utf8'</span><span class="p">)</span>
152 <span class="c"># instantiate the xmpp client</span>
153 <span class="bp">self</span><span class="o">.</span><span class="n">_init_client</span><span class="p">()</span>
155 <span class="c"># register xmpp nodes for the experiment</span>
156 <span class="bp">self</span><span class="o">.</span><span class="n">_enroll_experiment</span><span class="p">()</span>
157 <span class="bp">self</span><span class="o">.</span><span class="n">_enroll_newexperiment</span><span class="p">()</span>
159 <span class="c"># register xmpp logger for the experiment</span>
160 <span class="bp">self</span><span class="o">.</span><span class="n">_enroll_logger</span><span class="p">()</span>
162 <span class="k">def</span> <span class="nf">_init_client</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
163 <span class="sd">""" Initialize XMPP Client</span>
165 <span class="sd"> """</span>
166 <span class="n">jid</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">@</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_user</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">)</span>
167 <span class="n">xmpp</span> <span class="o">=</span> <span class="n">OMFClient</span><span class="p">(</span><span class="n">jid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_password</span><span class="p">)</span>
168 <span class="c"># PROTOCOL_SSLv3 required for compatibility with OpenFire</span>
169 <span class="n">xmpp</span><span class="o">.</span><span class="n">ssl_version</span> <span class="o">=</span> <span class="n">ssl</span><span class="o">.</span><span class="n">PROTOCOL_SSLv3</span>
171 <span class="k">if</span> <span class="n">xmpp</span><span class="o">.</span><span class="n">connect</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">)):</span>
172 <span class="n">xmpp</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">block</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
173 <span class="k">while</span> <span class="ow">not</span> <span class="n">xmpp</span><span class="o">.</span><span class="n">ready</span><span class="p">:</span>
174 <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
175 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">xmpp</span>
176 <span class="bp">self</span><span class="o">.</span><span class="n">_message</span> <span class="o">=</span> <span class="n">MessageHandler</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_user</span><span class="p">)</span>
177 <span class="k">else</span><span class="p">:</span>
178 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Unable to connect to the XMPP server."</span>
179 <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>
180 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
182 <span class="k">def</span> <span class="nf">_enroll_experiment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
183 <span class="sd">""" Create and Subscribe to the Session Topic</span>
185 <span class="sd"> """</span>
186 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_exp_session_id</span>
187 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
188 <span class="c">#print "Create experiment sesion id topics !!" </span>
189 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
190 <span class="c">#print "Subscribe to experiment sesion id topics !!" </span>
193 <span class="k">def</span> <span class="nf">_enroll_newexperiment</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
194 <span class="sd">""" Publish New Experiment Message</span>
196 <span class="sd"> """</span>
197 <span class="n">address</span> <span class="o">=</span> <span class="s">"/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_host</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_xmpp_root</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">,</span>
198 <span class="bp">self</span><span class="o">.</span><span class="n">_user</span><span class="p">)</span>
199 <span class="c">#print address</span>
200 <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">newexp_function</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_user</span><span class="p">,</span> <span class="n">address</span><span class="p">)</span>
201 <span class="n">slice_sid</span> <span class="o">=</span> <span class="s">"/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_xmpp_root</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">)</span>
202 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">slice_sid</span><span class="p">)</span>
204 <span class="k">def</span> <span class="nf">_enroll_logger</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
205 <span class="sd">""" Create and Subscribe to the Logger Topic</span>
207 <span class="sd"> """</span>
208 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_logger_session_id</span>
209 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
210 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
212 <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">log_function</span><span class="p">(</span><span class="s">"2"</span><span class="p">,</span>
213 <span class="s">"nodeHandler::NodeHandler"</span><span class="p">,</span>
214 <span class="s">"INFO"</span><span class="p">,</span>
215 <span class="s">"OMF Experiment Controller 5.4 (git 529a626)"</span><span class="p">)</span>
216 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">xmpp_node</span><span class="p">)</span>
218 <span class="k">def</span> <span class="nf">_host_session_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">):</span>
219 <span class="sd">""" Return the Topic Name as /xmpp_root/slice/user/hostname</span>
221 <span class="sd"> :param hostname: Full hrn of the node</span>
222 <span class="sd"> :type hostname: str</span>
224 <span class="sd"> """</span>
225 <span class="k">return</span> <span class="s">"/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_xmpp_root</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_user</span><span class="p">,</span>
226 <span class="n">hostname</span><span class="p">)</span>
228 <span class="k">def</span> <span class="nf">_host_resource_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">):</span>
229 <span class="sd">""" Return the Topic Name as /xmpp_root/slice/resources/hostname</span>
231 <span class="sd"> :param hostname: Full hrn of the node</span>
232 <span class="sd"> :type hostname: str</span>
234 <span class="sd"> """</span>
235 <span class="k">return</span> <span class="s">"/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/resources/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_xmpp_root</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">,</span> <span class="n">hostname</span><span class="p">)</span>
237 <span class="nd">@property</span>
238 <span class="k">def</span> <span class="nf">_exp_session_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
239 <span class="sd">""" Return the Topic Name as /xmpp_root/slice/user</span>
241 <span class="sd"> """</span>
242 <span class="k">return</span> <span class="s">"/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_xmpp_root</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_user</span><span class="p">)</span>
244 <span class="nd">@property</span>
245 <span class="k">def</span> <span class="nf">_logger_session_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
246 <span class="sd">""" Return the Topic Name as /xmpp_root/slice/LOGGER</span>
248 <span class="sd"> """</span>
249 <span class="k">return</span> <span class="s">"/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">/LOGGER"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_xmpp_root</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_slice</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_user</span><span class="p">)</span>
251 <div class="viewcode-block" id="OMF5API.delete"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">):</span>
252 <span class="sd">""" Delete the topic corresponding to the hostname for this session</span>
254 <span class="sd"> :param hostname: Full hrn of the node</span>
255 <span class="sd"> :type hostname: str</span>
257 <span class="sd"> """</span>
258 <span class="k">if</span> <span class="ow">not</span> <span class="n">hostname</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hostnames</span><span class="p">:</span>
259 <span class="k">return</span>
261 <span class="bp">self</span><span class="o">.</span><span class="n">_hostnames</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
263 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host_session_id</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
264 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
266 <div class="viewcode-block" id="OMF5API.enroll_host"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.enroll_host">[docs]</a> <span class="k">def</span> <span class="nf">enroll_host</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">):</span>
267 <span class="sd">""" Create and Subscribe to the session topic and the resources</span>
268 <span class="sd"> corresponding to the hostname</span>
270 <span class="sd"> :param hostname: Full hrn of the node</span>
271 <span class="sd"> :type hostname: str</span>
273 <span class="sd"> """</span>
274 <span class="k">if</span> <span class="n">hostname</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hostnames</span><span class="p">:</span>
275 <span class="k">return</span>
277 <span class="bp">self</span><span class="o">.</span><span class="n">_hostnames</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
279 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host_session_id</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
280 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
281 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
283 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host_resource_id</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
284 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="n">xmpp_node</span><span class="p">)</span>
286 <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">enroll_function</span><span class="p">(</span><span class="s">"1"</span><span class="p">,</span> <span class="s">"*"</span><span class="p">,</span> <span class="s">"1"</span><span class="p">,</span> <span class="n">hostname</span><span class="p">)</span>
287 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">xmpp_node</span><span class="p">)</span>
289 <div class="viewcode-block" id="OMF5API.configure"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.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> <span class="n">hostname</span><span class="p">,</span> <span class="n">attribute</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
290 <span class="sd">""" Configure attribute on the node</span>
292 <span class="sd"> :param hostname: Full hrn of the node</span>
293 <span class="sd"> :type hostname: str</span>
294 <span class="sd"> :param attribute: Attribute that need to be configured (</span>
295 <span class="sd"> often written as /net/wX/attribute, with X the interface number)</span>
296 <span class="sd"> :type attribute: str</span>
297 <span class="sd"> :param value: Value of the attribute</span>
298 <span class="sd"> :type value: str</span>
300 <span class="sd"> """</span>
301 <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">configure_function</span><span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">attribute</span><span class="p">)</span>
302 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host_session_id</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
303 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">xmpp_node</span><span class="p">)</span>
306 <div class="viewcode-block" id="OMF5API.send_stdin"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.send_stdin">[docs]</a> <span class="k">def</span> <span class="nf">send_stdin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">app_id</span><span class="p">):</span>
307 <span class="sd">""" Send to the stdin of the application the value</span>
309 <span class="sd"> :param hostname: Full hrn of the node</span>
310 <span class="sd"> :type hostname: str</span>
311 <span class="sd"> :param appid: Application Id (Any id that represents in a unique </span>
312 <span class="sd"> way the application)</span>
313 <span class="sd"> :type appid: str</span>
314 <span class="sd"> :param value: parameter to execute in the stdin of the application</span>
315 <span class="sd"> :type value: str</span>
317 <span class="sd"> """</span>
318 <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">stdin_function</span><span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">app_id</span><span class="p">)</span>
319 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host_session_id</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
320 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">xmpp_node</span><span class="p">)</span>
323 <div class="viewcode-block" id="OMF5API.execute"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">app_id</span><span class="p">,</span> <span class="n">arguments</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
324 <span class="sd">""" Execute command on the node</span>
326 <span class="sd"> :param hostname: Full hrn of the node</span>
327 <span class="sd"> :type hostname: str</span>
328 <span class="sd"> :param app_id: Application Id (Any id that represents in a unique </span>
329 <span class="sd"> way the application)</span>
330 <span class="sd"> :type app_id: str</span>
331 <span class="sd"> :param arguments: Arguments of the application</span>
332 <span class="sd"> :type arguments: str</span>
333 <span class="sd"> :param path: Path of the application</span>
334 <span class="sd"> :type path: str</span>
335 <span class="sd"> :param env: Environnement values for the application</span>
336 <span class="sd"> :type env: str</span>
338 <span class="sd"> """</span>
339 <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">execute_function</span><span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">app_id</span><span class="p">,</span> <span class="n">arguments</span><span class="p">,</span>
340 <span class="n">path</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span>
341 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host_session_id</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
342 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">xmpp_node</span><span class="p">)</span>
344 <div class="viewcode-block" id="OMF5API.exit"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.exit">[docs]</a> <span class="k">def</span> <span class="nf">exit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">app_id</span><span class="p">):</span>
345 <span class="sd">""" Kill an application started with OMF</span>
347 <span class="sd"> :param hostname: Full hrn of the node</span>
348 <span class="sd"> :type hostname: str</span>
349 <span class="sd"> :param app_id: Application Id of the application you want to stop</span>
350 <span class="sd"> :type app_id: str</span>
352 <span class="sd"> """</span>
353 <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_message</span><span class="o">.</span><span class="n">exit_function</span><span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">app_id</span><span class="p">)</span>
354 <span class="n">xmpp_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_host_session_id</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
355 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="n">xmpp_node</span><span class="p">)</span>
357 <div class="viewcode-block" id="OMF5API.release"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.release">[docs]</a> <span class="k">def</span> <span class="nf">release</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">):</span>
358 <span class="sd">""" Delete the session and logger topics. Then disconnect </span>
360 <span class="sd"> """</span>
361 <span class="k">if</span> <span class="n">hostname</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hostnames</span><span class="p">:</span>
362 <span class="bp">self</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
364 <div class="viewcode-block" id="OMF5API.disconnect"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf5_api.OMF5API.disconnect">[docs]</a> <span class="k">def</span> <span class="nf">disconnect</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="p">:</span>
365 <span class="sd">""" Delete the session and logger topics. Then disconnect </span>
367 <span class="sd"> """</span>
368 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_session_id</span><span class="p">)</span>
369 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_logger_session_id</span><span class="p">)</span>
371 <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
373 <span class="c"># Wait the send queue to be empty before disconnect</span>
374 <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">disconnect</span><span class="p">(</span><span class="n">wait</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
375 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Disconnected from XMPP Server"</span>
376 <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
377 </pre></div></div></div>
382 <div class="clearer"></div>
384 <div class="related">
387 <li class="right" style="margin-right: 10px">
388 <a href="../../../../genindex.html" title="General Index"
391 <a href="../../../../py-modindex.html" title="Python Module Index"
393 <li><a href="../../../../index.html">NEPI 3.2 documentation</a> »</li>
394 <li><a href="../../../index.html" >Module code</a> »</li>
398 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
399 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.