aboutsummaryrefslogtreecommitdiffstats
path: root/utils
diff options
context:
space:
mode:
authorjason2018-07-17 16:49:04 -0600
committerjason2018-07-17 16:49:04 -0600
commiteffda4b10d0fddb85ee6e7b418fd22e0f2dee5ad (patch)
tree77534c617bd0854e4b9c1303fc229322adff359f /utils
parent4dd9e72fd596d6795d43a423219f5000e58b9a61 (diff)
downloadeventmq-effda4b10d0fddb85ee6e7b418fd22e0f2dee5ad.tar.gz
eventmq-effda4b10d0fddb85ee6e7b418fd22e0f2dee5ad.zip
update docs to 0.3.8
Diffstat (limited to 'utils')
-rwxr-xr-xutils/classes.html111
-rwxr-xr-xutils/devices.html59
-rwxr-xr-xutils/index.html59
-rwxr-xr-xutils/messages.html69
-rwxr-xr-xutils/settings.html59
-rwxr-xr-xutils/timeutils.html62
6 files changed, 297 insertions, 122 deletions
diff --git a/utils/classes.html b/utils/classes.html
index ed0df59..7cb68fc 100755
--- a/utils/classes.html
+++ b/utils/classes.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">classes</span></code> &#8211; Utility Classes</li> 163 <li><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</li>
164
165
144 <li class="wy-breadcrumbs-aside"> 166 <li class="wy-breadcrumbs-aside">
145 167
146 168
147 <a href="../_sources/utils/classes.rst.txt" rel="nofollow"> View page source</a> 169 <a href="../_sources/utils/classes.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">
@@ -238,8 +263,8 @@ for.</p>
238<col class="field-body" /> 263<col class="field-body" />
239<tbody valign="top"> 264<tbody valign="top">
240<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 265<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
241<li><strong>type</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; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li> 266<li><strong>type</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; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li>
242<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; <ul> 267<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; <ul>
243<li>For &#8216;worker&#8217; type, the queues the worker is listening on and 268<li>For &#8216;worker&#8217; type, the queues the worker is listening on and
244their weights.<dl class="docutils"> 269their weights.<dl class="docutils">
245<dt>Example:</dt> 270<dt>Example:</dt>
@@ -252,13 +277,13 @@ their weights.<dl class="docutils">
252</ul> 277</ul>
253</td> 278</td>
254</tr> 279</tr>
255<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> 280<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.7)"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code></a> &#8211; When <cite>type_</cite> does not match a specified type</p>
256</td> 281</td>
257</tr> 282</tr>
258<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> 283<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
259</td> 284</td>
260</tr> 285</tr>
261<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/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 286<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/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
262</td> 287</td>
263</tr> 288</tr>
264</tbody> 289</tbody>
@@ -278,7 +303,7 @@ compatibility and not recommended for new apps.</p>
278<col class="field-name" /> 303<col class="field-name" />
279<col class="field-body" /> 304<col class="field-body" />
280<tbody valign="top"> 305<tbody valign="top">
281<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</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; connection string to connect to</td> 306<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</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; connection string to connect to</td>
282</tr> 307</tr>
283</tbody> 308</tbody>
284</table> 309</table>
@@ -305,12 +330,12 @@ checked to ensure proper error handling.</p>
305<col class="field-body" /> 330<col class="field-body" />
306<tbody valign="top"> 331<tbody valign="top">
307<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 332<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
308<li><strong>full</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Hard limit on deque size. Rejects adding elements. 333<li><strong>full</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; Hard limit on deque size. Rejects adding elements.
309Default: 0 - no limit</li> 334Default: 0 - no limit</li>
310<li><strong>pfull</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Programmable limit on deque size, defaults 335<li><strong>pfull</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; Programmable limit on deque size, defaults
311to <code class="docutils literal"><span class="pre">full</span></code> length</li> 336to <code class="docutils literal"><span class="pre">full</span></code> length</li>
312<li><strong>on_full</strong> (<em>func</em>) &#8211; callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li> 337<li><strong>on_full</strong> (<em>func</em>) &#8211; callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li>
313<li><strong>initial</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; The initial iteratable used to contruct the deque</li> 338<li><strong>initial</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#iter" title="(in Python v3.7)"><em>iter</em></a>) &#8211; The initial iteratable used to contruct the deque</li>
314</ul> 339</ul>
315</td> 340</td>
316</tr> 341</tr>
@@ -344,7 +369,7 @@ called.</dd>
344</dl> 369</dl>
345</td> 370</td>
346</tr> 371</tr>
347<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#bool" title="(in Python v2.7)">bool</a></td> 372<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/functions.html#bool" title="(in Python v3.7)">bool</a></td>
348</tr> 373</tr>
349</tbody> 374</tbody>
350</table> 375</table>
@@ -370,7 +395,7 @@ called.</dd>
370</dl> 395</dl>
371</td> 396</td>
372</tr> 397</tr>
373<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#bool" title="(in Python v2.7)">bool</a></td> 398<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/functions.html#bool" title="(in Python v3.7)">bool</a></td>
374</tr> 399</tr>
375</tbody> 400</tbody>
376</table> 401</table>
@@ -391,7 +416,7 @@ called.</dd>
391</dl> 416</dl>
392</td> 417</td>
393</tr> 418</tr>
394<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#bool" title="(in Python v2.7)">bool</a></td> 419<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/functions.html#bool" title="(in Python v3.7)">bool</a></td>
395</tr> 420</tr>
396</tbody> 421</tbody>
397</table> 422</table>
@@ -407,7 +432,7 @@ called.</dd>
407<tbody valign="top"> 432<tbody valign="top">
408<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains 0 items. False otherwise</td> 433<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains 0 items. False otherwise</td>
409</tr> 434</tr>
410<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#bool" title="(in Python v2.7)">bool</a></td> 435<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/functions.html#bool" title="(in Python v3.7)">bool</a></td>
411</tr> 436</tr>
412</tbody> 437</tbody>
413</table> 438</table>
@@ -424,7 +449,7 @@ called.</dd>
424<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">full</span></code> items. False 449<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">full</span></code> items. False
425otherwise</td> 450otherwise</td>
426</tr> 451</tr>
427<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#bool" title="(in Python v2.7)">bool</a></td> 452<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/functions.html#bool" title="(in Python v3.7)">bool</a></td>
428</tr> 453</tr>
429</tbody> 454</tbody>
430</table> 455</table>
@@ -441,7 +466,7 @@ otherwise</td>
441<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">pfull</span></code> items. 466<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">pfull</span></code> items.
442False otherwise</td> 467False otherwise</td>
443</tr> 468</tr>
444<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#bool" title="(in Python v2.7)">bool</a></td> 469<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/functions.html#bool" title="(in Python v3.7)">bool</a></td>
445</tr> 470</tr>
446</tbody> 471</tbody>
447</table> 472</table>
@@ -456,7 +481,7 @@ False otherwise</td>
456<tbody valign="top"> 481<tbody valign="top">
457<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td> 482<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td>
458</tr> 483</tr>
459<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#object" title="(in Python v2.7)">object</a></td> 484<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/functions.html#object" title="(in Python v3.7)">object</a></td>
460</tr> 485</tr>
461</tbody> 486</tbody>
462</table> 487</table>
@@ -471,7 +496,7 @@ False otherwise</td>
471<tbody valign="top"> 496<tbody valign="top">
472<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td> 497<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td>
473</tr> 498</tr>
474<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#object" title="(in Python v2.7)">object</a></td> 499<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/functions.html#object" title="(in Python v3.7)">object</a></td>
475</tr> 500</tr>
476</tbody> 501</tbody>
477</table> 502</table>
@@ -486,7 +511,7 @@ False otherwise</td>
486<tbody valign="top"> 511<tbody valign="top">
487<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td> 512<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td>
488</tr> 513</tr>
489<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#object" title="(in Python v2.7)">object</a></td> 514<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/functions.html#object" title="(in Python v3.7)">object</a></td>
490</tr> 515</tr>
491</tbody> 516</tbody>
492</table> 517</table>
@@ -501,7 +526,7 @@ False otherwise</td>
501<tbody valign="top"> 526<tbody valign="top">
502<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td> 527<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td>
503</tr> 528</tr>
504<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#object" title="(in Python v2.7)">object</a></td> 529<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/functions.html#object" title="(in Python v3.7)">object</a></td>
505</tr> 530</tr>
506</tbody> 531</tbody>
507</table> 532</table>
@@ -515,7 +540,7 @@ False otherwise</td>
515<col class="field-name" /> 540<col class="field-name" />
516<col class="field-body" /> 541<col class="field-body" />
517<tbody valign="top"> 542<tbody valign="top">
518<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; The item to remove from the deque</td> 543<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><em>object</em></a>) &#8211; The item to remove from the deque</td>
519</tr> 544</tr>
520</tbody> 545</tbody>
521</table> 546</table>
@@ -548,7 +573,7 @@ met.</p>
548<col class="field-name" /> 573<col class="field-name" />
549<col class="field-body" /> 574<col class="field-body" />
550<tbody valign="top"> 575<tbody valign="top">
551<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) &#8211; The time to use to check if death has occurred. If 576<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) &#8211; The time to use to check if death has occurred. If
552this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> 577this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code>
553is used.</td> 578is used.</td>
554</tr> 579</tr>
@@ -558,7 +583,7 @@ is used.</td>
558</dl> 583</dl>
559</td> 584</td>
560</tr> 585</tr>
561<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/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 586<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/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></td>
562</tr> 587</tr>
563</tbody> 588</tbody>
564</table> 589</table>
@@ -578,11 +603,11 @@ is used.</td>
578<col class="field-name" /> 603<col class="field-name" />
579<col class="field-body" /> 604<col class="field-body" />
580<tbody valign="top"> 605<tbody valign="top">
581<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/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td> 606<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/3/library/socket.html#module-socket" title="(in Python v3.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td>
582</tr> 607</tr>
583<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> 608<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td>
584</tr> 609</tr>
585<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/2/library/functions.html#str" title="(in Python v2.7)">str</a></td> 610<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/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
586</tr> 611</tr>
587</tbody> 612</tbody>
588</table> 613</table>
@@ -636,7 +661,7 @@ on it&#8217;s own</p>
636<tbody valign="top"> 661<tbody valign="top">
637<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 662<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
638<li><strong>message</strong> &#8211; message to send to something</li> 663<li><strong>message</strong> &#8211; message to send to something</li>
639<li><strong>protocol_version</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; protocol version. it&#8217;s good practice, but 664<li><strong>protocol_version</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; protocol version. it&#8217;s good practice, but
640you may explicitly specify None to skip adding the version</li> 665you may explicitly specify None to skip adding the version</li>
641</ul> 666</ul>
642</td> 667</td>
@@ -658,10 +683,10 @@ like this</p>
658<col class="field-body" /> 683<col class="field-body" />
659<tbody valign="top"> 684<tbody valign="top">
660<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 685<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
661<li><strong>message</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; Raw message to send.</li> 686<li><strong>message</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; Raw message to send.</li>
662<li><strong>protocol_version</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; protocol version. it&#8217;s good practice but 687<li><strong>protocol_version</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; protocol version. it&#8217;s good practice but
663you may explicitly specify None to skip adding the version</li> 688you may explicitly specify None to skip adding the version</li>
664<li><strong>_recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must 689<li><strong>_recipient_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><em>object</em></a>) &#8211; When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must
665specify the the recipient id of the remote socket</li> 690specify the the recipient id of the remote socket</li>
666</ul> 691</ul>
667</td> 692</td>
@@ -676,15 +701,18 @@ specify the the recipient id of the remote socket</li>
676 701
677 702
678 </div> 703 </div>
704 <div class="articleComments">
705
706 </div>
679 </div> 707 </div>
680 <footer> 708 <footer>
681 709
682 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 710 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
683 711
684 <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> 712 <a href="devices.html" class="btn btn-neutral float-right" title="devices – Device Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
685 713
686 714
687 <a href="index.html" class="btn btn-neutral" title="utils – Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 715 <a href="index.html" class="btn btn-neutral" title="utils – Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
688 716
689 </div> 717 </div>
690 718
@@ -718,7 +746,8 @@ specify the the recipient id of the remote socket</li>
718 VERSION:'0', 746 VERSION:'0',
719 COLLAPSE_INDEX:false, 747 COLLAPSE_INDEX:false,
720 FILE_SUFFIX:'.html', 748 FILE_SUFFIX:'.html',
721 HAS_SOURCE: true 749 HAS_SOURCE: true,
750 SOURCELINK_SUFFIX: '.txt'
722 }; 751 };
723 </script> 752 </script>
724 <script type="text/javascript" src="../_static/jquery.js"></script> 753 <script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/utils/devices.html b/utils/devices.html
index b3ce872..32fb642 100755
--- a/utils/devices.html
+++ b/utils/devices.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">devices</span></code> &#8211; Device Utilities</li> 163 <li><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device 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/devices.rst.txt" rel="nofollow"> View page source</a> 169 <a href="../_sources/utils/devices.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">
@@ -165,7 +190,7 @@ causes errors when setting the IDENTITY of the ZMQ socket.</p>
165<col class="field-name" /> 190<col class="field-name" />
166<col class="field-body" /> 191<col class="field-body" />
167<tbody valign="top"> 192<tbody valign="top">
168<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; Prefix the id with this string.</td> 193<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; Prefix the id with this string.</td>
169</tr> 194</tr>
170</tbody> 195</tbody>
171</table> 196</table>
@@ -179,15 +204,18 @@ causes errors when setting the IDENTITY of the ZMQ socket.</p>
179 204
180 205
181 </div> 206 </div>
207 <div class="articleComments">
208
209 </div>
182 </div> 210 </div>
183 <footer> 211 <footer>
184 212
185 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 213 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
186 214
187 <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> 215 <a href="messages.html" class="btn btn-neutral float-right" title="messages – Message Utilities" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
188 216
189 217
190 <a href="classes.html" class="btn btn-neutral" title="classes – Utility Classes" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 218 <a href="classes.html" class="btn btn-neutral" title="classes – Utility Classes" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
191 219
192 </div> 220 </div>
193 221
@@ -221,7 +249,8 @@ causes errors when setting the IDENTITY of the ZMQ socket.</p>
221 VERSION:'0', 249 VERSION:'0',
222 COLLAPSE_INDEX:false, 250 COLLAPSE_INDEX:false,
223 FILE_SUFFIX:'.html', 251 FILE_SUFFIX:'.html',
224 HAS_SOURCE: true 252 HAS_SOURCE: true,
253 SOURCELINK_SUFFIX: '.txt'
225 }; 254 };
226 </script> 255 </script>
227 <script type="text/javascript" src="../_static/jquery.js"></script> 256 <script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/utils/index.html b/utils/index.html
index b4380bc..088cb3a 100755
--- a/utils/index.html
+++ b/utils/index.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,25 +136,42 @@
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><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</li> 161 <li><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</li>
162
163
142 <li class="wy-breadcrumbs-aside"> 164 <li class="wy-breadcrumbs-aside">
143 165
144 166
145 <a href="../_sources/utils/index.rst.txt" rel="nofollow"> View page source</a> 167 <a href="../_sources/utils/index.rst.txt" rel="nofollow"> View page source</a>
146 168
147 169
148 </li> 170 </li>
171
149 </ul> 172 </ul>
173
174
150 <hr/> 175 <hr/>
151</div> 176</div>
152 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 177 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
@@ -174,7 +199,7 @@ like creating message more simple.</p>
174<tbody valign="top"> 199<tbody valign="top">
175<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td> 200<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td>
176</tr> 201</tr>
177<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> 202<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>
178</tr> 203</tr>
179</tbody> 204</tbody>
180</table> 205</table>
@@ -188,7 +213,7 @@ like creating message more simple.</p>
188<col class="field-name" /> 213<col class="field-name" />
189<col class="field-body" /> 214<col class="field-body" />
190<tbody valign="top"> 215<tbody valign="top">
191<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/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; any value of interest</td> 216<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/3/library/functions.html#object" title="(in Python v3.7)"><em>object</em></a>) &#8211; any value of interest</td>
192</tr> 217</tr>
193</tbody> 218</tbody>
194</table> 219</table>
@@ -198,15 +223,18 @@ like creating message more simple.</p>
198 223
199 224
200 </div> 225 </div>
226 <div class="articleComments">
227
228 </div>
201 </div> 229 </div>
202 <footer> 230 <footer>
203 231
204 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 232 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
205 233
206 <a href="classes.html" class="btn btn-neutral float-right" title="classes – Utility Classes" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 234 <a href="classes.html" class="btn btn-neutral float-right" title="classes – Utility Classes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
207 235
208 236
209 <a href="../sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 237 <a href="../sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
210 238
211 </div> 239 </div>
212 240
@@ -240,7 +268,8 @@ like creating message more simple.</p>
240 VERSION:'0', 268 VERSION:'0',
241 COLLAPSE_INDEX:false, 269 COLLAPSE_INDEX:false,
242 FILE_SUFFIX:'.html', 270 FILE_SUFFIX:'.html',
243 HAS_SOURCE: true 271 HAS_SOURCE: true,
272 SOURCELINK_SUFFIX: '.txt'
244 }; 273 };
245 </script> 274 </script>
246 <script type="text/javascript" src="../_static/jquery.js"></script> 275 <script type="text/javascript" src="../_static/jquery.js"></script>
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>
diff --git a/utils/settings.html b/utils/settings.html
index 9460546..73c0ed1 100755
--- a/utils/settings.html
+++ b/utils/settings.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">settings</span></code> &#8211; Settings Utilities</li> 163 <li><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings 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/settings.rst.txt" rel="nofollow"> View page source</a> 169 <a href="../_sources/utils/settings.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">
@@ -164,7 +189,7 @@
164<col class="field-name" /> 189<col class="field-name" />
165<col class="field-body" /> 190<col class="field-body" />
166<tbody valign="top"> 191<tbody valign="top">
167<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/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the INI section to import</td> 192<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/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Name of the INI section to import</td>
168</tr> 193</tr>
169</tbody> 194</tbody>
170</table> 195</table>
@@ -174,15 +199,18 @@
174 199
175 200
176 </div> 201 </div>
202 <div class="articleComments">
203
204 </div>
177 </div> 205 </div>
178 <footer> 206 <footer>
179 207
180 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 208 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
181 209
182 <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> 210 <a href="timeutils.html" class="btn btn-neutral float-right" title="timeutils – Time Utilites" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
183 211
184 212
185 <a href="messages.html" class="btn btn-neutral" title="messages – Message Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 213 <a href="messages.html" class="btn btn-neutral" title="messages – Message Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
186 214
187 </div> 215 </div>
188 216
@@ -216,7 +244,8 @@
216 VERSION:'0', 244 VERSION:'0',
217 COLLAPSE_INDEX:false, 245 COLLAPSE_INDEX:false,
218 FILE_SUFFIX:'.html', 246 FILE_SUFFIX:'.html',
219 HAS_SOURCE: true 247 HAS_SOURCE: true,
248 SOURCELINK_SUFFIX: '.txt'
220 }; 249 };
221 </script> 250 </script>
222 <script type="text/javascript" src="../_static/jquery.js"></script> 251 <script type="text/javascript" src="../_static/jquery.js"></script>
diff --git a/utils/timeutils.html b/utils/timeutils.html
index 7010c4a..e253d05 100755
--- a/utils/timeutils.html
+++ b/utils/timeutils.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">timeutils</span></code> &#8211; Time Utilites</li> 163 <li><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</li>
164
165
144 <li class="wy-breadcrumbs-aside"> 166 <li class="wy-breadcrumbs-aside">
145 167
146 168
147 <a href="../_sources/utils/timeutils.rst.txt" rel="nofollow"> View page source</a> 169 <a href="../_sources/utils/timeutils.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">
@@ -181,8 +206,9 @@ next(interval) # 600</p>
181<col class="field-body" /> 206<col class="field-body" />
182<tbody valign="top"> 207<tbody valign="top">
183<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 208<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
184<li><strong>start_value</strong> (<em>numeric</em>) &#8211; via <a class="reference internal" href="#eventmq.utils.timeutils.monotonic" title="eventmq.utils.timeutils.monotonic"><code class="xref py py-func docutils literal"><span class="pre">monotonic()</span></code></a> or <a class="reference internal" href="#eventmq.utils.timeutils.timestamp" title="eventmq.utils.timeutils.timestamp"><code class="xref py py-func docutils literal"><span class="pre">timestamp()</span></code></a></li> 209<li><strong>start_value</strong> (<em>numeric</em>) &#8211; the timestamp to begin with. usually gotten
185<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; </li> 210via <a class="reference internal" href="#eventmq.utils.timeutils.monotonic" title="eventmq.utils.timeutils.monotonic"><code class="xref py py-func docutils literal"><span class="pre">monotonic()</span></code></a> or <a class="reference internal" href="#eventmq.utils.timeutils.timestamp" title="eventmq.utils.timeutils.timestamp"><code class="xref py py-func docutils literal"><span class="pre">timestamp()</span></code></a></li>
211<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; the number of seconds between intervals</li>
186</ul> 212</ul>
187</td> 213</td>
188</tr> 214</tr>
@@ -222,15 +248,18 @@ time.time()</p>
222 248
223 249
224 </div> 250 </div>
251 <div class="articleComments">
252
253 </div>
225 </div> 254 </div>
226 <footer> 255 <footer>
227 256
228 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 257 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
229 258
230 <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> 259 <a href="../contributing.html" class="btn btn-neutral float-right" title="Contributing to EventMQ" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
231 260
232 261
233 <a href="settings.html" class="btn btn-neutral" title="settings – Settings Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 262 <a href="settings.html" class="btn btn-neutral" title="settings – Settings Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
234 263
235 </div> 264 </div>
236 265
@@ -264,7 +293,8 @@ time.time()</p>
264 VERSION:'0', 293 VERSION:'0',
265 COLLAPSE_INDEX:false, 294 COLLAPSE_INDEX:false,
266 FILE_SUFFIX:'.html', 295 FILE_SUFFIX:'.html',
267 HAS_SOURCE: true 296 HAS_SOURCE: true,
297 SOURCELINK_SUFFIX: '.txt'
268 }; 298 };
269 </script> 299 </script>
270 <script type="text/javascript" src="../_static/jquery.js"></script> 300 <script type="text/javascript" src="../_static/jquery.js"></script>
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 22:59:32 +0000