doc/sphinx/_build/html/_layout/nepi.resources.omf.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 package &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   </head>
  28   <body>
  29     <div class="related">
  30       <h3>Navigation</h3>
  31       <ul>
  32         <li class="right" style="margin-right: 10px">
  33           <a href="../genindex.html" title="General Index"
  34              accesskey="I">index</a></li>
  35         <li class="right" >
  36           <a href="../py-modindex.html" title="Python Module Index"
  37              >modules</a> |</li>
  38         <li><a href="../index.html">NEPI 3.2 documentation</a> &raquo;</li>
  39       </ul>
  40     </div>
  41       <div class="sphinxsidebar">
  42         <div class="sphinxsidebarwrapper">
  43   <h3><a href="../index.html">Table Of Contents</a></h3>
  44   <ul>
  45 <li><a class="reference internal" href="#">nepi.resources.omf package</a><ul>
  46 <li><a class="reference internal" href="#submodules">Submodules</a></li>
  47 <li><a class="reference internal" href="#module-nepi.resources.omf.application">nepi.resources.omf.application module</a></li>
  48 <li><a class="reference internal" href="#module-nepi.resources.omf.channel">nepi.resources.omf.channel module</a></li>
  49 <li><a class="reference internal" href="#module-nepi.resources.omf.interface">nepi.resources.omf.interface module</a></li>
  50 <li><a class="reference internal" href="#module-nepi.resources.omf.messages_5_4">nepi.resources.omf.messages_5_4 module</a></li>
  51 <li><a class="reference internal" href="#module-nepi.resources.omf.messages_6">nepi.resources.omf.messages_6 module</a></li>
  52 <li><a class="reference internal" href="#module-nepi.resources.omf.node">nepi.resources.omf.node module</a></li>
  53 <li><a class="reference internal" href="#module-nepi.resources.omf.omf5_api">nepi.resources.omf.omf5_api module</a></li>
  54 <li><a class="reference internal" href="#module-nepi.resources.omf.omf6_api">nepi.resources.omf.omf6_api module</a></li>
  55 <li><a class="reference internal" href="#module-nepi.resources.omf.omf6_parser">nepi.resources.omf.omf6_parser module</a></li>
  56 <li><a class="reference internal" href="#module-nepi.resources.omf.omf_api_factory">nepi.resources.omf.omf_api_factory module</a></li>
  57 <li><a class="reference internal" href="#module-nepi.resources.omf.omf_client">nepi.resources.omf.omf_client module</a></li>
  58 <li><a class="reference internal" href="#module-nepi.resources.omf.omf_resource">nepi.resources.omf.omf_resource module</a></li>
  59 <li><a class="reference internal" href="#module-nepi.resources.omf.wilabt_node">nepi.resources.omf.wilabt_node module</a></li>
  60 <li><a class="reference internal" href="#module-nepi.resources.omf">Module contents</a></li>
  61 </ul>
  62 </li>
  63 </ul>
  64
  65   <h3>This Page</h3>
  66   <ul class="this-page-menu">
  67     <li><a href="../_sources/_layout/nepi.resources.omf.txt"
  68            rel="nofollow">Show Source</a></li>
  69   </ul>
  70 <div id="searchbox" style="display: none">
  71   <h3>Quick search</h3>
  72     <form class="search" action="../search.html" method="get">
  73       <input type="text" name="q" />
  74       <input type="submit" value="Go" />
  75       <input type="hidden" name="check_keywords" value="yes" />
  76       <input type="hidden" name="area" value="default" />
  77     </form>
  78     <p class="searchtip" style="font-size: 90%">
  79     Enter search terms or a module, class or function name.
  80     </p>
  81 </div>
  82 <script type="text/javascript">$('#searchbox').show(0);</script>
  83         </div>
  84       </div>
  85
  86     <div class="document">
  87       <div class="documentwrapper">
  88         <div class="bodywrapper">
  89           <div class="body">
  90
  91   <div class="section" id="nepi-resources-omf-package">
  92 <h1>nepi.resources.omf package<a class="headerlink" href="#nepi-resources-omf-package" title="Permalink to this headline">¶</a></h1>
  93 <div class="section" id="submodules">
  94 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  95 </div>
  96 <div class="section" id="module-nepi.resources.omf.application">
  97 <span id="nepi-resources-omf-application-module"></span><h2>nepi.resources.omf.application module<a class="headerlink" href="#module-nepi.resources.omf.application" title="Permalink to this headline">¶</a></h2>
  98 <dl class="class">
  99 <dt id="nepi.resources.omf.application.OMFApplication">
 100 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.application.</tt><tt class="descname">OMFApplication</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication" title="Permalink to this definition">¶</a></dt>
 101 <dd><p>Bases: <a class="reference internal" href="#nepi.resources.omf.omf_resource.OMFResource" title="nepi.resources.omf.omf_resource.OMFResource"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.omf.omf_resource.OMFResource</span></tt></a></p>
 102 <dl class="class">
 103 <dt>
 104 <tt class="descname">Class Args :</tt></dt>
 105 <dd><table class="docutils field-list" frame="void" rules="none">
 106 <col class="field-name" />
 107 <col class="field-body" />
 108 <tbody valign="top">
 109 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 110 <li><strong>ec</strong> (<em>ExperimentController</em>) &#8211; The Experiment controller</li>
 111 <li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; guid of the RM</li>
 112 </ul>
 113 </td>
 114 </tr>
 115 </tbody>
 116 </table>
 117 </dd></dl>
 118
 119 <dl class="method">
 120 <dt id="nepi.resources.omf.application.OMFApplication.add_set_hook">
 121 <tt class="descname">add_set_hook</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.add_set_hook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.add_set_hook" title="Permalink to this definition">¶</a></dt>
 122 <dd><p>Initialize the hooks for OMF 5.4 only</p>
 123 </dd></dl>
 124
 125 <dl class="method">
 126 <dt id="nepi.resources.omf.application.OMFApplication.check_deploy">
 127 <tt class="descname">check_deploy</tt><big>(</big><em>cid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.check_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.check_deploy" title="Permalink to this definition">¶</a></dt>
 128 <dd><p>Check, through the mail box in the parser,
 129 if the confirmation of the creation has been received</p>
 130 <table class="docutils field-list" frame="void" rules="none">
 131 <col class="field-name" />
 132 <col class="field-body" />
 133 <tbody valign="top">
 134 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cid</strong> &#8211; the id of the original message</td>
 135 </tr>
 136 </tbody>
 137 </table>
 138 </dd></dl>
 139
 140 <dl class="method">
 141 <dt id="nepi.resources.omf.application.OMFApplication.check_release">
 142 <tt class="descname">check_release</tt><big>(</big><em>cid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.check_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.check_release" title="Permalink to this definition">¶</a></dt>
 143 <dd><p>Check, through the mail box in the parser,
 144 if the confirmation of the release has been received</p>
 145 <table class="docutils field-list" frame="void" rules="none">
 146 <col class="field-name" />
 147 <col class="field-body" />
 148 <tbody valign="top">
 149 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cid</strong> &#8211; the id of the original message</td>
 150 </tr>
 151 </tbody>
 152 </table>
 153 </dd></dl>
 154
 155 <dl class="method">
 156 <dt id="nepi.resources.omf.application.OMFApplication.check_start">
 157 <tt class="descname">check_start</tt><big>(</big><em>uid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.check_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.check_start" title="Permalink to this definition">¶</a></dt>
 158 <dd><p>Check, through the mail box in the parser,
 159 if the confirmation of the start has been received</p>
 160 <table class="docutils field-list" frame="void" rules="none">
 161 <col class="field-name" />
 162 <col class="field-body" />
 163 <tbody valign="top">
 164 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>uid</strong> &#8211; the id of the original message</td>
 165 </tr>
 166 </tbody>
 167 </table>
 168 </dd></dl>
 169
 170 <dl class="method">
 171 <dt id="nepi.resources.omf.application.OMFApplication.do_deploy">
 172 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.do_deploy" title="Permalink to this definition">¶</a></dt>
 173 <dd><p>Deploy the RM. It means nothing special for an application
 174 for now (later it will be upload sources, ...)
 175 It becomes DEPLOYED after the topic for the application has been created</p>
 176 </dd></dl>
 177
 178 <dl class="method">
 179 <dt id="nepi.resources.omf.application.OMFApplication.do_release">
 180 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.do_release" title="Permalink to this definition">¶</a></dt>
 181 <dd><p>Clean the RM at the end of the experiment and release the API.</p>
 182 </dd></dl>
 183
 184 <dl class="method">
 185 <dt id="nepi.resources.omf.application.OMFApplication.do_start">
 186 <tt class="descname">do_start</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.do_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.do_start" title="Permalink to this definition">¶</a></dt>
 187 <dd><p>Start the RM. It means : Send Xmpp Message Using OMF protocol
 188 to execute the application.</p>
 189 </dd></dl>
 190
 191 <dl class="method">
 192 <dt id="nepi.resources.omf.application.OMFApplication.do_stop">
 193 <tt class="descname">do_stop</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.do_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.do_stop" title="Permalink to this definition">¶</a></dt>
 194 <dd><p>Stop the RM. It means : Send Xmpp Message Using OMF protocol to
 195 kill the application.
 196 State is set to STOPPED after the message is sent.</p>
 197 </dd></dl>
 198
 199 <dl class="attribute">
 200 <dt id="nepi.resources.omf.application.OMFApplication.exp_id">
 201 <tt class="descname">exp_id</tt><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.exp_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.exp_id" title="Permalink to this definition">¶</a></dt>
 202 <dd></dd></dl>
 203
 204 <dl class="attribute">
 205 <dt id="nepi.resources.omf.application.OMFApplication.node">
 206 <tt class="descname">node</tt><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.node" title="Permalink to this definition">¶</a></dt>
 207 <dd></dd></dl>
 208
 209 <dl class="method">
 210 <dt id="nepi.resources.omf.application.OMFApplication.stdin_hook">
 211 <tt class="descname">stdin_hook</tt><big>(</big><em>old_value</em>, <em>new_value</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.stdin_hook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.stdin_hook" title="Permalink to this definition">¶</a></dt>
 212 <dd><p>Set a hook to the stdin attribute in order to send a message at each time
 213 the value of this parameter is changed. Used ofr OMF 5.4 only</p>
 214 </dd></dl>
 215
 216 <dl class="method">
 217 <dt id="nepi.resources.omf.application.OMFApplication.trace">
 218 <tt class="descname">trace</tt><big>(</big><em>name</em>, <em>attr='all'</em>, <em>block=512</em>, <em>offset=0</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.trace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.trace" title="Permalink to this definition">¶</a></dt>
 219 <dd></dd></dl>
 220
 221 <dl class="method">
 222 <dt id="nepi.resources.omf.application.OMFApplication.valid_connection">
 223 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/application.html#OMFApplication.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.application.OMFApplication.valid_connection" title="Permalink to this definition">¶</a></dt>
 224 <dd><p>Check if the connection with the guid in parameter is possible.
 225 Only meaningful connections are allowed.</p>
 226 <table class="docutils field-list" frame="void" rules="none">
 227 <col class="field-name" />
 228 <col class="field-body" />
 229 <tbody valign="top">
 230 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of RM it will be connected</td>
 231 </tr>
 232 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
 233 </tr>
 234 </tbody>
 235 </table>
 236 </dd></dl>
 237
 238 </dd></dl>
 239
 240 </div>
 241 <div class="section" id="module-nepi.resources.omf.channel">
 242 <span id="nepi-resources-omf-channel-module"></span><h2>nepi.resources.omf.channel module<a class="headerlink" href="#module-nepi.resources.omf.channel" title="Permalink to this headline">¶</a></h2>
 243 <dl class="class">
 244 <dt id="nepi.resources.omf.channel.OMFChannel">
 245 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.channel.</tt><tt class="descname">OMFChannel</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/channel.html#OMFChannel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.channel.OMFChannel" title="Permalink to this definition">¶</a></dt>
 246 <dd><p>Bases: <a class="reference internal" href="#nepi.resources.omf.omf_resource.OMFResource" title="nepi.resources.omf.omf_resource.OMFResource"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.omf.omf_resource.OMFResource</span></tt></a></p>
 247 <dl class="class">
 248 <dt>
 249 <tt class="descname">Class Args :</tt></dt>
 250 <dd><table class="docutils field-list" frame="void" rules="none">
 251 <col class="field-name" />
 252 <col class="field-body" />
 253 <tbody valign="top">
 254 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 255 <li><strong>ec</strong> (<em>ExperimentController</em>) &#8211; The Experiment controller</li>
 256 <li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; guid of the RM</li>
 257 <li><strong>creds</strong> (<a class="reference external" href="http://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; Credentials to communicate with the rm (XmppClient for OMF)</li>
 258 </ul>
 259 </td>
 260 </tr>
 261 </tbody>
 262 </table>
 263 </dd></dl>
 264
 265 <dl class="attribute">
 266 <dt id="nepi.resources.omf.channel.OMFChannel.ChannelToFreq">
 267 <tt class="descname">ChannelToFreq</tt><em class="property"> = {'11': '2462', '10': '2457', '13': '2472', '12': '2467', '1': '2412', '3': '2422', '2': '2417', '5': '2432', '4': '2427', '7': '2442', '6': '2437', '9': '2452', '8': '2447'}</em><a class="headerlink" href="#nepi.resources.omf.channel.OMFChannel.ChannelToFreq" title="Permalink to this definition">¶</a></dt>
 268 <dd></dd></dl>
 269
 270 <dl class="method">
 271 <dt id="nepi.resources.omf.channel.OMFChannel.do_deploy">
 272 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/channel.html#OMFChannel.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.channel.OMFChannel.do_deploy" title="Permalink to this definition">¶</a></dt>
 273 <dd><p>Deploy the RM. It means : Get the xmpp client and send messages
 274 using OMF 5.4 or 6 protocol to configure the channel.</p>
 275 </dd></dl>
 276
 277 <dl class="method">
 278 <dt id="nepi.resources.omf.channel.OMFChannel.do_release">
 279 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/channel.html#OMFChannel.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.channel.OMFChannel.do_release" title="Permalink to this definition">¶</a></dt>
 280 <dd><p>Clean the RM at the end of the experiment and release the API</p>
 281 </dd></dl>
 282
 283 <dl class="attribute">
 284 <dt id="nepi.resources.omf.channel.OMFChannel.exp_id">
 285 <tt class="descname">exp_id</tt><a class="reference internal" href="../_modules/nepi/resources/omf/channel.html#OMFChannel.exp_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.channel.OMFChannel.exp_id" title="Permalink to this definition">¶</a></dt>
 286 <dd></dd></dl>
 287
 288 <dl class="method">
 289 <dt id="nepi.resources.omf.channel.OMFChannel.get_frequency">
 290 <tt class="descname">get_frequency</tt><big>(</big><em>channel</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/channel.html#OMFChannel.get_frequency"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.channel.OMFChannel.get_frequency" title="Permalink to this definition">¶</a></dt>
 291 <dd><p>Returns the frequency of a specific channel number</p>
 292 </dd></dl>
 293
 294 <dl class="method">
 295 <dt id="nepi.resources.omf.channel.OMFChannel.valid_connection">
 296 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/channel.html#OMFChannel.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.channel.OMFChannel.valid_connection" title="Permalink to this definition">¶</a></dt>
 297 <dd><p>Check if the connection with the guid in parameter is possible.
 298 Only meaningful connections are allowed.</p>
 299 <table class="docutils field-list" frame="void" rules="none">
 300 <col class="field-name" />
 301 <col class="field-body" />
 302 <tbody valign="top">
 303 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the current RM</td>
 304 </tr>
 305 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
 306 </tr>
 307 </tbody>
 308 </table>
 309 </dd></dl>
 310
 311 </dd></dl>
 312
 313 </div>
 314 <div class="section" id="module-nepi.resources.omf.interface">
 315 <span id="nepi-resources-omf-interface-module"></span><h2>nepi.resources.omf.interface module<a class="headerlink" href="#module-nepi.resources.omf.interface" title="Permalink to this headline">¶</a></h2>
 316 <dl class="class">
 317 <dt id="nepi.resources.omf.interface.OMFWifiInterface">
 318 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.interface.</tt><tt class="descname">OMFWifiInterface</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface" title="Permalink to this definition">¶</a></dt>
 319 <dd><p>Bases: <a class="reference internal" href="#nepi.resources.omf.omf_resource.OMFResource" title="nepi.resources.omf.omf_resource.OMFResource"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.omf.omf_resource.OMFResource</span></tt></a></p>
 320 <dl class="class">
 321 <dt>
 322 <tt class="descname">Class Args :</tt></dt>
 323 <dd><table class="docutils field-list" frame="void" rules="none">
 324 <col class="field-name" />
 325 <col class="field-body" />
 326 <tbody valign="top">
 327 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 328 <li><strong>ec</strong> (<em>ExperimentController</em>) &#8211; The Experiment controller</li>
 329 <li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; guid of the RM</li>
 330 </ul>
 331 </td>
 332 </tr>
 333 </tbody>
 334 </table>
 335 </dd></dl>
 336
 337 <dl class="attribute">
 338 <dt id="nepi.resources.omf.interface.OMFWifiInterface.channel">
 339 <tt class="descname">channel</tt><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.channel" title="Permalink to this definition">¶</a></dt>
 340 <dd></dd></dl>
 341
 342 <dl class="method">
 343 <dt id="nepi.resources.omf.interface.OMFWifiInterface.check_deploy">
 344 <tt class="descname">check_deploy</tt><big>(</big><em>cid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.check_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.check_deploy" title="Permalink to this definition">¶</a></dt>
 345 <dd><p>Check, through the mail box in the parser,
 346 if the confirmation of the creation has been received</p>
 347 <table class="docutils field-list" frame="void" rules="none">
 348 <col class="field-name" />
 349 <col class="field-body" />
 350 <tbody valign="top">
 351 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cid</strong> &#8211; the id of the original message</td>
 352 </tr>
 353 </tbody>
 354 </table>
 355 </dd></dl>
 356
 357 <dl class="method">
 358 <dt id="nepi.resources.omf.interface.OMFWifiInterface.check_release">
 359 <tt class="descname">check_release</tt><big>(</big><em>cid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.check_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.check_release" title="Permalink to this definition">¶</a></dt>
 360 <dd><p>Check, through the mail box in the parser,
 361 if the confirmation of the release has been received</p>
 362 <table class="docutils field-list" frame="void" rules="none">
 363 <col class="field-name" />
 364 <col class="field-body" />
 365 <tbody valign="top">
 366 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cid</strong> &#8211; the id of the original message</td>
 367 </tr>
 368 </tbody>
 369 </table>
 370 </dd></dl>
 371
 372 <dl class="method">
 373 <dt id="nepi.resources.omf.interface.OMFWifiInterface.configure_iface">
 374 <tt class="descname">configure_iface</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.configure_iface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.configure_iface" title="Permalink to this definition">¶</a></dt>
 375 <dd><p>Configure the interface without the ip</p>
 376 </dd></dl>
 377
 378 <dl class="method">
 379 <dt id="nepi.resources.omf.interface.OMFWifiInterface.configure_ip">
 380 <tt class="descname">configure_ip</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.configure_ip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.configure_ip" title="Permalink to this definition">¶</a></dt>
 381 <dd><p>Configure the ip of the interface</p>
 382 <p>CELL ID shraing problem. By putting th ip at the end of the configuration,
 383 each node use the same channel and can then share the same CELL ID.
 384 In the second case, the channel is defined at the end and the node don&#8217;t
 385 share a common CELL ID and can not communicate.</p>
 386 </dd></dl>
 387
 388 <dl class="method">
 389 <dt id="nepi.resources.omf.interface.OMFWifiInterface.configure_on_omf5">
 390 <tt class="descname">configure_on_omf5</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.configure_on_omf5"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.configure_on_omf5" title="Permalink to this definition">¶</a></dt>
 391 <dd><p>Method to configure the wifi interface when OMF 5.4 is used.</p>
 392 </dd></dl>
 393
 394 <dl class="method">
 395 <dt id="nepi.resources.omf.interface.OMFWifiInterface.configure_on_omf6">
 396 <tt class="descname">configure_on_omf6</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.configure_on_omf6"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.configure_on_omf6" title="Permalink to this definition">¶</a></dt>
 397 <dd><p>Method to configure the wifi interface when OMF 6 is used.</p>
 398 </dd></dl>
 399
 400 <dl class="method">
 401 <dt id="nepi.resources.omf.interface.OMFWifiInterface.do_deploy">
 402 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.do_deploy" title="Permalink to this definition">¶</a></dt>
 403 <dd><p>Deploy the RM. It means : Get the xmpp client and send messages
 404 using OMF 5.4 or 6 protocol to configure the interface.</p>
 405 </dd></dl>
 406
 407 <dl class="method">
 408 <dt id="nepi.resources.omf.interface.OMFWifiInterface.do_release">
 409 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.do_release" title="Permalink to this definition">¶</a></dt>
 410 <dd><p>Clean the RM at the end of the experiment and release the API</p>
 411 </dd></dl>
 412
 413 <dl class="attribute">
 414 <dt id="nepi.resources.omf.interface.OMFWifiInterface.exp_id">
 415 <tt class="descname">exp_id</tt><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.exp_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.exp_id" title="Permalink to this definition">¶</a></dt>
 416 <dd></dd></dl>
 417
 418 <dl class="attribute">
 419 <dt id="nepi.resources.omf.interface.OMFWifiInterface.node">
 420 <tt class="descname">node</tt><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.node" title="Permalink to this definition">¶</a></dt>
 421 <dd></dd></dl>
 422
 423 <dl class="method">
 424 <dt id="nepi.resources.omf.interface.OMFWifiInterface.valid_connection">
 425 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/interface.html#OMFWifiInterface.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.interface.OMFWifiInterface.valid_connection" title="Permalink to this definition">¶</a></dt>
 426 <dd><p>Check if the connection with the guid in parameter is possible.
 427 Only meaningful connections are allowed.</p>
 428 <table class="docutils field-list" frame="void" rules="none">
 429 <col class="field-name" />
 430 <col class="field-body" />
 431 <tbody valign="top">
 432 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the current RM</td>
 433 </tr>
 434 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
 435 </tr>
 436 </tbody>
 437 </table>
 438 </dd></dl>
 439
 440 </dd></dl>
 441
 442 </div>
 443 <div class="section" id="module-nepi.resources.omf.messages_5_4">
 444 <span id="nepi-resources-omf-messages-5-4-module"></span><h2>nepi.resources.omf.messages_5_4 module<a class="headerlink" href="#module-nepi.resources.omf.messages_5_4" title="Permalink to this headline">¶</a></h2>
 445 <dl class="class">
 446 <dt id="nepi.resources.omf.messages_5_4.MessageHandler">
 447 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.messages_5_4.</tt><tt class="descname">MessageHandler</tt><big>(</big><em>sliceid</em>, <em>expid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler" title="Permalink to this definition">¶</a></dt>
 448 <dd><dl class="class">
 449 <dt>
 450 <tt class="descname">Class Args :</tt></dt>
 451 <dd><table class="docutils field-list" frame="void" rules="none">
 452 <col class="field-name" />
 453 <col class="field-body" />
 454 <tbody valign="top">
 455 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 456 <li><strong>sliceid</strong> &#8211; Slice Name (= Xmpp Slice)</li>
 457 <li><strong>expid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Experiment ID (= Xmpp User)</li>
 458 </ul>
 459 </td>
 460 </tr>
 461 </tbody>
 462 </table>
 463 </dd></dl>
 464
 465 <div class="admonition note">
 466 <p class="first admonition-title">Note</p>
 467 <p class="last">This class is used only for OMF 5.4 Protocol and is going to become unused</p>
 468 </div>
 469 <dl class="method">
 470 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.alias_function">
 471 <tt class="descname">alias_function</tt><big>(</big><em>name</em>, <em>target</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.alias_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.alias_function" title="Permalink to this definition">¶</a></dt>
 472 <dd><p>Build an Alias Message</p>
 473 <table class="docutils field-list" frame="void" rules="none">
 474 <col class="field-name" />
 475 <col class="field-body" />
 476 <tbody valign="top">
 477 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 478 <li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the new alias</li>
 479 <li><strong>target</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hrn of the target node (ex : omf.plexus.wlab17)</li>
 480 </ul>
 481 </td>
 482 </tr>
 483 </tbody>
 484 </table>
 485 </dd></dl>
 486
 487 <dl class="method">
 488 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.configure_function">
 489 <tt class="descname">configure_function</tt><big>(</big><em>target</em>, <em>value</em>, <em>path</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.configure_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.configure_function" title="Permalink to this definition">¶</a></dt>
 490 <dd><p>Build a Configure Message</p>
 491 <table class="docutils field-list" frame="void" rules="none">
 492 <col class="field-name" />
 493 <col class="field-body" />
 494 <tbody valign="top">
 495 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 496 <li><strong>target</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hrn of the target node (ex : omf.plexus.wlab17)</li>
 497 <li><strong>value</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; guid of the RM</li>
 498 <li><strong>path</strong> (<a class="reference external" href="http://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; Path of the element to configure (ex : net/w0/channel)</li>
 499 </ul>
 500 </td>
 501 </tr>
 502 </tbody>
 503 </table>
 504 </dd></dl>
 505
 506 <dl class="method">
 507 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.enroll_function">
 508 <tt class="descname">enroll_function</tt><big>(</big><em>enrollkey</em>, <em>image</em>, <em>index</em>, <em>target</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.enroll_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.enroll_function" title="Permalink to this definition">¶</a></dt>
 509 <dd><p>Build an Enroll Message</p>
 510 <table class="docutils field-list" frame="void" rules="none">
 511 <col class="field-name" />
 512 <col class="field-body" />
 513 <tbody valign="top">
 514 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 515 <li><strong>enrollkey</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Type of enrollment (= 1)</li>
 516 <li><strong>image</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Image (= * when all the nodes are concerned)</li>
 517 <li><strong>index</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Index (= 1 in general)</li>
 518 <li><strong>target</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hrn of the target node (ex : omf.plexus.wlab17)</li>
 519 </ul>
 520 </td>
 521 </tr>
 522 </tbody>
 523 </table>
 524 </dd></dl>
 525
 526 <dl class="method">
 527 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.execute_function">
 528 <tt class="descname">execute_function</tt><big>(</big><em>target</em>, <em>appid</em>, <em>cmdlineargs</em>, <em>path</em>, <em>env</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.execute_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.execute_function" title="Permalink to this definition">¶</a></dt>
 529 <dd><p>Build an Execute Message</p>
 530 <table class="docutils field-list" frame="void" rules="none">
 531 <col class="field-name" />
 532 <col class="field-body" />
 533 <tbody valign="top">
 534 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 535 <li><strong>target</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hrn of the target node (ex : omf.plexus.wlab17)</li>
 536 <li><strong>appid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Application id</li>
 537 <li><strong>cmdlineargs</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Arguments of the application</li>
 538 <li><strong>path</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Path of the application</li>
 539 <li><strong>env</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Environment variables</li>
 540 </ul>
 541 </td>
 542 </tr>
 543 </tbody>
 544 </table>
 545 </dd></dl>
 546
 547 <dl class="method">
 548 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.exit_function">
 549 <tt class="descname">exit_function</tt><big>(</big><em>target</em>, <em>appid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.exit_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.exit_function" title="Permalink to this definition">¶</a></dt>
 550 <dd><p>Build an Exit Message</p>
 551 <table class="docutils field-list" frame="void" rules="none">
 552 <col class="field-name" />
 553 <col class="field-body" />
 554 <tbody valign="top">
 555 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 556 <li><strong>target</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hrn of the target node (ex : omf.plexus.wlab17)</li>
 557 <li><strong>appid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Application id (ex : vlc#1)</li>
 558 </ul>
 559 </td>
 560 </tr>
 561 </tbody>
 562 </table>
 563 </dd></dl>
 564
 565 <dl class="method">
 566 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.log_function">
 567 <tt class="descname">log_function</tt><big>(</big><em>level</em>, <em>logger</em>, <em>level_name</em>, <em>data</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.log_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.log_function" title="Permalink to this definition">¶</a></dt>
 568 <dd><p>Build a Log Message</p>
 569 <table class="docutils field-list" frame="void" rules="none">
 570 <col class="field-name" />
 571 <col class="field-body" />
 572 <tbody valign="top">
 573 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 574 <li><strong>level</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Level of logging</li>
 575 <li><strong>logger</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Element publishing the log</li>
 576 <li><strong>level_name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the level (ex : INFO)</li>
 577 <li><strong>data</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Content to publish</li>
 578 </ul>
 579 </td>
 580 </tr>
 581 </tbody>
 582 </table>
 583 </dd></dl>
 584
 585 <dl class="method">
 586 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.newexp_function">
 587 <tt class="descname">newexp_function</tt><big>(</big><em>experimentid</em>, <em>address</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.newexp_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.newexp_function" title="Permalink to this definition">¶</a></dt>
 588 <dd><p>Build a NewExp Message</p>
 589 <table class="docutils field-list" frame="void" rules="none">
 590 <col class="field-name" />
 591 <col class="field-body" />
 592 <tbody valign="top">
 593 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 594 <li><strong>experimentid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the new experiment</li>
 595 <li><strong>address</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Adress of the destination set of nodes</li>
 596 </ul>
 597 </td>
 598 </tr>
 599 </tbody>
 600 </table>
 601 </dd></dl>
 602
 603 <dl class="method">
 604 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.noop_function">
 605 <tt class="descname">noop_function</tt><big>(</big><em>target</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.noop_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.noop_function" title="Permalink to this definition">¶</a></dt>
 606 <dd><p>Build a Noop Message</p>
 607 <table class="docutils field-list" frame="void" rules="none">
 608 <col class="field-name" />
 609 <col class="field-body" />
 610 <tbody valign="top">
 611 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>target</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hrn of the target node (ex : omf.plexus.wlab17)</td>
 612 </tr>
 613 </tbody>
 614 </table>
 615 </dd></dl>
 616
 617 <dl class="method">
 618 <dt id="nepi.resources.omf.messages_5_4.MessageHandler.stdin_function">
 619 <tt class="descname">stdin_function</tt><big>(</big><em>target</em>, <em>value</em>, <em>appid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_5_4.html#MessageHandler.stdin_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_5_4.MessageHandler.stdin_function" title="Permalink to this definition">¶</a></dt>
 620 <dd><p>Build an Execute Message</p>
 621 <table class="docutils field-list" frame="void" rules="none">
 622 <col class="field-name" />
 623 <col class="field-body" />
 624 <tbody valign="top">
 625 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 626 <li><strong>value</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; parameter that go in the stdin</li>
 627 <li><strong>target</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Hrn of the target node (ex : omf.plexus.wlab17)</li>
 628 <li><strong>appid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Application id</li>
 629 </ul>
 630 </td>
 631 </tr>
 632 </tbody>
 633 </table>
 634 </dd></dl>
 635
 636 </dd></dl>
 637
 638 </div>
 639 <div class="section" id="module-nepi.resources.omf.messages_6">
 640 <span id="nepi-resources-omf-messages-6-module"></span><h2>nepi.resources.omf.messages_6 module<a class="headerlink" href="#module-nepi.resources.omf.messages_6" title="Permalink to this headline">¶</a></h2>
 641 <dl class="class">
 642 <dt id="nepi.resources.omf.messages_6.MessageHandler">
 643 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.messages_6.</tt><tt class="descname">MessageHandler</tt><a class="reference internal" href="../_modules/nepi/resources/omf/messages_6.html#MessageHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_6.MessageHandler" title="Permalink to this definition">¶</a></dt>
 644 <dd><dl class="class">
 645 <dt>
 646 <tt class="descname">Class Args :</tt></dt>
 647 <dd><table class="docutils field-list" frame="void" rules="none">
 648 <col class="field-name" />
 649 <col class="field-body" />
 650 <tbody valign="top">
 651 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 652 <li><strong>sliceid</strong> &#8211; Slice Name (= Xmpp Slice)</li>
 653 <li><strong>expid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Experiment ID (= Xmpp User)</li>
 654 </ul>
 655 </td>
 656 </tr>
 657 </tbody>
 658 </table>
 659 </dd></dl>
 660
 661 <div class="admonition note">
 662 <p class="first admonition-title">Note</p>
 663 <p class="last">This class is used only for OMF 5.4 Protocol and is going to become unused</p>
 664 </div>
 665 <dl class="method">
 666 <dt id="nepi.resources.omf.messages_6.MessageHandler.configure_function">
 667 <tt class="descname">configure_function</tt><big>(</big><em>msg_id</em>, <em>src</em>, <em>timestamp</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_6.html#MessageHandler.configure_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_6.MessageHandler.configure_function" title="Permalink to this definition">¶</a></dt>
 668 <dd><p>Build a configure message</p>
 669 <table class="docutils field-list" frame="void" rules="none">
 670 <col class="field-name" />
 671 <col class="field-body" />
 672 <tbody valign="top">
 673 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 674 <li><strong>msg_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the message</li>
 675 <li><strong>src</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Src node that send the message (jabber source)</li>
 676 <li><strong>timestamp</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Unix Timestamp</li>
 677 <li><strong>props</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; List of properties</li>
 678 <li><strong>guards</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of guards (assertions for properties)</li>
 679 </ul>
 680 </td>
 681 </tr>
 682 </tbody>
 683 </table>
 684 </dd></dl>
 685
 686 <dl class="method">
 687 <dt id="nepi.resources.omf.messages_6.MessageHandler.create_function">
 688 <tt class="descname">create_function</tt><big>(</big><em>msg_id</em>, <em>src</em>, <em>rtype</em>, <em>timestamp</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_6.html#MessageHandler.create_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_6.MessageHandler.create_function" title="Permalink to this definition">¶</a></dt>
 689 <dd><p>Build a create message</p>
 690 <table class="docutils field-list" frame="void" rules="none">
 691 <col class="field-name" />
 692 <col class="field-body" />
 693 <tbody valign="top">
 694 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 695 <li><strong>msg_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the message</li>
 696 <li><strong>src</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Src node that send the message (jabber source)</li>
 697 <li><strong>rtype</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Type of the object</li>
 698 <li><strong>timestamp</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Unix Timestamp</li>
 699 <li><strong>props</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; List of properties</li>
 700 <li><strong>guards</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of guards (assertions for properties)</li>
 701 </ul>
 702 </td>
 703 </tr>
 704 </tbody>
 705 </table>
 706 </dd></dl>
 707
 708 <dl class="method">
 709 <dt id="nepi.resources.omf.messages_6.MessageHandler.release_function">
 710 <tt class="descname">release_function</tt><big>(</big><em>msg_id</em>, <em>src</em>, <em>timestamp</em>, <em>res_id=None</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_6.html#MessageHandler.release_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_6.MessageHandler.release_function" title="Permalink to this definition">¶</a></dt>
 711 <dd><p>Build a release message</p>
 712 <table class="docutils field-list" frame="void" rules="none">
 713 <col class="field-name" />
 714 <col class="field-body" />
 715 <tbody valign="top">
 716 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 717 <li><strong>msg_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the message</li>
 718 <li><strong>src</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Src node that send the message (jabber source)</li>
 719 <li><strong>timestamp</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Unix Timestamp</li>
 720 <li><strong>res_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the release resource</li>
 721 <li><strong>props</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; List of properties</li>
 722 <li><strong>guards</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of guards (assertions for properties)</li>
 723 </ul>
 724 </td>
 725 </tr>
 726 </tbody>
 727 </table>
 728 </dd></dl>
 729
 730 <dl class="method">
 731 <dt id="nepi.resources.omf.messages_6.MessageHandler.request_function">
 732 <tt class="descname">request_function</tt><big>(</big><em>msg_id</em>, <em>src</em>, <em>timestamp</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/messages_6.html#MessageHandler.request_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.messages_6.MessageHandler.request_function" title="Permalink to this definition">¶</a></dt>
 733 <dd><p>Build a request message</p>
 734 <table class="docutils field-list" frame="void" rules="none">
 735 <col class="field-name" />
 736 <col class="field-body" />
 737 <tbody valign="top">
 738 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 739 <li><strong>msg_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the message</li>
 740 <li><strong>src</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Src node that send the message (jabber source)</li>
 741 <li><strong>timestamp</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Unix Timestamp</li>
 742 <li><strong>props</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; List of properties</li>
 743 <li><strong>guards</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of guards (assertions for properties)</li>
 744 </ul>
 745 </td>
 746 </tr>
 747 </tbody>
 748 </table>
 749 </dd></dl>
 750
 751 </dd></dl>
 752
 753 </div>
 754 <div class="section" id="module-nepi.resources.omf.node">
 755 <span id="nepi-resources-omf-node-module"></span><h2>nepi.resources.omf.node module<a class="headerlink" href="#module-nepi.resources.omf.node" title="Permalink to this headline">¶</a></h2>
 756 <dl class="class">
 757 <dt id="nepi.resources.omf.node.OMFNode">
 758 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.node.</tt><tt class="descname">OMFNode</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/node.html#OMFNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.node.OMFNode" title="Permalink to this definition">¶</a></dt>
 759 <dd><p>Bases: <a class="reference internal" href="#nepi.resources.omf.omf_resource.OMFResource" title="nepi.resources.omf.omf_resource.OMFResource"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.omf.omf_resource.OMFResource</span></tt></a></p>
 760 <dl class="class">
 761 <dt>
 762 <tt class="descname">Class Args :</tt></dt>
 763 <dd><table class="docutils field-list" frame="void" rules="none">
 764 <col class="field-name" />
 765 <col class="field-body" />
 766 <tbody valign="top">
 767 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 768 <li><strong>ec</strong> (<em>ExperimentController</em>) &#8211; The Experiment controller</li>
 769 <li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; guid of the RM</li>
 770 <li><strong>creds</strong> (<a class="reference external" href="http://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; Credentials to communicate with the rm (XmppClient for OMF)</li>
 771 </ul>
 772 </td>
 773 </tr>
 774 </tbody>
 775 </table>
 776 </dd></dl>
 777
 778 <dl class="method">
 779 <dt id="nepi.resources.omf.node.OMFNode.do_deploy">
 780 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/node.html#OMFNode.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.node.OMFNode.do_deploy" title="Permalink to this definition">¶</a></dt>
 781 <dd><p>Deploy the RM. It means : Send Xmpp Message Using OMF protocol
 782 to enroll the node into the experiment.</p>
 783 </dd></dl>
 784
 785 <dl class="method">
 786 <dt id="nepi.resources.omf.node.OMFNode.do_release">
 787 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/node.html#OMFNode.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.node.OMFNode.do_release" title="Permalink to this definition">¶</a></dt>
 788 <dd><p>Clean the RM at the end of the experiment by unenrolling
 789 the node from the topic</p>
 790 </dd></dl>
 791
 792 <dl class="attribute">
 793 <dt id="nepi.resources.omf.node.OMFNode.exp_id">
 794 <tt class="descname">exp_id</tt><a class="reference internal" href="../_modules/nepi/resources/omf/node.html#OMFNode.exp_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.node.OMFNode.exp_id" title="Permalink to this definition">¶</a></dt>
 795 <dd></dd></dl>
 796
 797 <dl class="method">
 798 <dt id="nepi.resources.omf.node.OMFNode.valid_connection">
 799 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/node.html#OMFNode.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.node.OMFNode.valid_connection" title="Permalink to this definition">¶</a></dt>
 800 <dd><p>Check if the connection with the guid in parameter is possible.
 801 Only meaningful connections are allowed.</p>
 802 <table class="docutils field-list" frame="void" rules="none">
 803 <col class="field-name" />
 804 <col class="field-body" />
 805 <tbody valign="top">
 806 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the current RM</td>
 807 </tr>
 808 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
 809 </tr>
 810 </tbody>
 811 </table>
 812 </dd></dl>
 813
 814 </dd></dl>
 815
 816 </div>
 817 <div class="section" id="module-nepi.resources.omf.omf5_api">
 818 <span id="nepi-resources-omf-omf5-api-module"></span><h2>nepi.resources.omf.omf5_api module<a class="headerlink" href="#module-nepi.resources.omf.omf5_api" title="Permalink to this headline">¶</a></h2>
 819 <dl class="class">
 820 <dt id="nepi.resources.omf.omf5_api.OMF5API">
 821 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf5_api.</tt><tt class="descname">OMF5API</tt><big>(</big><em>host</em>, <em>slice</em>, <em>port</em>, <em>password</em>, <em>xmpp_root=None</em>, <em>exp_id=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API" title="Permalink to this definition">¶</a></dt>
 822 <dd><p>Bases: <a class="reference internal" href="nepi.util.html#nepi.util.logger.Logger" title="nepi.util.logger.Logger"><tt class="xref py py-class docutils literal"><span class="pre">nepi.util.logger.Logger</span></tt></a></p>
 823 <dl class="class">
 824 <dt>
 825 <tt class="descname">Class Args :</tt></dt>
 826 <dd><table class="docutils field-list" frame="void" rules="none">
 827 <col class="field-name" />
 828 <col class="field-body" />
 829 <tbody valign="top">
 830 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 831 <li><strong>host</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Server</li>
 832 <li><strong>slice</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Slice</li>
 833 <li><strong>port</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Port</li>
 834 <li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp password</li>
 835 <li><strong>xmpp_root</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Root of the Xmpp Topic Architecture</li>
 836 </ul>
 837 </td>
 838 </tr>
 839 </tbody>
 840 </table>
 841 </dd></dl>
 842
 843 <div class="admonition note">
 844 <p class="first admonition-title">Note</p>
 845 <p class="last">This class is the implementation of an OMF 5.4 API.
 846 Since the version 5.4.1, the Topic Architecture start with OMF_5.4
 847 instead of OMF used for OMF5.3</p>
 848 </div>
 849 <dl class="method">
 850 <dt id="nepi.resources.omf.omf5_api.OMF5API.configure">
 851 <tt class="descname">configure</tt><big>(</big><em>hostname</em>, <em>attribute</em>, <em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.configure" title="Permalink to this definition">¶</a></dt>
 852 <dd><p>Configure attribute on the node</p>
 853 <table class="docutils field-list" frame="void" rules="none">
 854 <col class="field-name" />
 855 <col class="field-body" />
 856 <tbody valign="top">
 857 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 858 <li><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Full hrn of the node</li>
 859 <li><strong>attribute</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Attribute that need to be configured (
 860 often written as /net/wX/attribute, with X the interface number)</li>
 861 <li><strong>value</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Value of the attribute</li>
 862 </ul>
 863 </td>
 864 </tr>
 865 </tbody>
 866 </table>
 867 </dd></dl>
 868
 869 <dl class="method">
 870 <dt id="nepi.resources.omf.omf5_api.OMF5API.delete">
 871 <tt class="descname">delete</tt><big>(</big><em>hostname</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.delete" title="Permalink to this definition">¶</a></dt>
 872 <dd><p>Delete the topic corresponding to the hostname for this session</p>
 873 <table class="docutils field-list" frame="void" rules="none">
 874 <col class="field-name" />
 875 <col class="field-body" />
 876 <tbody valign="top">
 877 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Full hrn of the node</td>
 878 </tr>
 879 </tbody>
 880 </table>
 881 </dd></dl>
 882
 883 <dl class="method">
 884 <dt id="nepi.resources.omf.omf5_api.OMF5API.disconnect">
 885 <tt class="descname">disconnect</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.disconnect" title="Permalink to this definition">¶</a></dt>
 886 <dd><p>Delete the session and logger topics. Then disconnect</p>
 887 </dd></dl>
 888
 889 <dl class="method">
 890 <dt id="nepi.resources.omf.omf5_api.OMF5API.enroll_host">
 891 <tt class="descname">enroll_host</tt><big>(</big><em>hostname</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.enroll_host"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.enroll_host" title="Permalink to this definition">¶</a></dt>
 892 <dd><dl class="docutils">
 893 <dt>Create and Subscribe to the session topic and the resources</dt>
 894 <dd>corresponding to the hostname</dd>
 895 </dl>
 896 <table class="docutils field-list" frame="void" rules="none">
 897 <col class="field-name" />
 898 <col class="field-body" />
 899 <tbody valign="top">
 900 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Full hrn of the node</td>
 901 </tr>
 902 </tbody>
 903 </table>
 904 </dd></dl>
 905
 906 <dl class="method">
 907 <dt id="nepi.resources.omf.omf5_api.OMF5API.execute">
 908 <tt class="descname">execute</tt><big>(</big><em>hostname</em>, <em>app_id</em>, <em>arguments</em>, <em>path</em>, <em>env</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.execute" title="Permalink to this definition">¶</a></dt>
 909 <dd><p>Execute command on the node</p>
 910 <table class="docutils field-list" frame="void" rules="none">
 911 <col class="field-name" />
 912 <col class="field-body" />
 913 <tbody valign="top">
 914 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 915 <li><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Full hrn of the node</li>
 916 <li><strong>app_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Application Id (Any id that represents in a unique
 917 way the application)</li>
 918 <li><strong>arguments</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Arguments of the application</li>
 919 <li><strong>path</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Path of the application</li>
 920 <li><strong>env</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Environnement values for the application</li>
 921 </ul>
 922 </td>
 923 </tr>
 924 </tbody>
 925 </table>
 926 </dd></dl>
 927
 928 <dl class="method">
 929 <dt id="nepi.resources.omf.omf5_api.OMF5API.exit">
 930 <tt class="descname">exit</tt><big>(</big><em>hostname</em>, <em>app_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.exit" title="Permalink to this definition">¶</a></dt>
 931 <dd><p>Kill an application started with OMF</p>
 932 <table class="docutils field-list" frame="void" rules="none">
 933 <col class="field-name" />
 934 <col class="field-body" />
 935 <tbody valign="top">
 936 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 937 <li><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Full hrn of the node</li>
 938 <li><strong>app_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Application Id of the application you want to stop</li>
 939 </ul>
 940 </td>
 941 </tr>
 942 </tbody>
 943 </table>
 944 </dd></dl>
 945
 946 <dl class="method">
 947 <dt id="nepi.resources.omf.omf5_api.OMF5API.release">
 948 <tt class="descname">release</tt><big>(</big><em>hostname</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.release" title="Permalink to this definition">¶</a></dt>
 949 <dd><p>Delete the session and logger topics. Then disconnect</p>
 950 </dd></dl>
 951
 952 <dl class="method">
 953 <dt id="nepi.resources.omf.omf5_api.OMF5API.send_stdin">
 954 <tt class="descname">send_stdin</tt><big>(</big><em>hostname</em>, <em>value</em>, <em>app_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf5_api.html#OMF5API.send_stdin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf5_api.OMF5API.send_stdin" title="Permalink to this definition">¶</a></dt>
 955 <dd><p>Send to the stdin of the application the value</p>
 956 <table class="docutils field-list" frame="void" rules="none">
 957 <col class="field-name" />
 958 <col class="field-body" />
 959 <tbody valign="top">
 960 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 961 <li><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Full hrn of the node</li>
 962 <li><strong>appid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Application Id (Any id that represents in a unique
 963 way the application)</li>
 964 <li><strong>value</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; parameter to execute in the stdin of the application</li>
 965 </ul>
 966 </td>
 967 </tr>
 968 </tbody>
 969 </table>
 970 </dd></dl>
 971
 972 </dd></dl>
 973
 974 </div>
 975 <div class="section" id="module-nepi.resources.omf.omf6_api">
 976 <span id="nepi-resources-omf-omf6-api-module"></span><h2>nepi.resources.omf.omf6_api module<a class="headerlink" href="#module-nepi.resources.omf.omf6_api" title="Permalink to this headline">¶</a></h2>
 977 <dl class="class">
 978 <dt id="nepi.resources.omf.omf6_api.OMF6API">
 979 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf6_api.</tt><tt class="descname">OMF6API</tt><big>(</big><em>server</em>, <em>user='nepi'</em>, <em>port='5222'</em>, <em>password='1234'</em>, <em>exp_id=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API" title="Permalink to this definition">¶</a></dt>
 980 <dd><p>Bases: <a class="reference internal" href="nepi.util.html#nepi.util.logger.Logger" title="nepi.util.logger.Logger"><tt class="xref py py-class docutils literal"><span class="pre">nepi.util.logger.Logger</span></tt></a></p>
 981 <dl class="class">
 982 <dt>
 983 <tt class="descname">Class Args :</tt></dt>
 984 <dd><table class="docutils field-list" frame="void" rules="none">
 985 <col class="field-name" />
 986 <col class="field-body" />
 987 <tbody valign="top">
 988 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 989 <li><strong>server</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Server</li>
 990 <li><strong>user</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp User</li>
 991 <li><strong>port</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Port</li>
 992 <li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp password</li>
 993 <li><strong>xmpp_root</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Root of the Xmpp Topic Architecture</li>
 994 </ul>
 995 </td>
 996 </tr>
 997 </tbody>
 998 </table>
 999 </dd></dl>
1000
1001 <div class="admonition note">
1002 <p class="first admonition-title">Note</p>
1003 <p class="last">This class is the implementation of an OMF 5.4 API.
1004 Since the version 5.4.1, the Topic Architecture start with OMF_5.4
1005 instead of OMF used for OMF5.3</p>
1006 </div>
1007 <dl class="method">
1008 <dt id="nepi.resources.omf.omf6_api.OMF6API.check_mailbox">
1009 <tt class="descname">check_mailbox</tt><big>(</big><em>itype</em>, <em>attr</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.check_mailbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.check_mailbox" title="Permalink to this definition">¶</a></dt>
1010 <dd><p>Check the mail box</p>
1011 <table class="docutils field-list" frame="void" rules="none">
1012 <col class="field-name" />
1013 <col class="field-body" />
1014 <tbody valign="top">
1015 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1016 <li><strong>itype</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; type of mail</li>
1017 <li><strong>attr</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; value wanted</li>
1018 </ul>
1019 </td>
1020 </tr>
1021 </tbody>
1022 </table>
1023 </dd></dl>
1024
1025 <dl class="method">
1026 <dt id="nepi.resources.omf.omf6_api.OMF6API.check_ready">
1027 <tt class="descname">check_ready</tt><big>(</big><em>xmpp</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.check_ready"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.check_ready" title="Permalink to this definition">¶</a></dt>
1028 <dd></dd></dl>
1029
1030 <dl class="method">
1031 <dt id="nepi.resources.omf.omf6_api.OMF6API.create_and_enroll_topic">
1032 <tt class="descname">create_and_enroll_topic</tt><big>(</big><em>topic</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.create_and_enroll_topic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.create_and_enroll_topic" title="Permalink to this definition">¶</a></dt>
1033 <dd><dl class="docutils">
1034 <dt>Create and Subscribe to the session topic and the resources</dt>
1035 <dd>corresponding to the hostname</dd>
1036 </dl>
1037 <table class="docutils field-list" frame="void" rules="none">
1038 <col class="field-name" />
1039 <col class="field-body" />
1040 <tbody valign="top">
1041 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hostname</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Full hrn of the node</td>
1042 </tr>
1043 </tbody>
1044 </table>
1045 </dd></dl>
1046
1047 <dl class="method">
1048 <dt id="nepi.resources.omf.omf6_api.OMF6API.disconnect">
1049 <tt class="descname">disconnect</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.disconnect" title="Permalink to this definition">¶</a></dt>
1050 <dd><p>Delete the session and logger topics. Then disconnect</p>
1051 </dd></dl>
1052
1053 <dl class="method">
1054 <dt id="nepi.resources.omf.omf6_api.OMF6API.enroll_topic">
1055 <tt class="descname">enroll_topic</tt><big>(</big><em>topic</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.enroll_topic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.enroll_topic" title="Permalink to this definition">¶</a></dt>
1056 <dd><p>Create and Subscribe to the session topic and the resources
1057 corresponding to the hostname</p>
1058 </dd></dl>
1059
1060 <dl class="method">
1061 <dt id="nepi.resources.omf.omf6_api.OMF6API.frcp_configure">
1062 <tt class="descname">frcp_configure</tt><big>(</big><em>topic</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.frcp_configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.frcp_configure" title="Permalink to this definition">¶</a></dt>
1063 <dd><p>Publish a configure message</p>
1064 </dd></dl>
1065
1066 <dl class="method">
1067 <dt id="nepi.resources.omf.omf6_api.OMF6API.frcp_create">
1068 <tt class="descname">frcp_create</tt><big>(</big><em>msg_id</em>, <em>topic</em>, <em>rtype</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.frcp_create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.frcp_create" title="Permalink to this definition">¶</a></dt>
1069 <dd><p>Publish a create message</p>
1070 </dd></dl>
1071
1072 <dl class="method">
1073 <dt id="nepi.resources.omf.omf6_api.OMF6API.frcp_inform">
1074 <tt class="descname">frcp_inform</tt><big>(</big><em>topic</em>, <em>cid</em>, <em>itype</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.frcp_inform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.frcp_inform" title="Permalink to this definition">¶</a></dt>
1075 <dd><p>Publish an inform message</p>
1076 </dd></dl>
1077
1078 <dl class="method">
1079 <dt id="nepi.resources.omf.omf6_api.OMF6API.frcp_release">
1080 <tt class="descname">frcp_release</tt><big>(</big><em>msg_id</em>, <em>parent</em>, <em>child</em>, <em>res_id=None</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.frcp_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.frcp_release" title="Permalink to this definition">¶</a></dt>
1081 <dd><p>Publish a release message</p>
1082 </dd></dl>
1083
1084 <dl class="method">
1085 <dt id="nepi.resources.omf.omf6_api.OMF6API.frcp_request">
1086 <tt class="descname">frcp_request</tt><big>(</big><em>topic</em>, <em>props=None</em>, <em>guards=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.frcp_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.frcp_request" title="Permalink to this definition">¶</a></dt>
1087 <dd><p>Execute command on the node</p>
1088 </dd></dl>
1089
1090 <dl class="method">
1091 <dt id="nepi.resources.omf.omf6_api.OMF6API.unenroll_topic">
1092 <tt class="descname">unenroll_topic</tt><big>(</big><em>topic</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_api.html#OMF6API.unenroll_topic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_api.OMF6API.unenroll_topic" title="Permalink to this definition">¶</a></dt>
1093 <dd><p>Create and Subscribe to the session topic and the resources
1094 corresponding to the hostname</p>
1095 </dd></dl>
1096
1097 </dd></dl>
1098
1099 </div>
1100 <div class="section" id="module-nepi.resources.omf.omf6_parser">
1101 <span id="nepi-resources-omf-omf6-parser-module"></span><h2>nepi.resources.omf.omf6_parser module<a class="headerlink" href="#module-nepi.resources.omf.omf6_parser" title="Permalink to this headline">¶</a></h2>
1102 <dl class="class">
1103 <dt id="nepi.resources.omf.omf6_parser.OMF6Parser">
1104 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf6_parser.</tt><tt class="descname">OMF6Parser</tt><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_parser.html#OMF6Parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_parser.OMF6Parser" title="Permalink to this definition">¶</a></dt>
1105 <dd><p>Bases: <a class="reference internal" href="nepi.util.html#nepi.util.logger.Logger" title="nepi.util.logger.Logger"><tt class="xref py py-class docutils literal"><span class="pre">nepi.util.logger.Logger</span></tt></a></p>
1106 <dl class="class">
1107 <dt>
1108 <tt class="descname">Class Args :</tt></dt>
1109 <dd><table class="docutils field-list" frame="void" rules="none">
1110 <col class="field-name" />
1111 <col class="field-body" />
1112 <tbody valign="top">
1113 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1114 <li><strong>jid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Jabber Id (= Xmpp Slice + Date)</li>
1115 <li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Jabber Password (= Xmpp Password)</li>
1116 </ul>
1117 </td>
1118 </tr>
1119 </tbody>
1120 </table>
1121 </dd></dl>
1122
1123 <div class="admonition note">
1124 <p class="first admonition-title">Note</p>
1125 <p class="last">This class is an XMPP Client with customized method</p>
1126 </div>
1127 <dl class="method">
1128 <dt id="nepi.resources.omf.omf6_parser.OMF6Parser.check_mailbox">
1129 <tt class="descname">check_mailbox</tt><big>(</big><em>itype</em>, <em>attr</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_parser.html#OMF6Parser.check_mailbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_parser.OMF6Parser.check_mailbox" title="Permalink to this definition">¶</a></dt>
1130 <dd><p>Check the mail box</p>
1131 <table class="docutils field-list" frame="void" rules="none">
1132 <col class="field-name" />
1133 <col class="field-body" />
1134 <tbody valign="top">
1135 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1136 <li><strong>itype</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; type of mail</li>
1137 <li><strong>attr</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; value wanted</li>
1138 </ul>
1139 </td>
1140 </tr>
1141 </tbody>
1142 </table>
1143 </dd></dl>
1144
1145 <dl class="method">
1146 <dt id="nepi.resources.omf.omf6_parser.OMF6Parser.handle">
1147 <tt class="descname">handle</tt><big>(</big><em>iq</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_parser.html#OMF6Parser.handle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_parser.OMF6Parser.handle" title="Permalink to this definition">¶</a></dt>
1148 <dd><p>Check the mail box</p>
1149 <table class="docutils field-list" frame="void" rules="none">
1150 <col class="field-name" />
1151 <col class="field-body" />
1152 <tbody valign="top">
1153 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>iq</strong> &#8211; message received</td>
1154 </tr>
1155 </tbody>
1156 </table>
1157 </dd></dl>
1158
1159 <dl class="method">
1160 <dt id="nepi.resources.omf.omf6_parser.OMF6Parser.init_mailbox">
1161 <tt class="descname">init_mailbox</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf6_parser.html#OMF6Parser.init_mailbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf6_parser.OMF6Parser.init_mailbox" title="Permalink to this definition">¶</a></dt>
1162 <dd></dd></dl>
1163
1164 </dd></dl>
1165
1166 </div>
1167 <div class="section" id="module-nepi.resources.omf.omf_api_factory">
1168 <span id="nepi-resources-omf-omf-api-factory-module"></span><h2>nepi.resources.omf.omf_api_factory module<a class="headerlink" href="#module-nepi.resources.omf.omf_api_factory" title="Permalink to this headline">¶</a></h2>
1169 <dl class="class">
1170 <dt id="nepi.resources.omf.omf_api_factory.OMFAPIFactory">
1171 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf_api_factory.</tt><tt class="descname">OMFAPIFactory</tt><a class="reference internal" href="../_modules/nepi/resources/omf/omf_api_factory.html#OMFAPIFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_api_factory.OMFAPIFactory" title="Permalink to this definition">¶</a></dt>
1172 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
1173 <div class="admonition note">
1174 <p class="first admonition-title">Note</p>
1175 <p class="last">It allows the different RM to use the same xmpp client if they use
1176 the same credentials.  For the moment, it is focused on XMPP.</p>
1177 </div>
1178 <dl class="classmethod">
1179 <dt id="nepi.resources.omf.omf_api_factory.OMFAPIFactory.create_api">
1180 <em class="property">classmethod </em><tt class="descname">create_api</tt><big>(</big><em>version</em>, <em>server</em>, <em>user</em>, <em>port</em>, <em>password</em>, <em>exp_id</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_api_factory.html#OMFAPIFactory.create_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_api_factory.OMFAPIFactory.create_api" title="Permalink to this definition">¶</a></dt>
1181 <dd><p>Create an OMF API if this one doesn&#8217;t exist yet with this credentials</p>
1182 <table class="docutils field-list" frame="void" rules="none">
1183 <col class="field-name" />
1184 <col class="field-body" />
1185 <tbody valign="top">
1186 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1187 <li><strong>version</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; OMF Version. Either 5 or 6</li>
1188 <li><strong>server</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Server Adress</li>
1189 <li><strong>user</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp User</li>
1190 <li><strong>port</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Port (Default : 5222)</li>
1191 <li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Password</li>
1192 <li><strong>exp_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the experiment</li>
1193 </ul>
1194 </td>
1195 </tr>
1196 </tbody>
1197 </table>
1198 </dd></dl>
1199
1200 <dl class="classmethod">
1201 <dt id="nepi.resources.omf.omf_api_factory.OMFAPIFactory.get_api">
1202 <em class="property">classmethod </em><tt class="descname">get_api</tt><big>(</big><em>version</em>, <em>server</em>, <em>user</em>, <em>port</em>, <em>password</em>, <em>exp_id=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_api_factory.html#OMFAPIFactory.get_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_api_factory.OMFAPIFactory.get_api" title="Permalink to this definition">¶</a></dt>
1203 <dd><p>Get an OMF Api</p>
1204 <table class="docutils field-list" frame="void" rules="none">
1205 <col class="field-name" />
1206 <col class="field-body" />
1207 <tbody valign="top">
1208 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1209 <li><strong>version</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; OMF Version. Either 5 or 6</li>
1210 <li><strong>server</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Server Adress</li>
1211 <li><strong>user</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp User</li>
1212 <li><strong>port</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Port (Default : 5222)</li>
1213 <li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Password</li>
1214 <li><strong>exp_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the experiment</li>
1215 </ul>
1216 </td>
1217 </tr>
1218 </tbody>
1219 </table>
1220 </dd></dl>
1221
1222 <dl class="attribute">
1223 <dt id="nepi.resources.omf.omf_api_factory.OMFAPIFactory.lock">
1224 <tt class="descname">lock</tt><em class="property"> = &lt;thread.lock object at 0x7f305902aeb0&gt;</em><a class="headerlink" href="#nepi.resources.omf.omf_api_factory.OMFAPIFactory.lock" title="Permalink to this definition">¶</a></dt>
1225 <dd></dd></dl>
1226
1227 <dl class="classmethod">
1228 <dt id="nepi.resources.omf.omf_api_factory.OMFAPIFactory.release_api">
1229 <em class="property">classmethod </em><tt class="descname">release_api</tt><big>(</big><em>version</em>, <em>server</em>, <em>user</em>, <em>port</em>, <em>password</em>, <em>exp_id=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_api_factory.html#OMFAPIFactory.release_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_api_factory.OMFAPIFactory.release_api" title="Permalink to this definition">¶</a></dt>
1230 <dd><p>Release an OMF API with this credentials</p>
1231 <table class="docutils field-list" frame="void" rules="none">
1232 <col class="field-name" />
1233 <col class="field-body" />
1234 <tbody valign="top">
1235 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1236 <li><strong>version</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; OMF Version. Either 5 or 6</li>
1237 <li><strong>server</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Server Adress</li>
1238 <li><strong>user</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp User</li>
1239 <li><strong>port</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Port (Default : 5222)</li>
1240 <li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Xmpp Password</li>
1241 <li><strong>exp_id</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Id of the experiment</li>
1242 </ul>
1243 </td>
1244 </tr>
1245 </tbody>
1246 </table>
1247 </dd></dl>
1248
1249 </dd></dl>
1250
1251 </div>
1252 <div class="section" id="module-nepi.resources.omf.omf_client">
1253 <span id="nepi-resources-omf-omf-client-module"></span><h2>nepi.resources.omf.omf_client module<a class="headerlink" href="#module-nepi.resources.omf.omf_client" title="Permalink to this headline">¶</a></h2>
1254 <dl class="class">
1255 <dt id="nepi.resources.omf.omf_client.BaseOMFClient">
1256 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf_client.</tt><tt class="descname">BaseOMFClient</tt><big>(</big><em>jid</em>, <em>password</em>, <em>ssl=False</em>, <em>plugin_config={}</em>, <em>plugin_whitelist=[]</em>, <em>escape_quotes=True</em>, <em>sasl_mech=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#BaseOMFClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.BaseOMFClient" title="Permalink to this definition">¶</a></dt>
1257 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sleekxmpp.clientxmpp.ClientXMPP</span></tt></p>
1258 </dd></dl>
1259
1260 <dl class="class">
1261 <dt id="nepi.resources.omf.omf_client.OMFClient">
1262 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf_client.</tt><tt class="descname">OMFClient</tt><big>(</big><em>jid</em>, <em>password</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient" title="Permalink to this definition">¶</a></dt>
1263 <dd><p>Bases: <a class="reference internal" href="#nepi.resources.omf.omf_client.BaseOMFClient" title="nepi.resources.omf.omf_client.BaseOMFClient"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.omf.omf_client.BaseOMFClient</span></tt></a>, <a class="reference internal" href="nepi.util.html#nepi.util.logger.Logger" title="nepi.util.logger.Logger"><tt class="xref py py-class docutils literal"><span class="pre">nepi.util.logger.Logger</span></tt></a></p>
1264 <dl class="class">
1265 <dt>
1266 <tt class="descname">Class Args :</tt></dt>
1267 <dd><table class="docutils field-list" frame="void" rules="none">
1268 <col class="field-name" />
1269 <col class="field-body" />
1270 <tbody valign="top">
1271 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1272 <li><strong>jid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Jabber Id (= Xmpp Slice + Date)</li>
1273 <li><strong>password</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Jabber Password (= Xmpp Password)</li>
1274 </ul>
1275 </td>
1276 </tr>
1277 </tbody>
1278 </table>
1279 </dd></dl>
1280
1281 <div class="admonition note">
1282 <p class="first admonition-title">Note</p>
1283 <p class="last">This class is an XMPP Client with customized method</p>
1284 </div>
1285 <dl class="method">
1286 <dt id="nepi.resources.omf.omf_client.OMFClient.check_mailbox">
1287 <tt class="descname">check_mailbox</tt><big>(</big><em>itype</em>, <em>attr</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.check_mailbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.check_mailbox" title="Permalink to this definition">¶</a></dt>
1288 <dd><p>Check the mail box</p>
1289 <table class="docutils field-list" frame="void" rules="none">
1290 <col class="field-name" />
1291 <col class="field-body" />
1292 <tbody valign="top">
1293 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1294 <li><strong>itype</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; type of mail</li>
1295 <li><strong>attr</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; value wanted</li>
1296 </ul>
1297 </td>
1298 </tr>
1299 </tbody>
1300 </table>
1301 </dd></dl>
1302
1303 <dl class="method">
1304 <dt id="nepi.resources.omf.omf_client.OMFClient.create">
1305 <tt class="descname">create</tt><big>(</big><em>node</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.create" title="Permalink to this definition">¶</a></dt>
1306 <dd><p>Create the topic corresponding to the node</p>
1307 <table class="docutils field-list" frame="void" rules="none">
1308 <col class="field-name" />
1309 <col class="field-body" />
1310 <tbody valign="top">
1311 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)</td>
1312 </tr>
1313 </tbody>
1314 </table>
1315 </dd></dl>
1316
1317 <dl class="method">
1318 <dt id="nepi.resources.omf.omf_client.OMFClient.delete">
1319 <tt class="descname">delete</tt><big>(</big><em>node</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.delete" title="Permalink to this definition">¶</a></dt>
1320 <dd><p>Delete the topic corresponding to the node</p>
1321 <table class="docutils field-list" frame="void" rules="none">
1322 <col class="field-name" />
1323 <col class="field-body" />
1324 <tbody valign="top">
1325 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the topic, corresponding to the node (ex : omf.plexus.wlab17)</td>
1326 </tr>
1327 </tbody>
1328 </table>
1329 </dd></dl>
1330
1331 <dl class="method">
1332 <dt id="nepi.resources.omf.omf_client.OMFClient.get">
1333 <tt class="descname">get</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.get" title="Permalink to this definition">¶</a></dt>
1334 <dd><p>Get the item</p>
1335 <table class="docutils field-list" frame="void" rules="none">
1336 <col class="field-name" />
1337 <col class="field-body" />
1338 <tbody valign="top">
1339 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; data from which the items will be get back</td>
1340 </tr>
1341 </tbody>
1342 </table>
1343 </dd></dl>
1344
1345 <dl class="method">
1346 <dt id="nepi.resources.omf.omf_client.OMFClient.handle_omf_message">
1347 <tt class="descname">handle_omf_message</tt><big>(</big><em>iq</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.handle_omf_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.handle_omf_message" title="Permalink to this definition">¶</a></dt>
1348 <dd><p>Handle published/received message</p>
1349 <table class="docutils field-list" frame="void" rules="none">
1350 <col class="field-name" />
1351 <col class="field-body" />
1352 <tbody valign="top">
1353 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>iq</strong> (<em>Iq Stanza</em>) &#8211; Stanzas that is currently published/received</td>
1354 </tr>
1355 </tbody>
1356 </table>
1357 </dd></dl>
1358
1359 <dl class="method">
1360 <dt id="nepi.resources.omf.omf_client.OMFClient.nodes">
1361 <tt class="descname">nodes</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.nodes" title="Permalink to this definition">¶</a></dt>
1362 <dd><p>Get all the nodes of the Xmppp Server.</p>
1363 </dd></dl>
1364
1365 <dl class="method">
1366 <dt id="nepi.resources.omf.omf_client.OMFClient.publish">
1367 <tt class="descname">publish</tt><big>(</big><em>data</em>, <em>node</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.publish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.publish" title="Permalink to this definition">¶</a></dt>
1368 <dd><p>Publish the data to the corresponding topic</p>
1369 <table class="docutils field-list" frame="void" rules="none">
1370 <col class="field-name" />
1371 <col class="field-body" />
1372 <tbody valign="top">
1373 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1374 <li><strong>data</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Data that will be published</li>
1375 <li><strong>node</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the topic</li>
1376 </ul>
1377 </td>
1378 </tr>
1379 </tbody>
1380 </table>
1381 </dd></dl>
1382
1383 <dl class="method">
1384 <dt id="nepi.resources.omf.omf_client.OMFClient.purge">
1385 <tt class="descname">purge</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.purge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.purge" title="Permalink to this definition">¶</a></dt>
1386 <dd><p>Purge the information in the server</p>
1387 </dd></dl>
1388
1389 <dl class="attribute">
1390 <dt id="nepi.resources.omf.omf_client.OMFClient.ready">
1391 <tt class="descname">ready</tt><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.ready"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.ready" title="Permalink to this definition">¶</a></dt>
1392 <dd><p>Check if the client is ready</p>
1393 </dd></dl>
1394
1395 <dl class="method">
1396 <dt id="nepi.resources.omf.omf_client.OMFClient.register">
1397 <tt class="descname">register</tt><big>(</big><em>iq</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.register" title="Permalink to this definition">¶</a></dt>
1398 <dd><p>Register to the Xmppp Server. This function is called directly by the sleekXmpp library</p>
1399 </dd></dl>
1400
1401 <dl class="method">
1402 <dt id="nepi.resources.omf.omf_client.OMFClient.retract">
1403 <tt class="descname">retract</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.retract"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.retract" title="Permalink to this definition">¶</a></dt>
1404 <dd><p>Retract the item</p>
1405 <table class="docutils field-list" frame="void" rules="none">
1406 <col class="field-name" />
1407 <col class="field-body" />
1408 <tbody valign="top">
1409 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; data from which the item will be retracted</td>
1410 </tr>
1411 </tbody>
1412 </table>
1413 </dd></dl>
1414
1415 <dl class="method">
1416 <dt id="nepi.resources.omf.omf_client.OMFClient.start">
1417 <tt class="descname">start</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.start" title="Permalink to this definition">¶</a></dt>
1418 <dd><p>Send presence to the Xmppp Server. This function is called directly by the sleekXmpp library</p>
1419 </dd></dl>
1420
1421 <dl class="method">
1422 <dt id="nepi.resources.omf.omf_client.OMFClient.subscribe">
1423 <tt class="descname">subscribe</tt><big>(</big><em>node</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.subscribe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.subscribe" title="Permalink to this definition">¶</a></dt>
1424 <dd><p>Subscribe to a topic</p>
1425 <table class="docutils field-list" frame="void" rules="none">
1426 <col class="field-name" />
1427 <col class="field-body" />
1428 <tbody valign="top">
1429 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the topic</td>
1430 </tr>
1431 </tbody>
1432 </table>
1433 </dd></dl>
1434
1435 <dl class="method">
1436 <dt id="nepi.resources.omf.omf_client.OMFClient.subscriptions">
1437 <tt class="descname">subscriptions</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.subscriptions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.subscriptions" title="Permalink to this definition">¶</a></dt>
1438 <dd><p>Get all the subscriptions of the Xmppp Server.</p>
1439 </dd></dl>
1440
1441 <dl class="method">
1442 <dt id="nepi.resources.omf.omf_client.OMFClient.unregister">
1443 <tt class="descname">unregister</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.unregister"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.unregister" title="Permalink to this definition">¶</a></dt>
1444 <dd><p>Unregister from the Xmppp Server.</p>
1445 </dd></dl>
1446
1447 <dl class="method">
1448 <dt id="nepi.resources.omf.omf_client.OMFClient.unsubscribe">
1449 <tt class="descname">unsubscribe</tt><big>(</big><em>node</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_client.html#OMFClient.unsubscribe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_client.OMFClient.unsubscribe" title="Permalink to this definition">¶</a></dt>
1450 <dd><p>Unsubscribe to a topic</p>
1451 <table class="docutils field-list" frame="void" rules="none">
1452 <col class="field-name" />
1453 <col class="field-body" />
1454 <tbody valign="top">
1455 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the topic</td>
1456 </tr>
1457 </tbody>
1458 </table>
1459 </dd></dl>
1460
1461 </dd></dl>
1462
1463 </div>
1464 <div class="section" id="module-nepi.resources.omf.omf_resource">
1465 <span id="nepi-resources-omf-omf-resource-module"></span><h2>nepi.resources.omf.omf_resource module<a class="headerlink" href="#module-nepi.resources.omf.omf_resource" title="Permalink to this headline">¶</a></h2>
1466 <dl class="class">
1467 <dt id="nepi.resources.omf.omf_resource.OMFResource">
1468 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf_resource.</tt><tt class="descname">OMFResource</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/omf_resource.html#OMFResource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_resource.OMFResource" title="Permalink to this definition">¶</a></dt>
1469 <dd><p>Bases: <a class="reference internal" href="nepi.execution.html#nepi.execution.resource.ResourceManager" title="nepi.execution.resource.ResourceManager"><tt class="xref py py-class docutils literal"><span class="pre">nepi.execution.resource.ResourceManager</span></tt></a></p>
1470 <p>Generic resource gathering XMPP credential information and common methods
1471 for OMF nodes, channels, applications, etc.</p>
1472 </dd></dl>
1473
1474 <dl class="class">
1475 <dt id="nepi.resources.omf.omf_resource.ResourceGateway">
1476 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.omf_resource.</tt><tt class="descname">ResourceGateway</tt><a class="reference internal" href="../_modules/nepi/resources/omf/omf_resource.html#ResourceGateway"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.omf_resource.ResourceGateway" title="Permalink to this definition">¶</a></dt>
1477 <dd><p>Dictionary used to set OMF gateway depending on Testbed information.</p>
1478 <dl class="attribute">
1479 <dt id="nepi.resources.omf.omf_resource.ResourceGateway.AMtoGateway">
1480 <tt class="descname">AMtoGateway</tt><em class="property"> = {'nitlab.inf.uth.gr': 'nitlab.inf.uth.gr', 'nicta': '??.??.??', 'am.wilab2.ilabt.iminds.be': 'ops.wilab2.ilabt.iminds.be'}</em><a class="headerlink" href="#nepi.resources.omf.omf_resource.ResourceGateway.AMtoGateway" title="Permalink to this definition">¶</a></dt>
1481 <dd></dd></dl>
1482
1483 <dl class="attribute">
1484 <dt id="nepi.resources.omf.omf_resource.ResourceGateway.TestbedtoGateway">
1485 <tt class="descname">TestbedtoGateway</tt><em class="property"> = {'wilabt': 'ops.wilab2.ilabt.iminds.be', 'nicta': '??.??.??', 'nitos': 'nitlab.inf.uth.gr'}</em><a class="headerlink" href="#nepi.resources.omf.omf_resource.ResourceGateway.TestbedtoGateway" title="Permalink to this definition">¶</a></dt>
1486 <dd></dd></dl>
1487
1488 </dd></dl>
1489
1490 </div>
1491 <div class="section" id="module-nepi.resources.omf.wilabt_node">
1492 <span id="nepi-resources-omf-wilabt-node-module"></span><h2>nepi.resources.omf.wilabt_node module<a class="headerlink" href="#module-nepi.resources.omf.wilabt_node" title="Permalink to this headline">¶</a></h2>
1493 <dl class="class">
1494 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode">
1495 <em class="property">class </em><tt class="descclassname">nepi.resources.omf.wilabt_node.</tt><tt class="descname">WilabtSfaNode</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode" title="Permalink to this definition">¶</a></dt>
1496 <dd><p>Bases: <a class="reference internal" href="#nepi.resources.omf.node.OMFNode" title="nepi.resources.omf.node.OMFNode"><tt class="xref py py-class docutils literal"><span class="pre">nepi.resources.omf.node.OMFNode</span></tt></a></p>
1497 <dl class="method">
1498 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.do_deploy">
1499 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.do_deploy" title="Permalink to this definition">¶</a></dt>
1500 <dd></dd></dl>
1501
1502 <dl class="method">
1503 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.do_discover">
1504 <tt class="descname">do_discover</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.do_discover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.do_discover" title="Permalink to this definition">¶</a></dt>
1505 <dd><p>Based on the attributes defined by the user, discover the suitable
1506 node for provision.</p>
1507 </dd></dl>
1508
1509 <dl class="method">
1510 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.do_provision">
1511 <tt class="descname">do_provision</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.do_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.do_provision" title="Permalink to this definition">¶</a></dt>
1512 <dd><p>Add node to user&#8217;s slice and verifing that the node is functioning
1513 correctly. Check ssh, omf rc running, hostname, file system.</p>
1514 </dd></dl>
1515
1516 <dl class="method">
1517 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.do_release">
1518 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.do_release" title="Permalink to this definition">¶</a></dt>
1519 <dd></dd></dl>
1520
1521 <dl class="method">
1522 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.execute">
1523 <tt class="descname">execute</tt><big>(</big><em>command</em>, <em>sudo=False</em>, <em>env=None</em>, <em>tty=False</em>, <em>forward_x11=False</em>, <em>retry=3</em>, <em>connect_timeout=30</em>, <em>strict_host_checking=False</em>, <em>persistent=True</em>, <em>blocking=True</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.execute" title="Permalink to this definition">¶</a></dt>
1524 <dd><p>Notice that this invocation will block until the
1525 execution finishes. If this is not the desired behavior,
1526 use &#8216;run&#8217; instead.</p>
1527 </dd></dl>
1528
1529 <dl class="method">
1530 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_discovery">
1531 <tt class="descname">fail_discovery</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.fail_discovery"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_discovery" title="Permalink to this definition">¶</a></dt>
1532 <dd></dd></dl>
1533
1534 <dl class="method">
1535 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_node_not_alive">
1536 <tt class="descname">fail_node_not_alive</tt><big>(</big><em>host=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.fail_node_not_alive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_node_not_alive" title="Permalink to this definition">¶</a></dt>
1537 <dd></dd></dl>
1538
1539 <dl class="method">
1540 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_node_not_available">
1541 <tt class="descname">fail_node_not_available</tt><big>(</big><em>host</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.fail_node_not_available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_node_not_available" title="Permalink to this definition">¶</a></dt>
1542 <dd></dd></dl>
1543
1544 <dl class="method">
1545 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_not_enough_nodes">
1546 <tt class="descname">fail_not_enough_nodes</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.fail_not_enough_nodes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_not_enough_nodes" title="Permalink to this definition">¶</a></dt>
1547 <dd></dd></dl>
1548
1549 <dl class="method">
1550 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_sfaapi">
1551 <tt class="descname">fail_sfaapi</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.fail_sfaapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.fail_sfaapi" title="Permalink to this definition">¶</a></dt>
1552 <dd></dd></dl>
1553
1554 <dl class="attribute">
1555 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.sfaapi">
1556 <tt class="descname">sfaapi</tt><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.sfaapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.sfaapi" title="Permalink to this definition">¶</a></dt>
1557 <dd><p>Property to instanciate the SFA API based in sfi client.
1558 For each SFA method called this instance is used.</p>
1559 </dd></dl>
1560
1561 <dl class="method">
1562 <dt id="nepi.resources.omf.wilabt_node.WilabtSfaNode.valid_connection">
1563 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/resources/omf/wilabt_node.html#WilabtSfaNode.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.resources.omf.wilabt_node.WilabtSfaNode.valid_connection" title="Permalink to this definition">¶</a></dt>
1564 <dd></dd></dl>
1565
1566 </dd></dl>
1567
1568 </div>
1569 <div class="section" id="module-nepi.resources.omf">
1570 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.resources.omf" title="Permalink to this headline">¶</a></h2>
1571 </div>
1572 </div>
1573
1574
1575           </div>
1576         </div>
1577       </div>
1578       <div class="clearer"></div>
1579     </div>
1580     <div class="related">
1581       <h3>Navigation</h3>
1582       <ul>
1583         <li class="right" style="margin-right: 10px">
1584           <a href="../genindex.html" title="General Index"
1585              >index</a></li>
1586         <li class="right" >
1587           <a href="../py-modindex.html" title="Python Module Index"
1588              >modules</a> |</li>
1589         <li><a href="../index.html">NEPI 3.2 documentation</a> &raquo;</li>
1590       </ul>
1591     </div>
1592     <div class="footer">
1593         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
1594       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
1595     </div>
1596   </body>
1597 </html>