aboutsummaryrefslogtreecommitdiffstats
path: root/utils/messages.html
diff options
context:
space:
mode:
Diffstat (limited to 'utils/messages.html')
-rwxr-xr-x[-rw-r--r--]utils/messages.html35
1 files changed, 18 insertions, 17 deletions
diff --git a/utils/messages.html b/utils/messages.html
index 65731a1..e703dbe 100644..100755
--- a/utils/messages.html
+++ b/utils/messages.html
@@ -30,6 +30,9 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
34 <link rel="up" title="utils – Utilities" href="index.html"/> 37 <link rel="up" title="utils – Utilities" href="index.html"/>
35 <link rel="next" title="settings – Settings Utilities" href="settings.html"/> 38 <link rel="next" title="settings – Settings Utilities" href="settings.html"/>
@@ -61,7 +64,7 @@
61 64
62 65
63 <div class="version"> 66 <div class="version">
64 0.2.7.1 67 0.3-rc8
65 </div> 68 </div>
66 69
67 70
@@ -95,7 +98,7 @@
95<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current"> 98<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current">
96<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 99<li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
97<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 100<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
98<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 101<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
99<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li> 102<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
100<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li> 103<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
101</ul> 104</ul>
@@ -125,7 +128,7 @@
125 <div class="rst-content"> 128 <div class="rst-content">
126 129
127 130
128 131
129 132
130 133
131 134
@@ -141,7 +144,7 @@
141 <li class="wy-breadcrumbs-aside"> 144 <li class="wy-breadcrumbs-aside">
142 145
143 146
144 <a href="../_sources/utils/messages.txt" rel="nofollow"> View page source</a> 147 <a href="../_sources/utils/messages.rst.txt" rel="nofollow"> View page source</a>
145 148
146 149
147 </li> 150 </li>
@@ -163,8 +166,8 @@
163<tbody valign="top"> 166<tbody valign="top">
164<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 167<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
165<li><strong>socket</strong> &#8211; socket to send the message with</li> 168<li><strong>socket</strong> &#8211; socket to send the message with</li>
166<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li> 169<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li>
167<li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; The message to send. The first frame should be an 170<li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; The message to send. The first frame should be an
168empty string</li> 171empty string</li>
169</ul> 172</ul>
170</td> 173</td>
@@ -182,7 +185,7 @@ be prefixed with <cite>prefix</cite>.</p>
182<col class="field-name" /> 185<col class="field-name" />
183<col class="field-body" /> 186<col class="field-body" />
184<tbody valign="top"> 187<tbody valign="top">
185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Value to prefix on to the random part of the id. Useful 188<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Value to prefix on to the random part of the id. Useful
186for prefixing some meta data to use for things</td> 189for prefixing some meta data to use for things</td>
187</tr> 190</tr>
188</tbody> 191</tbody>
@@ -245,7 +248,7 @@ parts.</p>
245<tbody valign="top"> 248<tbody valign="top">
246<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> 249<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td>
247</tr> 250</tr>
248<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td> 251<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td>
249</tr> 252</tr>
250</tbody> 253</tbody>
251</table> 254</table>
@@ -260,22 +263,20 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
260<col class="field-name" /> 263<col class="field-name" />
261<col class="field-body" /> 264<col class="field-body" />
262<tbody valign="top"> 265<tbody valign="top">
263<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 266<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
264<li><strong>socket</strong> &#8211; socket to send the message with</li> 267<li><strong>socket</strong> &#8211; socket to send the message with</li>
265<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li> 268<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li>
266<li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the eMQP command to send</li> 269<li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the eMQP command to send</li>
267<li><strong>message</strong> &#8211; a msg tuple to send</li> 270<li><strong>message</strong> &#8211; a msg tuple to send</li>
268</ul> 271</ul>
269</td> 272</td>
270</tr> 273</tr>
271<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Message id for this message</p>
272</td>
273</tr>
274<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
275</td>
276</tr>
277</tbody> 274</tbody>
278</table> 275</table>
276<dl class="docutils">
277<dt>Returns</dt>
278<dd>str: Message id for this message</dd>
279</dl>
279</dd></dl> 280</dd></dl>
280 281
281</div> 282</div>