doc/sphinx/_build/html/_modules/nepi/resources/omf/omf6_api.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.omf.omf6_api &mdash; NEPI 3.2 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.2',
  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.2 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.2 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.omf.omf6_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 &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 <span class="c">#         Julien Tribino &lt;julien.tribino@inria.fr&gt;</span>
  85
  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>
  89
  90 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tsformat</span>
  91 <span class="kn">import</span> <span class="nn">os</span>
  92
  93 <span class="kn">from</span> <span class="nn">nepi.util.logger</span> <span class="kn">import</span> <span class="n">Logger</span>
  94
  95 <span class="kn">from</span> <span class="nn">nepi.resources.omf.omf_client</span> <span class="kn">import</span> <span class="n">OMFClient</span>
  96 <span class="kn">from</span> <span class="nn">nepi.resources.omf.messages_6</span> <span class="kn">import</span> <span class="n">MessageHandler</span>
  97
  98 <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>
  99     <span class="sd">&quot;&quot;&quot;</span>
 100 <span class="sd">    .. class:: Class Args :</span>
 101 <span class="sd">      </span>
 102 <span class="sd">        :param server: Xmpp Server</span>
 103 <span class="sd">        :type server: str</span>
 104 <span class="sd">        :param user: Xmpp User</span>
 105 <span class="sd">        :type user: str</span>
 106 <span class="sd">        :param port: Xmpp Port</span>
 107 <span class="sd">        :type port: str</span>
 108 <span class="sd">        :param password: Xmpp password</span>
 109 <span class="sd">        :type password: str</span>
 110 <span class="sd">        :param xmpp_root: Root of the Xmpp Topic Architecture</span>
 111 <span class="sd">        :type xmpp_root: str</span>
 112
 113 <span class="sd">    .. note::</span>
 114
 115 <span class="sd">       This class is the implementation of an OMF 5.4 API. </span>
 116 <span class="sd">       Since the version 5.4.1, the Topic Architecture start with OMF_5.4 </span>
 117 <span class="sd">       instead of OMF used for OMF5.3</span>
 118
 119 <span class="sd">    &quot;&quot;&quot;</span>
 120     <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">&quot;nepi&quot;</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s">&quot;5222&quot;</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="s">&quot;1234&quot;</span><span class="p">,</span>
 121             <span class="n">exp_id</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
 122         <span class="sd">&quot;&quot;&quot;</span>
 123 <span class="sd">        :param server: Xmpp Server</span>
 124 <span class="sd">        :type server: str</span>
 125 <span class="sd">        :param user: Xmpp User</span>
 126 <span class="sd">        :type user: str</span>
 127 <span class="sd">        :param port: Xmpp Port</span>
 128 <span class="sd">        :type port: str</span>
 129 <span class="sd">        :param password: Xmpp password</span>
 130 <span class="sd">        :type password: str</span>
 131 <span class="sd">        :param xmpp_root: Root of the Xmpp Topic Architecture</span>
 132 <span class="sd">        :type xmpp_root: str</span>
 133
 134 <span class="sd">        &quot;&quot;&quot;</span>
 135         <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">&quot;OMF6API&quot;</span><span class="p">)</span>
 136         <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>
 137         <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>
 138         <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>
 139         <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>
 140         <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>
 141         <span class="bp">self</span><span class="o">.</span><span class="n">_jid</span> <span class="o">=</span> <span class="s">&quot;</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">&quot;</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>
 142         <span class="bp">self</span><span class="o">.</span><span class="n">_src</span> <span class="o">=</span> <span class="s">&quot;xmpp://&quot;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_jid</span>
 143
 144         <span class="bp">self</span><span class="o">.</span><span class="n">_topics</span> <span class="o">=</span> <span class="p">[]</span>
 145
 146         <span class="c"># OMF xmpp client</span>
 147         <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="bp">None</span>
 148
 149         <span class="c"># message handler</span>
 150         <span class="bp">self</span><span class="o">.</span><span class="n">_message</span> <span class="o">=</span> <span class="bp">None</span>
 151
 152         <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">&lt;</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">0</span><span class="p">):</span>
 153             <span class="nb">reload</span><span class="p">(</span><span class="n">sys</span><span class="p">)</span>
 154             <span class="n">sys</span><span class="o">.</span><span class="n">setdefaultencoding</span><span class="p">(</span><span class="s">&#39;utf8&#39;</span><span class="p">)</span>
 155
 156         <span class="c"># instantiate the xmpp client</span>
 157         <span class="bp">self</span><span class="o">.</span><span class="n">_init_client</span><span class="p">()</span>
 158
 159         <span class="c"># register nepi topic</span>
 160         <span class="bp">self</span><span class="o">.</span><span class="n">_enroll_nepi</span><span class="p">()</span>
 161
 162
 163     <span class="k">def</span> <span class="nf">_init_client</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 164         <span class="sd">&quot;&quot;&quot; Initialize XMPP Client</span>
 165
 166 <span class="sd">        &quot;&quot;&quot;</span>
 167         <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>
 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>
 170
 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">_server</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="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>
 174             <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">xmpp</span>
 175             <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>
 176         <span class="k">else</span><span class="p">:</span>
 177             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Unable to connect to the XMPP server.&quot;</span>
 178             <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>
 179             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
 180
 181 <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>
 182         <span class="n">delay</span> <span class="o">=</span> <span class="mf">1.0</span>
 183         <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>
 184             <span class="k">if</span> <span class="n">xmpp</span><span class="o">.</span><span class="n">ready</span><span class="p">:</span>
 185                 <span class="k">break</span>
 186             <span class="k">else</span><span class="p">:</span>
 187                 <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>
 188                 <span class="n">delay</span> <span class="o">=</span> <span class="n">delay</span> <span class="o">*</span> <span class="mf">1.5</span>
 189         <span class="k">else</span><span class="p">:</span>
 190             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;XMPP Client is not ready after long time&quot;</span>
 191             <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>
 192             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 193 </div>
 194     <span class="nd">@property</span>
 195     <span class="k">def</span> <span class="nf">_nepi_topic</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 196         <span class="sd">&quot;&quot;&quot; Return the name of the session topic</span>
 197
 198 <span class="sd">        &quot;&quot;&quot;</span>
 199         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;nepi-&quot;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span>
 200         <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>
 201         <span class="k">return</span> <span class="n">msg</span>
 202
 203     <span class="k">def</span> <span class="nf">_enroll_nepi</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 204         <span class="sd">&quot;&quot;&quot; Create and Subscribe to the session Topic</span>
 205
 206 <span class="sd">        &quot;&quot;&quot;</span>
 207         <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>
 208         <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>
 209         <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>
 210
 211
 212 <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>
 213         <span class="sd">&quot;&quot;&quot; Create and Subscribe to the session topic and the resources</span>
 214 <span class="sd">            corresponding to the hostname</span>
 215
 216 <span class="sd">        :param hostname: Full hrn of the node</span>
 217 <span class="sd">        :type hostname: str</span>
 218
 219 <span class="sd">        &quot;&quot;&quot;</span>
 220         <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>
 221             <span class="k">return</span>
 222
 223         <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>
 224
 225         <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>
 226         <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>
 227
 228 </div>
 229 <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>
 230         <span class="sd">&quot;&quot;&quot; Create and Subscribe to the session topic and the resources</span>
 231 <span class="sd">            corresponding to the hostname</span>
 232
 233 <span class="sd">        &quot;&quot;&quot;</span>
 234         <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>
 235             <span class="k">return</span>
 236
 237         <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>
 238         <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>
 239
 240 </div>
 241 <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>
 242         <span class="sd">&quot;&quot;&quot; Publish an inform message</span>
 243
 244 <span class="sd">        &quot;&quot;&quot;</span>
 245         <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">&#39;hex&#39;</span><span class="p">)</span>
 246         <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
 247         <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>
 248
 249         <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>
 250 </div>
 251 <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>
 252         <span class="sd">&quot;&quot;&quot; Publish a configure message</span>
 253
 254 <span class="sd">        &quot;&quot;&quot;</span>
 255         <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">&#39;hex&#39;</span><span class="p">)</span>
 256         <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
 257         <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>
 258         <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>
 259
 260     </div>
 261 <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>
 262         <span class="sd">&quot;&quot;&quot; Publish a create message</span>
 263
 264 <span class="sd">        &quot;&quot;&quot;</span>
 265         <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
 266         <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>
 267         <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>
 268
 269 </div>
 270 <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>
 271         <span class="sd">&quot;&quot;&quot; Execute command on the node</span>
 272
 273 <span class="sd">        &quot;&quot;&quot;</span>
 274         <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">&#39;hex&#39;</span><span class="p">)</span>
 275         <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
 276         <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>
 277         <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>
 278 </div>
 279 <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>
 280         <span class="sd">&quot;&quot;&quot; Publish a release message</span>
 281
 282 <span class="sd">        &quot;&quot;&quot;</span>
 283         <span class="n">timestamp</span> <span class="o">=</span> <span class="n">tsformat</span><span class="p">()</span>
 284         <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>
 285         <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>
 286
 287         <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>
 288             <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>
 289
 290         <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>
 291         <span class="c">#self._client.delete(child)</span>
 292 </div>
 293 <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>
 294         <span class="sd">&quot;&quot;&quot; Check the mail box</span>
 295
 296 <span class="sd">        :param itype: type of mail</span>
 297 <span class="sd">        :type itype: str</span>
 298 <span class="sd">        :param attr: value wanted</span>
 299 <span class="sd">        :type attr: str</span>
 300
 301 <span class="sd">        &quot;&quot;&quot;</span>
 302         <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>
 303 </div>
 304 <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>
 305         <span class="sd">&quot;&quot;&quot; Create and Subscribe to the session topic and the resources</span>
 306 <span class="sd">            corresponding to the hostname</span>
 307
 308 <span class="sd">        &quot;&quot;&quot;</span>
 309         <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>
 310             <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>
 311         <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>
 312 </div>
 313 <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>
 314         <span class="sd">&quot;&quot;&quot; Delete the session and logger topics. Then disconnect </span>
 315
 316 <span class="sd">        &quot;&quot;&quot;</span>
 317         <span class="c"># To receive the last messages</span>
 318         <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>
 319
 320         <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>
 321
 322         <span class="c"># Wait the send queue to be empty before disconnect</span>
 323         <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>
 324         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Disconnected from XMPP Server&quot;</span>
 325         <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>
 326 </pre></div></div></div>
 327
 328           </div>
 329         </div>
 330       </div>
 331       <div class="clearer"></div>
 332     </div>
 333     <div class="related">
 334       <h3>Navigation</h3>
 335       <ul>
 336         <li class="right" style="margin-right: 10px">
 337           <a href="../../../../genindex.html" title="General Index"
 338              >index</a></li>
 339         <li class="right" >
 340           <a href="../../../../py-modindex.html" title="Python Module Index"
 341              >modules</a> |</li>
 342         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 343           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 344       </ul>
 345     </div>
 346     <div class="footer">
 347         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 348       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 349     </div>
 350   </body>
 351 </html>