1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.omf.messages_6 — NEPI 3.0 documentation</title>
11 <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../../',
18 COLLAPSE_INDEX: false,
23 <script type="text/javascript" src="../../../../_static/jquery.js"></script>
24 <script type="text/javascript" src="../../../../_static/underscore.js"></script>
25 <script type="text/javascript" src="../../../../_static/doctools.js"></script>
26 <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
27 <link rel="up" title="Module code" href="../../../index.html" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
40 <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
47 <form class="search" action="../../../../search.html" method="get">
48 <input type="text" name="q" />
49 <input type="submit" value="Go" />
50 <input type="hidden" name="check_keywords" value="yes" />
51 <input type="hidden" name="area" value="default" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <h1>Source code for nepi.resources.omf.messages_6</h1><div class="highlight"><pre>
67 <span class="c">#</span>
68 <span class="c"># NEPI, a framework to manage network experiments</span>
69 <span class="c"># Copyright (C) 2013 INRIA</span>
70 <span class="c">#</span>
71 <span class="c"># This program is free software: you can redistribute it and/or modify</span>
72 <span class="c"># it under the terms of the GNU General Public License version 2 as</span>
73 <span class="c"># published by the Free Software Foundation;</span>
74 <span class="c">#</span>
75 <span class="c"># This program is distributed in the hope that it will be useful,</span>
76 <span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
77 <span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
78 <span class="c"># GNU General Public License for more details.</span>
79 <span class="c">#</span>
80 <span class="c"># You should have received a copy of the GNU General Public License</span>
81 <span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
84 <span class="c"># Julien Tribino <julien.tribino@inria.fr></span>
86 <span class="kn">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>
88 <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>
89 <span class="sd">"""</span>
90 <span class="sd"> .. class:: Class Args :</span>
91 <span class="sd"> </span>
92 <span class="sd"> :param sliceid: Slice Name (= Xmpp Slice)</span>
93 <span class="sd"> :type expid: str</span>
94 <span class="sd"> :param expid: Experiment ID (= Xmpp User)</span>
95 <span class="sd"> :type expid: str</span>
97 <span class="sd"> .. note::</span>
99 <span class="sd"> This class is used only for OMF 5.4 Protocol and is going to become unused</span>
101 <span class="sd"> """</span>
103 <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
104 <span class="sd">"""</span>
105 <span class="sd"> </span>
106 <span class="sd"> """</span>
107 <span class="k">pass</span>
109 <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>
110 <span class="sd">""" Insert a markup element with an id</span>
112 <span class="sd"> """</span>
113 <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>
114 <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>
115 <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>
116 <span class="k">return</span> <span class="n">elt</span>
120 <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>
121 <span class="sd">""" Insert a markup element with a text (value)</span>
123 <span class="sd"> :param parent: Parent element in an XML point of view</span>
124 <span class="sd"> :type parent: ElementTree Element</span>
125 <span class="sd"> :param markup: Name of the markup</span>
126 <span class="sd"> :type markup: str</span>
127 <span class="sd"> :param text: Value of the markup element</span>
128 <span class="sd"> :type text: str</span>
130 <span class="sd"> """</span>
131 <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>
132 <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>
133 <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>
134 <span class="n">elt</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span>
135 <span class="k">return</span> <span class="n">elt</span>
137 <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>
138 <span class="sd">""" Insert a markup element with a text (value)</span>
140 <span class="sd"> :param parent: Parent element in an XML point of view</span>
141 <span class="sd"> :type parent: ElementTree Element</span>
142 <span class="sd"> :param markup: Name of the markup</span>
143 <span class="sd"> :type markup: str</span>
144 <span class="sd"> :param text: Value of the markup element</span>
145 <span class="sd"> :type text: str</span>
147 <span class="sd"> """</span>
148 <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>
149 <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>
150 <span class="k">return</span> <span class="n">elt</span>
152 <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>
153 <span class="sd">""" Build a create message</span>
155 <span class="sd"> :param msg_id: Id of the message</span>
156 <span class="sd"> :type msg_id: str</span>
157 <span class="sd"> :param src: Src node that send the message (jabber source)</span>
158 <span class="sd"> :type src: str</span>
159 <span class="sd"> :param rtype: Type of the object</span>
160 <span class="sd"> :type rtype: str</span>
161 <span class="sd"> :param timestamp: Unix Timestamp</span>
162 <span class="sd"> :type timestamp: str</span>
163 <span class="sd"> :param props: List of properties</span>
164 <span class="sd"> :type props: list</span>
165 <span class="sd"> :param guards: list of guards (assertions for properties)</span>
166 <span class="sd"> :type guards: list</span>
167 <span class="sd"> """</span>
168 <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>
169 <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>
170 <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>
171 <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>
173 <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
174 <span class="k">if</span> <span class="n">rtype</span> <span class="o">==</span> <span class="s">"application"</span> <span class="p">:</span>
175 <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>
176 <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol/application"</span><span class="p">)</span>
177 <span class="k">elif</span> <span class="n">rtype</span> <span class="o">==</span> <span class="s">"wlan"</span> <span class="p">:</span>
178 <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>
179 <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol/wlan"</span><span class="p">)</span>
180 <span class="k">else</span><span class="p">:</span>
181 <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>
183 <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>
184 <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>
185 <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>
186 <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>
187 <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>
188 <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>
189 <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>
191 <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
192 <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>
193 <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>
194 <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>
196 <span class="k">return</span> <span class="n">payload</span>
198 <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>
199 <span class="sd">""" Build a configure message</span>
201 <span class="sd"> :param msg_id: Id of the message</span>
202 <span class="sd"> :type msg_id: str</span>
203 <span class="sd"> :param src: Src node that send the message (jabber source)</span>
204 <span class="sd"> :type src: str</span>
205 <span class="sd"> :param timestamp: Unix Timestamp</span>
206 <span class="sd"> :type timestamp: str</span>
207 <span class="sd"> :param props: List of properties</span>
208 <span class="sd"> :type props: list</span>
209 <span class="sd"> :param guards: list of guards (assertions for properties)</span>
210 <span class="sd"> :type guards: list</span>
211 <span class="sd"> """</span>
212 <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>
213 <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>
214 <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>
216 <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
217 <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>
218 <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>
219 <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>
221 <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
222 <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>
223 <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>
224 <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>
226 <span class="k">return</span> <span class="n">payload</span>
228 <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>
229 <span class="sd">""" Build a request message</span>
231 <span class="sd"> :param msg_id: Id of the message</span>
232 <span class="sd"> :type msg_id: str</span>
233 <span class="sd"> :param src: Src node that send the message (jabber source)</span>
234 <span class="sd"> :type src: str</span>
235 <span class="sd"> :param timestamp: Unix Timestamp</span>
236 <span class="sd"> :type timestamp: str</span>
237 <span class="sd"> :param props: List of properties</span>
238 <span class="sd"> :type props: list</span>
239 <span class="sd"> :param guards: list of guards (assertions for properties)</span>
240 <span class="sd"> :type guards: list</span>
241 <span class="sd"> """</span>
242 <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>
243 <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>
244 <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>
246 <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
247 <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>
248 <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>
249 <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>
251 <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
252 <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>
253 <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>
254 <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>
255 <span class="k">return</span> <span class="n">payload</span>
257 <span class="c"># For now, we don't need the inform message since it is ht RC that send them.</span>
259 <span class="c"># def inform_function(self, msg_id, src, timestamp, cid, itype):</span>
260 <span class="c"># """ Build an inform message</span>
262 <span class="c"># :param msg_id: Id of the message</span>
263 <span class="c"># :type msg_id: str</span>
264 <span class="c"># :param src: Src node that send the message (jabber source)</span>
265 <span class="c"># :type src: str</span>
266 <span class="c"># :param rtype: Type of the object</span>
267 <span class="c"># :type rtype: str</span>
268 <span class="c"># :param timestamp: Unix Timestamp</span>
269 <span class="c"># :type timestamp: str</span>
270 <span class="c"># :param cid: Id of the orignial message</span>
271 <span class="c"># :type cid: str</span>
272 <span class="c"># :param itype: type of the object created</span>
273 <span class="c"># :type itype: str</span>
274 <span class="c"># """</span>
276 <span class="c"># payload = self._type_element("inform", "http://schema.mytestbed.net/omf/6.0/protocol", msg_id )</span>
277 <span class="c"># sliceid = self._attr_element(payload,"src",src)</span>
278 <span class="c"># expid = self._attr_element(config,"ts",timestamp)</span>
279 <span class="c"># target = self._attr_element(config,"cid",cid)</span>
280 <span class="c"># value = self._attr_element(config,"itype",value)</span>
281 <span class="c"># path = self._attr_element(config,"properties",path)</span>
282 <span class="c"># return payload</span>
284 <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>
285 <span class="sd">""" Build a release message</span>
287 <span class="sd"> :param msg_id: Id of the message</span>
288 <span class="sd"> :type msg_id: str</span>
289 <span class="sd"> :param src: Src node that send the message (jabber source)</span>
290 <span class="sd"> :type src: str</span>
291 <span class="sd"> :param timestamp: Unix Timestamp</span>
292 <span class="sd"> :type timestamp: str</span>
293 <span class="sd"> :param res_id: Id of the release resource</span>
294 <span class="sd"> :type res_id: str</span>
295 <span class="sd"> :param props: List of properties</span>
296 <span class="sd"> :type props: list</span>
297 <span class="sd"> :param guards: list of guards (assertions for properties)</span>
298 <span class="sd"> :type guards: list</span>
299 <span class="sd"> """</span>
300 <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>
301 <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>
302 <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>
303 <span class="k">if</span> <span class="n">res_id</span> <span class="p">:</span>
304 <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>
306 <span class="k">if</span> <span class="n">props</span> <span class="p">:</span>
307 <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>
308 <span class="s">"http://schema.mytestbed.net/omf/6.0/protocol"</span><span class="p">)</span>
309 <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>
310 <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>
312 <span class="k">if</span> <span class="n">guards</span> <span class="p">:</span>
313 <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>
314 <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>
315 <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>
317 <span class="k">return</span> <span class="n">payload</span>
318 </pre></div></div></div>
323 <div class="clearer"></div>
325 <div class="related">
328 <li class="right" style="margin-right: 10px">
329 <a href="../../../../genindex.html" title="General Index"
332 <a href="../../../../py-modindex.html" title="Python Module Index"
334 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
335 <li><a href="../../../index.html" >Module code</a> »</li>
339 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
340 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.