aboutsummaryrefslogtreecommitdiffstats
path: root/utils/messages.html
diff options
context:
space:
mode:
Diffstat (limited to 'utils/messages.html')
-rw-r--r--utils/messages.html51
1 files changed, 40 insertions, 11 deletions
diff --git a/utils/messages.html b/utils/messages.html
index 08a6c1e..6ecfa47 100644
--- a/utils/messages.html
+++ b/utils/messages.html
@@ -31,9 +31,9 @@
31 31
32 32
33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
34 <link rel="up" title="utils – Utilities" href="../utils.html"/> 34 <link rel="up" title="utils – Utilities" href="index.html"/>
35 <link rel="next" title="timeutils – Time Utilites" href="timeutils.html"/> 35 <link rel="next" title="settings – Settings Utilities" href="settings.html"/>
36 <link rel="prev" title="classes – Utility Classes" href="classes.html"/> 36 <link rel="prev" title="devices – Device Utilities" href="devices.html"/>
37 37
38 38
39 <script src="../_static/js/modernizr.min.js"></script> 39 <script src="../_static/js/modernizr.min.js"></script>
@@ -61,7 +61,7 @@
61 61
62 62
63 <div class="version"> 63 <div class="version">
64 0 64 0.2.1
65 </div> 65 </div>
66 66
67 67
@@ -83,6 +83,7 @@
83 83
84 84
85 <ul class="current"> 85 <ul class="current">
86<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li>
86<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> 87<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
87<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> 88<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>
88<li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li> 89<li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
@@ -91,9 +92,11 @@
91<li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 92<li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
92<li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 93<li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
93<li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 94<li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
94<li class="toctree-l2 current"><a class="reference internal" href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current"> 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">
95<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> 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>
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>
96<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> 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>
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>
97<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> 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>
98</ul> 101</ul>
99</li> 102</li>
@@ -132,7 +135,7 @@
132 135
133 <li><a href="../api.html">API Documentation</a> &raquo;</li> 136 <li><a href="../api.html">API Documentation</a> &raquo;</li>
134 137
135 <li><a href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a> &raquo;</li> 138 <li><a href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a> &raquo;</li>
136 139
137 <li><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</li> 140 <li><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</li>
138 <li class="wy-breadcrumbs-aside"> 141 <li class="wy-breadcrumbs-aside">
@@ -154,6 +157,20 @@
154<dt id="eventmq.utils.messages.fwd_emqp_router_message"> 157<dt id="eventmq.utils.messages.fwd_emqp_router_message">
155<code class="descclassname">eventmq.utils.messages.</code><code class="descname">fwd_emqp_router_message</code><span class="sig-paren">(</span><em>socket</em>, <em>recipient_id</em>, <em>payload</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.messages.fwd_emqp_router_message" title="Permalink to this definition">¶</a></dt> 158<code class="descclassname">eventmq.utils.messages.</code><code class="descname">fwd_emqp_router_message</code><span class="sig-paren">(</span><em>socket</em>, <em>recipient_id</em>, <em>payload</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.messages.fwd_emqp_router_message" title="Permalink to this definition">¶</a></dt>
156<dd><p>Forwards <cite>payload</cite> to socket untouched.</p> 159<dd><p>Forwards <cite>payload</cite> to socket untouched.</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"><ul class="first last simple">
165<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>
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
168empty string</li>
169</ul>
170</td>
171</tr>
172</tbody>
173</table>
157</dd></dl> 174</dd></dl>
158 175
159<dl class="function"> 176<dl class="function">
@@ -222,6 +239,16 @@ parts.</p>
222</tbody> 239</tbody>
223</table> 240</table>
224<p>Raises:</p> 241<p>Raises:</p>
242<table class="docutils field-list" frame="void" rules="none">
243<col class="field-name" />
244<col class="field-body" />
245<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>
247</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>
249</tr>
250</tbody>
251</table>
225</dd></dl> 252</dd></dl>
226 253
227<dl class="function"> 254<dl class="function">
@@ -243,8 +270,10 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
243</tr> 270</tr>
244</tbody> 271</tbody>
245</table> 272</table>
246<p>Raises:</p> 273<dl class="docutils">
247<p>Returns</p> 274<dt>Returns</dt>
275<dd>str: Message id for this message</dd>
276</dl>
248</dd></dl> 277</dd></dl>
249 278
250</div> 279</div>
@@ -256,10 +285,10 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
256 285
257 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 286 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
258 287
259 <a href="timeutils.html" class="btn btn-neutral float-right" title="timeutils – Time Utilites" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 288 <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>
260 289
261 290
262 <a href="classes.html" class="btn btn-neutral" title="classes – Utility Classes" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 291 <a href="devices.html" class="btn btn-neutral" title="devices – Device Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
263 292
264 </div> 293 </div>
265 294
@@ -268,7 +297,7 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R
268 297
269 <div role="contentinfo"> 298 <div role="contentinfo">
270 <p> 299 <p>
271 &copy; Copyright 2015, eventboard.io. 300 &copy; Copyright 2016, eventboard.io.
272 301
273 </p> 302 </p>
274 </div> 303 </div>