--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.resources.omf.messages_6 — NEPI 3.0 documentation</title>
+
+ <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../../',
+ VERSION: '3.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../../_static/doctools.js"></script>
+ <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
+ <link rel="up" title="Module code" href="../../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.resources.omf.messages_6</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
+<span class="c"># Julien Tribino <julien.tribino@inria.fr></span>
+
+<span class="kn">from</span> <span class="nn">xml.etree</span> <span class="kn">import</span> <span class="n">cElementTree</span> <span class="k">as</span> <span class="n">ET</span>
+
+<div class="viewcode-block" id="MessageHandler"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_6.MessageHandler">[docs]</a><span class="k">class</span> <span class="nc">MessageHandler</span><span class="p">():</span>
+ <span class="sd">"""</span>
+<span class="sd"> .. class:: Class Args :</span>
+<span class="sd"> </span>
+<span class="sd"> :param sliceid: Slice Name (= Xmpp Slice)</span>
+<span class="sd"> :type expid: str</span>
+<span class="sd"> :param expid: Experiment ID (= Xmpp User)</span>
+<span class="sd"> :type expid: str</span>
+
+<span class="sd"> .. note::</span>
+
+<span class="sd"> This class is used only for OMF 5.4 Protocol and is going to become unused</span>
+
+<span class="sd"> """</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> </span>
+<span class="sd"> """</span>
+ <span class="k">pass</span>
+
+ <span class="k">def</span> <span class="nf">_type_element</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">type_elt</span><span class="p">,</span> <span class="n">xmlns</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">):</span>
+ <span class="sd">""" Insert a markup element with an id</span>
+
+<span class="sd"> """</span>
+ <span class="n">elt</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="n">type_elt</span><span class="p">)</span>
+ <span class="n">elt</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"xmlns"</span><span class="p">,</span> <span class="n">xmlns</span><span class="p">)</span>
+ <span class="n">elt</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"mid"</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">elt</span>
+
+
+
+ <span class="k">def</span> <span class="nf">_attr_element</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">type_key</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">type_value</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">""" Insert a markup element with a text (value)</span>
+
+<span class="sd"> :param parent: Parent element in an XML point of view</span>
+<span class="sd"> :type parent: ElementTree Element</span>
+<span class="sd"> :param markup: Name of the markup</span>
+<span class="sd"> :type markup: str</span>
+<span class="sd"> :param text: Value of the markup element</span>
+<span class="sd"> :type text: str</span>
+
+<span class="sd"> """</span>
+ <span class="n">elt</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">type_key</span> <span class="ow">and</span> <span class="n">type_value</span><span class="p">:</span>
+ <span class="n">elt</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">type_key</span><span class="p">,</span> <span class="n">type_value</span><span class="p">)</span>
+ <span class="n">elt</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span>
+ <span class="k">return</span> <span class="n">elt</span>
+
+ <span class="k">def</span> <span class="nf">_id_element</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">""" Insert a markup element with a text (value)</span>
+
+<span class="sd"> :param parent: Parent element in an XML point of view</span>
+<span class="sd"> :type parent: ElementTree Element</span>
+<span class="sd"> :param markup: Name of the markup</span>
+<span class="sd"> :type markup: str</span>
+<span class="sd"> :param text: Value of the markup element</span>
+<span class="sd"> :type text: str</span>
+
+<span class="sd"> """</span>
+ <span class="n">elt</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">)</span>
+ <span class="n">elt</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">elt</span>
+
+<div class="viewcode-block" id="MessageHandler.create_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_6.MessageHandler.create_function">[docs]</a> <span class="k">def</span> <span class="nf">create_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">rtype</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">""" Build a create message</span>
+
+<span class="sd"> :param msg_id: Id of the message</span>
+<span class="sd"> :type msg_id: str</span>
+<span class="sd"> :param src: Src node that send the message (jabber source)</span>
+<span class="sd"> :type src: str</span>
+<span class="sd"> :param rtype: Type of the object</span>
+<span class="sd"> :type rtype: str</span>
+<span class="sd"> :param timestamp: Unix Timestamp</span>
+<span class="sd"> :type timestamp: str</span>
+<span class="sd"> :param props: List of properties</span>
+<span class="sd"> :type props: list</span>
+<span class="sd"> :param guards: list of guards (assertions for properties)</span>
+<span class="sd"> :type guards: list</span>
+<span class="sd"> """</span>
+ <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type_element</span><span class="p">(</span><span class="s">"create"</span><span class="p">,</span> <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol"</span><span class="p">,</span> <span class="n">msg_id</span> <span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"src"</span><span class="p">,</span><span class="n">src</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"ts"</span><span class="p">,</span><span class="n">timestamp</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"rtype"</span><span class="p">,</span><span class="n">rtype</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
+ <span class="k">if</span> <span class="n">rtype</span> <span class="o">==</span> <span class="s">"application"</span> <span class="p">:</span>
+ <span class="n">properties</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"props"</span><span class="p">,</span><span class="s">"xmlns:application"</span><span class="p">,</span>
+ <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol/application"</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="n">rtype</span> <span class="o">==</span> <span class="s">"wlan"</span> <span class="p">:</span>
+ <span class="n">properties</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"props"</span><span class="p">,</span><span class="s">"xmlns:wlan"</span><span class="p">,</span>
+ <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol/wlan"</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">properties</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"props"</span><span class="p">,</span><span class="s">""</span><span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">props</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">],</span><span class="nb">str</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">properties</span><span class="p">,</span><span class="n">prop</span><span class="p">,</span><span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">],</span><span class="n">type_key</span><span class="o">=</span><span class="s">"type"</span><span class="p">,</span> <span class="n">type_value</span> <span class="o">=</span> <span class="s">"string"</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">],</span><span class="nb">dict</span><span class="p">):</span>
+ <span class="n">key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">properties</span><span class="p">,</span><span class="n">prop</span><span class="p">,</span><span class="s">""</span><span class="p">,</span><span class="n">type_key</span><span class="o">=</span><span class="s">"type"</span><span class="p">,</span> <span class="n">type_value</span> <span class="o">=</span> <span class="s">"hash"</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">comp</span> <span class="ow">in</span> <span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">key</span><span class="p">,</span><span class="n">comp</span><span class="p">,</span><span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">][</span><span class="n">comp</span><span class="p">],</span><span class="n">type_key</span><span class="o">=</span><span class="s">"type"</span><span class="p">,</span> <span class="n">type_value</span> <span class="o">=</span> <span class="s">"string"</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
+ <span class="n">guardians</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"guard"</span><span class="p">,</span><span class="s">""</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">guard</span> <span class="ow">in</span> <span class="n">guards</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">guardians</span><span class="p">,</span><span class="n">guard</span><span class="p">,</span><span class="n">guards</span><span class="p">[</span><span class="n">guard</span><span class="p">],</span><span class="n">type_key</span><span class="o">=</span><span class="s">"type"</span><span class="p">,</span> <span class="n">type_value</span> <span class="o">=</span> <span class="s">"string"</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">payload</span>
+</div>
+<div class="viewcode-block" id="MessageHandler.configure_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_6.MessageHandler.configure_function">[docs]</a> <span class="k">def</span> <span class="nf">configure_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">""" Build a configure message</span>
+
+<span class="sd"> :param msg_id: Id of the message</span>
+<span class="sd"> :type msg_id: str</span>
+<span class="sd"> :param src: Src node that send the message (jabber source)</span>
+<span class="sd"> :type src: str</span>
+<span class="sd"> :param timestamp: Unix Timestamp</span>
+<span class="sd"> :type timestamp: str</span>
+<span class="sd"> :param props: List of properties</span>
+<span class="sd"> :type props: list</span>
+<span class="sd"> :param guards: list of guards (assertions for properties)</span>
+<span class="sd"> :type guards: list</span>
+<span class="sd"> """</span>
+ <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type_element</span><span class="p">(</span><span class="s">"configure"</span><span class="p">,</span> <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol"</span><span class="p">,</span> <span class="n">msg_id</span> <span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"src"</span><span class="p">,</span><span class="n">src</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"ts"</span><span class="p">,</span><span class="n">timestamp</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
+ <span class="n">properties</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"props"</span><span class="p">,</span><span class="s">""</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">props</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">properties</span><span class="p">,</span><span class="n">prop</span><span class="p">,</span><span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">],</span><span class="n">type_key</span><span class="o">=</span><span class="s">"type"</span><span class="p">,</span> <span class="n">type_value</span> <span class="o">=</span> <span class="s">"symbol"</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
+ <span class="n">guardians</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"guard"</span><span class="p">,</span><span class="s">""</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">guard</span> <span class="ow">in</span> <span class="n">guards</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">guardians</span><span class="p">,</span><span class="n">guard</span><span class="p">,</span><span class="n">guards</span><span class="p">[</span><span class="n">guard</span><span class="p">],</span><span class="n">type_key</span><span class="o">=</span><span class="s">"type"</span><span class="p">,</span> <span class="n">type_value</span> <span class="o">=</span> <span class="s">"string"</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">payload</span>
+</div>
+<div class="viewcode-block" id="MessageHandler.request_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_6.MessageHandler.request_function">[docs]</a> <span class="k">def</span> <span class="nf">request_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">""" Build a request message</span>
+
+<span class="sd"> :param msg_id: Id of the message</span>
+<span class="sd"> :type msg_id: str</span>
+<span class="sd"> :param src: Src node that send the message (jabber source)</span>
+<span class="sd"> :type src: str</span>
+<span class="sd"> :param timestamp: Unix Timestamp</span>
+<span class="sd"> :type timestamp: str</span>
+<span class="sd"> :param props: List of properties</span>
+<span class="sd"> :type props: list</span>
+<span class="sd"> :param guards: list of guards (assertions for properties)</span>
+<span class="sd"> :type guards: list</span>
+<span class="sd"> """</span>
+ <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type_element</span><span class="p">(</span><span class="s">"request"</span><span class="p">,</span> <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol"</span><span class="p">,</span> <span class="n">msg_id</span> <span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"src"</span><span class="p">,</span><span class="n">src</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"ts"</span><span class="p">,</span><span class="n">timestamp</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
+ <span class="n">properties</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"props"</span><span class="p">,</span><span class="s">""</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">props</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">properties</span><span class="p">,</span><span class="n">prop</span><span class="p">,</span><span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">])</span>
+
+ <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
+ <span class="n">guardians</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"guard"</span><span class="p">,</span><span class="s">""</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">guard</span> <span class="ow">in</span> <span class="n">guards</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">guardians</span><span class="p">,</span><span class="n">guard</span><span class="p">,</span><span class="n">guards</span><span class="p">[</span><span class="n">guard</span><span class="p">])</span>
+ <span class="k">return</span> <span class="n">payload</span>
+
+<span class="c"># For now, we don't need the inform message since it is ht RC that send them.</span>
+
+<span class="c"># def inform_function(self, msg_id, src, timestamp, cid, itype):</span>
+<span class="c"># """ Build an inform message</span>
+
+<span class="c"># :param msg_id: Id of the message</span>
+<span class="c"># :type msg_id: str</span>
+<span class="c"># :param src: Src node that send the message (jabber source)</span>
+<span class="c"># :type src: str</span>
+<span class="c"># :param rtype: Type of the object</span>
+<span class="c"># :type rtype: str</span>
+<span class="c"># :param timestamp: Unix Timestamp</span>
+<span class="c"># :type timestamp: str</span>
+<span class="c"># :param cid: Id of the orignial message</span>
+<span class="c"># :type cid: str</span>
+<span class="c"># :param itype: type of the object created</span>
+<span class="c"># :type itype: str</span>
+<span class="c"># """</span>
+
+<span class="c"># payload = self._type_element("inform", "http://schema.mytestbed.net/omf/6.0/protocol", msg_id )</span>
+<span class="c"># sliceid = self._attr_element(payload,"src",src)</span>
+<span class="c"># expid = self._attr_element(config,"ts",timestamp)</span>
+<span class="c"># target = self._attr_element(config,"cid",cid)</span>
+<span class="c"># value = self._attr_element(config,"itype",value)</span>
+<span class="c"># path = self._attr_element(config,"properties",path)</span>
+<span class="c"># return payload</span>
+</div>
+<div class="viewcode-block" id="MessageHandler.release_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_6.MessageHandler.release_function">[docs]</a> <span class="k">def</span> <span class="nf">release_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">,</span> <span class="n">src</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">res_id</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">props</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">guards</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">""" Build a release message</span>
+
+<span class="sd"> :param msg_id: Id of the message</span>
+<span class="sd"> :type msg_id: str</span>
+<span class="sd"> :param src: Src node that send the message (jabber source)</span>
+<span class="sd"> :type src: str</span>
+<span class="sd"> :param timestamp: Unix Timestamp</span>
+<span class="sd"> :type timestamp: str</span>
+<span class="sd"> :param res_id: Id of the release resource</span>
+<span class="sd"> :type res_id: str</span>
+<span class="sd"> :param props: List of properties</span>
+<span class="sd"> :type props: list</span>
+<span class="sd"> :param guards: list of guards (assertions for properties)</span>
+<span class="sd"> :type guards: list</span>
+<span class="sd"> """</span>
+ <span class="n">payload</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type_element</span><span class="p">(</span><span class="s">"release"</span><span class="p">,</span> <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol"</span><span class="p">,</span> <span class="n">msg_id</span> <span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"src"</span><span class="p">,</span><span class="n">src</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"ts"</span><span class="p">,</span><span class="n">timestamp</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">res_id</span> <span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"res_id"</span><span class="p">,</span><span class="n">res_id</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
+ <span class="n">properties</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"props"</span><span class="p">,</span><span class="s">"xmlns:frcp"</span><span class="p">,</span>
+ <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol"</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">props</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">properties</span><span class="p">,</span><span class="n">prop</span><span class="p">,</span><span class="n">props</span><span class="p">[</span><span class="n">prop</span><span class="p">])</span>
+
+ <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
+ <span class="n">guardians</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">"guard"</span><span class="p">,</span><span class="s">""</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">guard</span> <span class="ow">in</span> <span class="n">guards</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">guardians</span><span class="p">,</span><span class="n">guard</span><span class="p">,</span><span class="n">guards</span><span class="p">[</span><span class="n">guard</span><span class="p">])</span>
+
+ <span class="k">return</span> <span class="n">payload</span>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
git://git.onelab.eu / nepi.git / blobdiff