aboutsummaryrefslogtreecommitdiffstats
path: root/utils/messages.html
diff options
context:
space:
mode:
Diffstat (limited to 'utils/messages.html')
-rwxr-xr-xutils/messages.html69
1 files changed, 49 insertions, 20 deletions
diff --git a/utils/messages.html b/utils/messages.html
index 83af15b..1c099e0 100755
--- a/utils/messages.html
+++ b/utils/messages.html
@@ -13,6 +13,8 @@
13 13
14 14
15 15
16
17
16 18
17 19
18 20
@@ -45,6 +47,7 @@
45 47
46<body class="wy-body-for-nav" role="document"> 48<body class="wy-body-for-nav" role="document">
47 49
50
48 <div class="wy-grid-for-nav"> 51 <div class="wy-grid-for-nav">
49 52
50 53
@@ -64,7 +67,7 @@
64 67
65 68
66 <div class="version"> 69 <div class="version">
67 0.3.3 70 0.3.6
68 </div> 71 </div>
69 72
70 73
@@ -85,7 +88,10 @@
85 88
86 89
87 90
88 <ul class="current"> 91
92
93
94 <ul class="current">
89<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li> 95<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> 96<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
91<li class="toctree-l2"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li> 97<li class="toctree-l2"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li>
@@ -118,8 +124,10 @@
118 124
119 125
120 <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> 126 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
121 <i data-toggle="wy-nav-top" class="fa fa-bars"></i> 127
122 <a href="../index.html">EventMQ</a> 128 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
129 <a href="../index.html">EventMQ</a>
130
123 </nav> 131 </nav>
124 132
125 133
@@ -128,27 +136,44 @@
128 <div class="rst-content"> 136 <div class="rst-content">
129 137
130 138
131 139
140
141
142
143
144
145
146
147
148
149
132 150
133 151
134 152
135<div role="navigation" aria-label="breadcrumbs navigation"> 153<div role="navigation" aria-label="breadcrumbs navigation">
154
136 <ul class="wy-breadcrumbs"> 155 <ul class="wy-breadcrumbs">
137 <li><a href="../index.html">Docs</a> &raquo;</li> 156
138 157 <li><a href="../index.html">Docs</a> &raquo;</li>
158
139 <li><a href="../api.html">API Documentation</a> &raquo;</li> 159 <li><a href="../api.html">API Documentation</a> &raquo;</li>
140 160
141 <li><a href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a> &raquo;</li> 161 <li><a href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a> &raquo;</li>
142 162
143 <li><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</li> 163 <li><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</li>
164
165
144 <li class="wy-breadcrumbs-aside"> 166 <li class="wy-breadcrumbs-aside">
145 167
146 168
147 <a href="../_sources/utils/messages.rst.txt" rel="nofollow"> View page source</a> 169 <a href="../_sources/utils/messages.rst.txt" rel="nofollow"> View page source</a>
148 170
149 171
150 </li> 172 </li>
173
151 </ul> 174 </ul>
175
176
152 <hr/> 177 <hr/>
153</div> 178</div>
154 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 179 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
@@ -166,8 +191,8 @@
166<tbody valign="top"> 191<tbody valign="top">
167<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 192<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
168<li><strong>socket</strong> &#8211; socket to send the message with</li> 193<li><strong>socket</strong> &#8211; socket to send the message with</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> 194<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</li>
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 195<li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><em>tuple</em></a>) &#8211; The message to send. The first frame should be an
171empty string</li> 196empty string</li>
172</ul> 197</ul>
173</td> 198</td>
@@ -185,7 +210,7 @@ be prefixed with <cite>prefix</cite>.</p>
185<col class="field-name" /> 210<col class="field-name" />
186<col class="field-body" /> 211<col class="field-body" />
187<tbody valign="top"> 212<tbody valign="top">
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 213<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/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Value to prefix on to the random part of the id. Useful
189for prefixing some meta data to use for things</td> 214for prefixing some meta data to use for things</td>
190</tr> 215</tr>
191</tbody> 216</tbody>
@@ -248,7 +273,7 @@ parts.</p>
248<tbody valign="top"> 273<tbody valign="top">
249<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> 274<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td>
250</tr> 275</tr>
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> 276<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/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
252</tr> 277</tr>
253</tbody> 278</tbody>
254</table> 279</table>
@@ -265,8 +290,8 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
265<tbody valign="top"> 290<tbody valign="top">
266<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 291<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
267<li><strong>socket</strong> &#8211; socket to send the message with</li> 292<li><strong>socket</strong> &#8211; socket to send the message with</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> 293<li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; the id of the connected device to reply to</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> 294<li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; the eMQP command to send</li>
270<li><strong>message</strong> &#8211; a msg tuple to send</li> 295<li><strong>message</strong> &#8211; a msg tuple to send</li>
271</ul> 296</ul>
272</td> 297</td>
@@ -283,15 +308,18 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
283 308
284 309
285 </div> 310 </div>
311 <div class="articleComments">
312
313 </div>
286 </div> 314 </div>
287 <footer> 315 <footer>
288 316
289 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 317 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
290 318
291 <a href="settings.html" class="btn btn-neutral float-right" title="settings – Settings Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 319 <a href="settings.html" class="btn btn-neutral float-right" title="settings – Settings Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
292 320
293 321
294 <a href="devices.html" class="btn btn-neutral" title="devices – Device Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 322 <a href="devices.html" class="btn btn-neutral" title="devices – Device Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
295 323
296 </div> 324 </div>
297 325
@@ -325,7 +353,8 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
325 VERSION:'0', 353 VERSION:'0',
326 COLLAPSE_INDEX:false, 354 COLLAPSE_INDEX:false,
327 FILE_SUFFIX:'.html', 355 FILE_SUFFIX:'.html',
328 HAS_SOURCE: true 356 HAS_SOURCE: true,
357 SOURCELINK_SUFFIX: '.txt'
329 }; 358 };
330 </script> 359 </script>
331 <script type="text/javascript" src="../_static/jquery.js"></script> 360 <script type="text/javascript" src="../_static/jquery.js"></script>
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 04:54:34 +0000