--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.resources.omf.omf6_api — NEPI 3.0 documentation</title>
+
+ <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../../',
+ VERSION: '3.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../../_static/doctools.js"></script>
+ <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
+ <link rel="up" title="Module code" href="../../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.resources.omf.omf6_api</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
+<span class="c"># Julien Tribino <julien.tribino@inria.fr></span>
+
+<span class="kn">import</span> <span class="nn">ssl</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">time</span>
+
+<span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tsformat</span>
+<span class="kn">import</span> <span class="nn">os</span>
+
+<span class="kn">from</span> <span class="nn">nepi.util.logger</span> <span class="kn">import</span> <span class="n">Logger</span>
+
+<span class="kn">from</span> <span class="nn">nepi.resources.omf.omf_client</span> <span class="kn">import</span> <span class="n">OMFClient</span>
+<span class="kn">from</span> <span class="nn">nepi.resources.omf.messages_6</span> <span class="kn">import</span> <span class="n">MessageHandler</span>
+
+<div class="viewcode-block" id="OMF6API"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API">[docs]</a><span class="k">class</span> <span class="nc">OMF6API</span><span class="p">(</span><span class="n">Logger</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> .. class:: Class Args :</span>
+<span class="sd"> </span>
+<span class="sd"> :param server: Xmpp Server</span>
+<span class="sd"> :type server: str</span>
+<span class="sd"> :param user: Xmpp User</span>
+<span class="sd"> :type user: str</span>
+<span class="sd"> :param port: Xmpp Port</span>
+<span class="sd"> :type port: str</span>
+<span class="sd"> :param password: Xmpp password</span>
+<span class="sd"> :type password: str</span>
+<span class="sd"> :param xmpp_root: Root of the Xmpp Topic Architecture</span>
+<span class="sd"> :type xmpp_root: str</span>
+
+<span class="sd"> .. note::</span>
+
+<span class="sd"> This class is the implementation of an OMF 5.4 API. </span>
+<span class="sd"> Since the version 5.4.1, the Topic Architecture start with OMF_5.4 </span>
+<span class="sd"> instead of OMF used for OMF5.3</span>
+
+<span class="sd"> """</span>
+ <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">server</span><span class="p">,</span> <span class="n">user</span> <span class="o">=</span> <span class="s">"nepi"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s">"5222"</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="s">"1234"</span><span class="p">,</span>
+ <span class="n">exp_id</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> :param server: Xmpp Server</span>
+<span class="sd"> :type server: str</span>
+<span class="sd"> :param user: Xmpp User</span>
+<span class="sd"> :type user: str</span>
+<span class="sd"> :param port: Xmpp Port</span>
+<span class="sd"> :type port: str</span>
+<span class="sd"> :param password: Xmpp password</span>
+<span class="sd"> :type password: str</span>
+<span class="sd"> :param xmpp_root: Root of the Xmpp Topic Architecture</span>
+<span class="sd"> :type xmpp_root: str</span>
+
+<span class="sd"> """</span>
+ <span class="nb">super</span><span class="p">(</span><span class="n">OMF6API</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">"OMF6API"</span><span class="p">)</span>
+ <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>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_user</span> <span class="o">=</span> <span class="n">user</span> <span class="c"># name of the machine that run Nepi</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_server</span> <span class="o">=</span> <span class="n">server</span> <span class="c"># name of the xmpp server</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_port</span> <span class="o">=</span> <span class="n">port</span> <span class="c"># port of the xmpp server</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_password</span> <span class="o">=</span> <span class="n">password</span> <span class="c"># password to connect to xmpp</span>
+ <span class="bp">self</span><span class="o">.</span><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="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">_exp_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_src</span> <span class="o">=</span> <span class="s">"xmpp://"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_jid</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="c"># OMF xmpp client</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c"># message handler</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_message</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <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>
+ <span class="nb">reload</span><span class="p">(</span><span class="n">sys</span><span class="p">)</span>
+ <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>
+
+ <span class="c"># instantiate the xmpp client</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_init_client</span><span class="p">()</span>
+
+ <span class="c"># register nepi topic</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_enroll_nepi</span><span class="p">()</span>
+
+
+ <span class="k">def</span> <span class="nf">_init_client</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Initialize XMPP Client</span>
+
+<span class="sd"> """</span>
+ <span class="n">xmpp</span> <span class="o">=</span> <span class="n">OMFClient</span><span class="p">(</span><span class="bp">self</span><span class="o">.</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>
+ <span class="c"># PROTOCOL_SSLv3 required for compatibility with OpenFire</span>
+ <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>
+
+ <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">_server</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port</span><span class="p">)):</span>
+ <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>
+ <span class="bp">self</span><span class="o">.</span><span class="n">check_ready</span><span class="p">(</span><span class="n">xmpp</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">xmpp</span>
+ <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="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Unable to connect to the XMPP server."</span>
+ <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="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
+
+<div class="viewcode-block" id="OMF6API.check_ready"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.check_ready">[docs]</a> <span class="k">def</span> <span class="nf">check_ready</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xmpp</span><span class="p">):</span>
+ <span class="n">delay</span> <span class="o">=</span> <span class="mf">1.0</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">15</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">xmpp</span><span class="o">.</span><span class="n">ready</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span>
+ <span class="n">delay</span> <span class="o">=</span> <span class="n">delay</span> <span class="o">*</span> <span class="mf">1.5</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"XMPP Client is not ready after long time"</span>
+ <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="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
+</div>
+ <span class="nd">@property</span>
+ <span class="k">def</span> <span class="nf">_nepi_topic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Return the name of the session topic</span>
+
+<span class="sd"> """</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"nepi-"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span>
+ <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>
+ <span class="k">return</span> <span class="n">msg</span>
+
+ <span class="k">def</span> <span class="nf">_enroll_nepi</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Create and Subscribe to the session Topic</span>
+
+<span class="sd"> """</span>
+ <span class="n">nepi_topic</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_nepi_topic</span>
+ <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">nepi_topic</span><span class="p">)</span>
+ <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">nepi_topic</span><span class="p">)</span>
+
+
+<div class="viewcode-block" id="OMF6API.create_and_enroll_topic"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.create_and_enroll_topic">[docs]</a> <span class="k">def</span> <span class="nf">create_and_enroll_topic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">):</span>
+ <span class="sd">""" Create and Subscribe to the session topic and the resources</span>
+<span class="sd"> corresponding to the hostname</span>
+
+<span class="sd"> :param hostname: Full hrn of the node</span>
+<span class="sd"> :type hostname: str</span>
+
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">topic</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="p">:</span>
+ <span class="k">return</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">topic</span><span class="p">)</span>
+
+ <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">topic</span><span class="p">)</span>
+ <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">topic</span><span class="p">)</span>
+
+</div>
+<div class="viewcode-block" id="OMF6API.enroll_topic"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.enroll_topic">[docs]</a> <span class="k">def</span> <span class="nf">enroll_topic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">):</span>
+ <span class="sd">""" Create and Subscribe to the session topic and the resources</span>
+<span class="sd"> corresponding to the hostname</span>
+
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">topic</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="p">:</span>
+ <span class="k">return</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">topic</span><span class="p">)</span>
+ <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">topic</span><span class="p">)</span>
+
+</div>
+<div class="viewcode-block" id="OMF6API.frcp_inform"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.frcp_inform">[docs]</a> <span class="k">def</span> <span class="nf">frcp_inform</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">,</span> <span class="n">cid</span><span class="p">,</span> <span class="n">itype</span><span class="p">):</span>
+ <span class="sd">""" Publish an inform message</span>
+
+<span class="sd"> """</span>
+ <span class="n">msg_id</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">urandom</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'hex'</span><span class="p">)</span>
+ <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
+ <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">inform_function</span><span class="p">(</span><span class="n">msg_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_src</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="n">props</span> <span class="p">,</span><span class="n">guards</span> <span class="o">=</span> <span class="n">guards</span><span class="p">)</span>
+
+ <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>
+</div>
+<div class="viewcode-block" id="OMF6API.frcp_configure"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.frcp_configure">[docs]</a> <span class="k">def</span> <span class="nf">frcp_configure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span> <span class="p">):</span>
+ <span class="sd">""" Publish a configure message</span>
+
+<span class="sd"> """</span>
+ <span class="n">msg_id</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">urandom</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'hex'</span><span class="p">)</span>
+ <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
+ <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">msg_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_src</span><span class="p">,</span> <span class="n">timestamp</span> <span class="p">,</span><span class="n">props</span> <span class="o">=</span> <span class="n">props</span> <span class="p">,</span><span class="n">guards</span> <span class="o">=</span> <span class="n">guards</span><span class="p">)</span>
+ <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">topic</span><span class="p">)</span>
+
+ </div>
+<div class="viewcode-block" id="OMF6API.frcp_create"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.frcp_create">[docs]</a> <span class="k">def</span> <span class="nf">frcp_create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">,</span> <span class="n">topic</span><span class="p">,</span> <span class="n">rtype</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span> <span class="p">):</span>
+ <span class="sd">""" Publish a create message</span>
+
+<span class="sd"> """</span>
+ <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
+ <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">create_function</span><span class="p">(</span><span class="n">msg_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_src</span><span class="p">,</span> <span class="n">rtype</span><span class="p">,</span> <span class="n">timestamp</span> <span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="n">props</span> <span class="p">,</span><span class="n">guards</span> <span class="o">=</span> <span class="n">guards</span><span class="p">)</span>
+ <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">topic</span><span class="p">)</span>
+
+</div>
+<div class="viewcode-block" id="OMF6API.frcp_request"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.frcp_request">[docs]</a> <span class="k">def</span> <span class="nf">frcp_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span> <span class="p">):</span>
+ <span class="sd">""" Execute command on the node</span>
+
+<span class="sd"> """</span>
+ <span class="n">msg_id</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">urandom</span><span class="p">(</span><span class="mi">16</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'hex'</span><span class="p">)</span>
+ <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
+ <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">request_function</span><span class="p">(</span><span class="n">msg_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_src</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="n">props</span> <span class="p">,</span><span class="n">guards</span> <span class="o">=</span> <span class="n">guards</span><span class="p">)</span>
+ <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>
+</div>
+<div class="viewcode-block" id="OMF6API.frcp_release"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.frcp_release">[docs]</a> <span class="k">def</span> <span class="nf">frcp_release</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">child</span><span class="p">,</span> <span class="n">res_id</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span> <span class="p">):</span>
+ <span class="sd">""" Publish a release message</span>
+
+<span class="sd"> """</span>
+ <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
+ <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">release_function</span><span class="p">(</span><span class="n">msg_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_src</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">res_id</span> <span class="o">=</span> <span class="n">res_id</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="n">props</span> <span class="p">,</span><span class="n">guards</span> <span class="o">=</span> <span class="n">guards</span><span class="p">)</span>
+ <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">parent</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">child</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">child</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">(</span><span class="n">child</span><span class="p">)</span>
+ <span class="c">#self._client.delete(child)</span>
+</div>
+<div class="viewcode-block" id="OMF6API.check_mailbox"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.check_mailbox">[docs]</a> <span class="k">def</span> <span class="nf">check_mailbox</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">itype</span><span class="p">,</span> <span class="n">attr</span><span class="p">):</span>
+ <span class="sd">""" Check the mail box</span>
+
+<span class="sd"> :param itype: type of mail</span>
+<span class="sd"> :type itype: str</span>
+<span class="sd"> :param attr: value wanted</span>
+<span class="sd"> :type attr: str</span>
+
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">check_mailbox</span><span class="p">(</span><span class="n">itype</span><span class="p">,</span> <span class="n">attr</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="OMF6API.unenroll_topic"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.unenroll_topic">[docs]</a> <span class="k">def</span> <span class="nf">unenroll_topic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topic</span><span class="p">):</span>
+ <span class="sd">""" Create and Subscribe to the session topic and the resources</span>
+<span class="sd"> corresponding to the hostname</span>
+
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">topic</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">topic</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">(</span><span class="n">topic</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="OMF6API.disconnect"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.omf6_api.OMF6API.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>
+ <span class="sd">""" Delete the session and logger topics. Then disconnect </span>
+
+<span class="sd"> """</span>
+ <span class="c"># To receive the last messages</span>
+ <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
+
+ <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">_nepi_topic</span><span class="p">)</span>
+
+ <span class="c"># Wait the send queue to be empty before disconnect</span>
+ <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>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">" Disconnected from XMPP Server"</span>
+ <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>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
git://git.onelab.eu / nepi.git / blobdiff