aboutsummaryrefslogtreecommitdiffstats
path: root/utils
diff options
context:
space:
mode:
authorjason2016-05-24 20:19:12 -0600
committerjason2016-05-24 20:19:12 -0600
commit8a8396c454206feb589a806db2ddf8a03d2d757e (patch)
treef68b67d98bea14d0f15b0e11e3fe2c81a5376a9c /utils
parent8fc4bcc96063b29d0726feb7a72b28acf01b109c (diff)
downloadeventmq-8a8396c454206feb589a806db2ddf8a03d2d757e.tar.gz
eventmq-8a8396c454206feb589a806db2ddf8a03d2d757e.zip
0.2.1 update
Diffstat (limited to 'utils')
-rw-r--r--utils/classes.html54
-rw-r--r--utils/devices.html6
-rw-r--r--utils/index.html19
-rw-r--r--utils/messages.html51
-rw-r--r--utils/settings.html15
-rw-r--r--utils/timeutils.html17
6 files changed, 122 insertions, 40 deletions
diff --git a/utils/classes.html b/utils/classes.html
index 7a43ac8..a18e66e 100644
--- a/utils/classes.html
+++ b/utils/classes.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="index.html"/> 34 <link rel="up" title="utils Utilities" href="index.html"/>
35 <link rel="next" title="messages – Message Utilities" href="messages.html"/> 35 <link rel="next" title="devices – Device Utilities" href="devices.html"/>
36 <link rel="prev" title="utils - Utilities" href="index.html"/> 36 <link rel="prev" title="utils Utilities" href="index.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,11 +92,12 @@
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="index.html"><code class="docutils literal"><span class="pre">utils</span></code> - 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 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 96<li class="toctree-l3 current"><a class="current reference internal" href=""><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"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><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<li class="toctree-l3"><a class="reference internal" href="index.html#id1"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
99</ul> 101</ul>
100</li> 102</li>
101</ul> 103</ul>
@@ -133,7 +135,7 @@
133 135
134 <li><a href="../api.html">API Documentation</a> &raquo;</li> 136 <li><a href="../api.html">API Documentation</a> &raquo;</li>
135 137
136 <li><a href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> - 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>
137 139
138 <li><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</li> 140 <li><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</li>
139 <li class="wy-breadcrumbs-aside"> 141 <li class="wy-breadcrumbs-aside">
@@ -224,27 +226,45 @@ as the first arguments.</p>
224 226
225<dl class="method"> 227<dl class="method">
226<dt id="eventmq.utils.classes.EMQPService.send_inform"> 228<dt id="eventmq.utils.classes.EMQPService.send_inform">
227<code class="descname">send_inform</code><span class="sig-paren">(</span><em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.send_inform" title="Permalink to this definition">¶</a></dt> 229<code class="descname">send_inform</code><span class="sig-paren">(</span><em>queues=()</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.send_inform" title="Permalink to this definition">¶</a></dt>
228<dd><p>Queues an INFORM command to <cite>self.outgoing</cite>.</p> 230<dd><p>Notify the router that this job manager is online and and ready for
231work. This includes a list of queues the router should forward messages
232for.</p>
229<table class="docutils field-list" frame="void" rules="none"> 233<table class="docutils field-list" frame="void" rules="none">
230<col class="field-name" /> 234<col class="field-name" />
231<col class="field-body" /> 235<col class="field-body" />
232<tbody valign="top"> 236<tbody valign="top">
233<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 237<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
234<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li> 238<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li>
235<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; <ul> 239<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; <ul>
236<li>For &#8216;worker&#8217; type, the queues the worker is listening on</li> 240<li>For &#8216;worker&#8217; type, the queues the worker is listening on and
241their weights.<dl class="docutils">
242<dt>Example:</dt>
243<dd>([10, &#8216;default&#8217;], [15, &#8216;push_notifications&#8217;])</dd>
244</dl>
245</li>
237<li>Ignored for &#8216;scheduler&#8217; type</li> 246<li>Ignored for &#8216;scheduler&#8217; type</li>
238</ul> 247</ul>
239</li> 248</li>
240</ul> 249</ul>
241</td> 250</td>
242</tr> 251</tr>
243<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> &#8211; When <cite>type_</cite> does not match a specified type</p> 252<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> &#8211; When <cite>type_</cite> does not match a specified type</p>
253</td>
254</tr>
255<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
256</td>
257</tr>
258<tr class="field-even 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>
244</td> 259</td>
245</tr> 260</tr>
246</tbody> 261</tbody>
247</table> 262</table>
263<div class="admonition note">
264<p class="first admonition-title">Note</p>
265<p class="last">Passing a single string for queues is supported for backward
266compatibility and not recommended for new apps.</p>
267</div>
248</dd></dl> 268</dd></dl>
249 269
250<dl class="method"> 270<dl class="method">
@@ -515,6 +535,10 @@ False</td>
515<tbody valign="top"> 535<tbody valign="top">
516<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td> 536<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td>
517</tr> 537</tr>
538<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td>
539</tr>
540<tr class="field-odd 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>
541</tr>
518</tbody> 542</tbody>
519</table> 543</table>
520</dd></dl> 544</dd></dl>
@@ -612,10 +636,10 @@ specify the the recipient id of the remote socket</li>
612 636
613 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 637 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
614 638
615 <a href="messages.html" class="btn btn-neutral float-right" title="messages – Message Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 639 <a href="devices.html" class="btn btn-neutral float-right" title="devices – Device Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
616 640
617 641
618 <a href="index.html" class="btn btn-neutral" title="utils - Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 642 <a href="index.html" class="btn btn-neutral" title="utils – Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
619 643
620 </div> 644 </div>
621 645
@@ -624,7 +648,7 @@ specify the the recipient id of the remote socket</li>
624 648
625 <div role="contentinfo"> 649 <div role="contentinfo">
626 <p> 650 <p>
627 &copy; Copyright 2015, eventboard.io. 651 &copy; Copyright 2016, eventboard.io.
628 652
629 </p> 653 </p>
630 </div> 654 </div>
diff --git a/utils/devices.html b/utils/devices.html
index b5d254a..ab3b6ce 100644
--- a/utils/devices.html
+++ b/utils/devices.html
@@ -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>
@@ -95,6 +96,7 @@
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>
96<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
97<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><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>
98<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>
99</ul> 101</ul>
100</li> 102</li>
@@ -191,7 +193,7 @@ causes errors when setting the IDENTITY of the ZMQ socket.</p>
191 193
192 <div role="contentinfo"> 194 <div role="contentinfo">
193 <p> 195 <p>
194 &copy; Copyright 2015, eventboard.io. 196 &copy; Copyright 2016, eventboard.io.
195 197
196 </p> 198 </p>
197 </div> 199 </div>
diff --git a/utils/index.html b/utils/index.html
index d58c3a3..0a370e0 100644
--- a/utils/index.html
+++ b/utils/index.html
@@ -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>
@@ -177,6 +178,20 @@ like creating message more simple.</p>
177</dd></dl> 178</dd></dl>
178 179
179<dl class="function"> 180<dl class="function">
181<dt id="eventmq.utils.tuplify">
182<code class="descclassname">eventmq.utils.</code><code class="descname">tuplify</code><span class="sig-paren">(</span><em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.tuplify" title="Permalink to this definition">¶</a></dt>
183<dd><p>Recursively convert lists to tuples.</p>
184<table class="docutils field-list" frame="void" rules="none">
185<col class="field-name" />
186<col class="field-body" />
187<tbody valign="top">
188<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>v</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; any value of interest</td>
189</tr>
190</tbody>
191</table>
192</dd></dl>
193
194<dl class="function">
180<dt id="eventmq.utils.zero_index_cmp"> 195<dt id="eventmq.utils.zero_index_cmp">
181<code class="descclassname">eventmq.utils.</code><code class="descname">zero_index_cmp</code><span class="sig-paren">(</span><em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.zero_index_cmp" title="Permalink to this definition">¶</a></dt> 196<code class="descclassname">eventmq.utils.</code><code class="descname">zero_index_cmp</code><span class="sig-paren">(</span><em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.zero_index_cmp" title="Permalink to this definition">¶</a></dt>
182<dd><p>same as <code class="docutils literal"><span class="pre">cmp</span></code> but using the 0-index in a list as the compare value. Used 197<dd><p>same as <code class="docutils literal"><span class="pre">cmp</span></code> but using the 0-index in a list as the compare value. Used
@@ -204,7 +219,7 @@ when sorting the values in <code class="xref py py-attr docutils literal"><span
204 219
205 <div role="contentinfo"> 220 <div role="contentinfo">
206 <p> 221 <p>
207 &copy; Copyright 2015, eventboard.io. 222 &copy; Copyright 2016, eventboard.io.
208 223
209 </p> 224 </p>
210 </div> 225 </div>
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>
diff --git a/utils/settings.html b/utils/settings.html
index 65fa6ff..a209af0 100644
--- a/utils/settings.html
+++ b/utils/settings.html
@@ -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>
@@ -154,8 +155,16 @@
154<h1><code class="xref py py-mod docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities<a class="headerlink" href="#settings-settings-utilities" title="Permalink to this headline">¶</a></h1> 155<h1><code class="xref py py-mod docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities<a class="headerlink" href="#settings-settings-utilities" title="Permalink to this headline">¶</a></h1>
155<dl class="function"> 156<dl class="function">
156<dt id="eventmq.utils.settings.import_settings"> 157<dt id="eventmq.utils.settings.import_settings">
157<code class="descclassname">eventmq.utils.settings.</code><code class="descname">import_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.settings.import_settings" title="Permalink to this definition">¶</a></dt> 158<code class="descclassname">eventmq.utils.settings.</code><code class="descname">import_settings</code><span class="sig-paren">(</span><em>section='global'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.settings.import_settings" title="Permalink to this definition">¶</a></dt>
158<dd><p>Import settings and apply to configuration globals</p> 159<dd><p>Import settings and apply to configuration globals</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"><strong>section</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the INI section to import</td>
165</tr>
166</tbody>
167</table>
159</dd></dl> 168</dd></dl>
160 169
161</div> 170</div>
@@ -179,7 +188,7 @@
179 188
180 <div role="contentinfo"> 189 <div role="contentinfo">
181 <p> 190 <p>
182 &copy; Copyright 2015, eventboard.io. 191 &copy; Copyright 2016, eventboard.io.
183 192
184 </p> 193 </p>
185 </div> 194 </div>
diff --git a/utils/timeutils.html b/utils/timeutils.html
index 087322b..0815b80 100644
--- a/utils/timeutils.html
+++ b/utils/timeutils.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="Contributing to EventMQ" href="../contributing.html"/> 35 <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/>
36 <link rel="prev" title="messages – Message Utilities" href="messages.html"/> 36 <link rel="prev" title="settings – Settings Utilities" href="settings.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"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><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 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li> 100<li class="toctree-l3 current"><a class="current reference internal" href=""><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">timeutils</span></code> &#8211; Time Utilites</li> 140 <li><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</li>
138 <li class="wy-breadcrumbs-aside"> 141 <li class="wy-breadcrumbs-aside">
@@ -224,7 +227,7 @@ time.time()</p>
224 <a href="../contributing.html" class="btn btn-neutral float-right" title="Contributing to EventMQ" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 227 <a href="../contributing.html" class="btn btn-neutral float-right" title="Contributing to EventMQ" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
225 228
226 229
227 <a href="messages.html" class="btn btn-neutral" title="messages – Message Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 230 <a href="settings.html" class="btn btn-neutral" title="settings – Settings Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
228 231
229 </div> 232 </div>
230 233
@@ -233,7 +236,7 @@ time.time()</p>
233 236
234 <div role="contentinfo"> 237 <div role="contentinfo">
235 <p> 238 <p>
236 &copy; Copyright 2015, eventboard.io. 239 &copy; Copyright 2016, eventboard.io.
237 240
238 </p> 241 </p>
239 </div> 242 </div>