diff options
Diffstat (limited to 'utils')
| -rwxr-xr-x[-rw-r--r--] | utils/classes.html | 100 | ||||
| -rwxr-xr-x[-rw-r--r--] | utils/devices.html | 13 | ||||
| -rwxr-xr-x[-rw-r--r--] | utils/index.html | 22 | ||||
| -rwxr-xr-x[-rw-r--r--] | utils/messages.html | 35 | ||||
| -rwxr-xr-x[-rw-r--r--] | utils/settings.html | 13 | ||||
| -rwxr-xr-x[-rw-r--r--] | utils/timeutils.html | 15 |
6 files changed, 109 insertions, 89 deletions
diff --git a/utils/classes.html b/utils/classes.html index 830f787..531f2ae 100644..100755 --- a/utils/classes.html +++ b/utils/classes.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="../genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="../search.html"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="devices – Device Utilities" href="devices.html"/> | 38 | <link rel="next" title="devices – Device Utilities" href="devices.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.7.1 | 67 | 0.3-rc8 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -93,7 +96,7 @@ | |||
| 93 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 95 | <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"> | 98 | <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"> |
| 96 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">classes</span></code> – 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> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message Utilities</a></li> | 101 | <li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – 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> – Settings Utilities</a></li> | 102 | <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -141,7 +144,7 @@ | |||
| 141 | <li class="wy-breadcrumbs-aside"> | 144 | <li class="wy-breadcrumbs-aside"> |
| 142 | 145 | ||
| 143 | 146 | ||
| 144 | <a href="../_sources/utils/classes.txt" rel="nofollow"> View page source</a> | 147 | <a href="../_sources/utils/classes.rst.txt" rel="nofollow"> View page source</a> |
| 145 | 148 | ||
| 146 | 149 | ||
| 147 | </li> | 150 | </li> |
| @@ -235,8 +238,8 @@ for.</p> | |||
| 235 | <col class="field-body" /> | 238 | <col class="field-body" /> |
| 236 | <tbody valign="top"> | 239 | <tbody valign="top"> |
| 237 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 240 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 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>) – Either ‘worker’ or ‘scheduler’</li> | 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>) – Either ‘worker’ or ‘scheduler’</li> |
| 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>) – <ul> | 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>) – <ul> |
| 240 | <li>For ‘worker’ type, the queues the worker is listening on and | 243 | <li>For ‘worker’ type, the queues the worker is listening on and |
| 241 | their weights.<dl class="docutils"> | 244 | their weights.<dl class="docutils"> |
| 242 | <dt>Example:</dt> | 245 | <dt>Example:</dt> |
| @@ -249,14 +252,13 @@ their weights.<dl class="docutils"> | |||
| 249 | </ul> | 252 | </ul> |
| 250 | </td> | 253 | </td> |
| 251 | </tr> | 254 | </tr> |
| 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> – | 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> – When <cite>type_</cite> does not match a specified type</p> |
| 253 | When <cite>type_</cite> does not match a specified type</p> | ||
| 254 | </td> | 256 | </td> |
| 255 | </tr> | 257 | </tr> |
| 256 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> | 258 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> |
| 257 | </td> | 259 | </td> |
| 258 | </tr> | 260 | </tr> |
| 259 | <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> | 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> |
| 260 | </td> | 262 | </td> |
| 261 | </tr> | 263 | </tr> |
| 262 | </tbody> | 264 | </tbody> |
| @@ -276,7 +278,7 @@ compatibility and not recommended for new apps.</p> | |||
| 276 | <col class="field-name" /> | 278 | <col class="field-name" /> |
| 277 | <col class="field-body" /> | 279 | <col class="field-body" /> |
| 278 | <tbody valign="top"> | 280 | <tbody valign="top"> |
| 279 | <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/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – connection string to connect to</td> | 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>) – connection string to connect to</td> |
| 280 | </tr> | 282 | </tr> |
| 281 | </tbody> | 283 | </tbody> |
| 282 | </table> | 284 | </table> |
| @@ -303,12 +305,12 @@ checked to ensure proper error handling.</p> | |||
| 303 | <col class="field-body" /> | 305 | <col class="field-body" /> |
| 304 | <tbody valign="top"> | 306 | <tbody valign="top"> |
| 305 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 307 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 306 | <li><strong>full</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – Hard limit on deque size. Rejects adding elements. | 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>) – Hard limit on deque size. Rejects adding elements. |
| 307 | Default: 0 - no limit</li> | 309 | Default: 0 - no limit</li> |
| 308 | <li><strong>pfull</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – Programmable limit on deque size, defaults | 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>) – Programmable limit on deque size, defaults |
| 309 | to <code class="docutils literal"><span class="pre">full</span></code> length</li> | 311 | to <code class="docutils literal"><span class="pre">full</span></code> length</li> |
| 310 | <li><strong>on_full</strong> (<em>func</em>) – callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li> | 312 | <li><strong>on_full</strong> (<em>func</em>) – callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li> |
| 311 | <li><strong>initial</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) – The initial iteratable used to contruct the deque</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>) – The initial iteratable used to contruct the deque</li> |
| 312 | </ul> | 314 | </ul> |
| 313 | </td> | 315 | </td> |
| 314 | </tr> | 316 | </tr> |
| @@ -335,11 +337,14 @@ where False is returned.</p> | |||
| 335 | <col class="field-name" /> | 337 | <col class="field-name" /> |
| 336 | <col class="field-body" /> | 338 | <col class="field-body" /> |
| 337 | <tbody valign="top"> | 339 | <tbody valign="top"> |
| 338 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque | 340 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 339 | is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is | 341 | <dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> |
| 340 | called.</td> | 342 | <dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is |
| 343 | called.</dd> | ||
| 344 | </dl> | ||
| 345 | </td> | ||
| 341 | </tr> | 346 | </tr> |
| 342 | <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#bool" title="(in Python v2.7)">bool</a></td> | 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> |
| 343 | </tr> | 348 | </tr> |
| 344 | </tbody> | 349 | </tbody> |
| 345 | </table> | 350 | </table> |
| @@ -358,11 +363,14 @@ where False is returned.</p> | |||
| 358 | <col class="field-name" /> | 363 | <col class="field-name" /> |
| 359 | <col class="field-body" /> | 364 | <col class="field-body" /> |
| 360 | <tbody valign="top"> | 365 | <tbody valign="top"> |
| 361 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque | 366 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 362 | is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is | 367 | <dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> |
| 363 | called.</td> | 368 | <dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is |
| 369 | called.</dd> | ||
| 370 | </dl> | ||
| 371 | </td> | ||
| 364 | </tr> | 372 | </tr> |
| 365 | <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#bool" title="(in Python v2.7)">bool</a></td> | 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> |
| 366 | </tr> | 374 | </tr> |
| 367 | </tbody> | 375 | </tbody> |
| 368 | </table> | 376 | </table> |
| @@ -376,11 +384,14 @@ called.</td> | |||
| 376 | <col class="field-name" /> | 384 | <col class="field-name" /> |
| 377 | <col class="field-body" /> | 385 | <col class="field-body" /> |
| 378 | <tbody valign="top"> | 386 | <tbody valign="top"> |
| 379 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque | 387 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 380 | is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is | 388 | <dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> |
| 381 | called.</td> | 389 | <dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is |
| 390 | called.</dd> | ||
| 391 | </dl> | ||
| 392 | </td> | ||
| 382 | </tr> | 393 | </tr> |
| 383 | <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#bool" title="(in Python v2.7)">bool</a></td> | 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> |
| 384 | </tr> | 395 | </tr> |
| 385 | </tbody> | 396 | </tbody> |
| 386 | </table> | 397 | </table> |
| @@ -396,7 +407,7 @@ called.</td> | |||
| 396 | <tbody valign="top"> | 407 | <tbody valign="top"> |
| 397 | <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> | 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> |
| 398 | </tr> | 409 | </tr> |
| 399 | <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#bool" title="(in Python v2.7)">bool</a></td> | 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> |
| 400 | </tr> | 411 | </tr> |
| 401 | </tbody> | 412 | </tbody> |
| 402 | </table> | 413 | </table> |
| @@ -413,7 +424,7 @@ called.</td> | |||
| 413 | <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 | 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 |
| 414 | otherwise</td> | 425 | otherwise</td> |
| 415 | </tr> | 426 | </tr> |
| 416 | <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#bool" title="(in Python v2.7)">bool</a></td> | 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> |
| 417 | </tr> | 428 | </tr> |
| 418 | </tbody> | 429 | </tbody> |
| 419 | </table> | 430 | </table> |
| @@ -430,7 +441,7 @@ otherwise</td> | |||
| 430 | <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. | 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. |
| 431 | False otherwise</td> | 442 | False otherwise</td> |
| 432 | </tr> | 443 | </tr> |
| 433 | <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#bool" title="(in Python v2.7)">bool</a></td> | 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> |
| 434 | </tr> | 445 | </tr> |
| 435 | </tbody> | 446 | </tbody> |
| 436 | </table> | 447 | </table> |
| @@ -445,7 +456,7 @@ False otherwise</td> | |||
| 445 | <tbody valign="top"> | 456 | <tbody valign="top"> |
| 446 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td> | 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> |
| 447 | </tr> | 458 | </tr> |
| 448 | <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#object" title="(in Python v2.7)">object</a></td> | 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> |
| 449 | </tr> | 460 | </tr> |
| 450 | </tbody> | 461 | </tbody> |
| 451 | </table> | 462 | </table> |
| @@ -460,7 +471,7 @@ False otherwise</td> | |||
| 460 | <tbody valign="top"> | 471 | <tbody valign="top"> |
| 461 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td> | 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> |
| 462 | </tr> | 473 | </tr> |
| 463 | <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#object" title="(in Python v2.7)">object</a></td> | 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> |
| 464 | </tr> | 475 | </tr> |
| 465 | </tbody> | 476 | </tbody> |
| 466 | </table> | 477 | </table> |
| @@ -475,7 +486,7 @@ False otherwise</td> | |||
| 475 | <tbody valign="top"> | 486 | <tbody valign="top"> |
| 476 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td> | 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> |
| 477 | </tr> | 488 | </tr> |
| 478 | <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#object" title="(in Python v2.7)">object</a></td> | 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> |
| 479 | </tr> | 490 | </tr> |
| 480 | </tbody> | 491 | </tbody> |
| 481 | </table> | 492 | </table> |
| @@ -490,7 +501,7 @@ False otherwise</td> | |||
| 490 | <tbody valign="top"> | 501 | <tbody valign="top"> |
| 491 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td> | 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> |
| 492 | </tr> | 503 | </tr> |
| 493 | <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#object" title="(in Python v2.7)">object</a></td> | 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> |
| 494 | </tr> | 505 | </tr> |
| 495 | </tbody> | 506 | </tbody> |
| 496 | </table> | 507 | </table> |
| @@ -504,7 +515,7 @@ False otherwise</td> | |||
| 504 | <col class="field-name" /> | 515 | <col class="field-name" /> |
| 505 | <col class="field-body" /> | 516 | <col class="field-body" /> |
| 506 | <tbody valign="top"> | 517 | <tbody valign="top"> |
| 507 | <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/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) – The item to remove from the deque</td> | 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>) – The item to remove from the deque</td> |
| 508 | </tr> | 519 | </tr> |
| 509 | </tbody> | 520 | </tbody> |
| 510 | </table> | 521 | </table> |
| @@ -537,14 +548,17 @@ met.</p> | |||
| 537 | <col class="field-name" /> | 548 | <col class="field-name" /> |
| 538 | <col class="field-body" /> | 549 | <col class="field-body" /> |
| 539 | <tbody valign="top"> | 550 | <tbody valign="top"> |
| 540 | <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/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) – The time to use to check if death has occurred. If | 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>) – The time to use to check if death has occurred. If |
| 541 | this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> | 552 | this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> |
| 542 | is used.</td> | 553 | is used.</td> |
| 543 | </tr> | 554 | </tr> |
| 544 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the connection to the peer has died, otherwise | 555 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 545 | False</td> | 556 | <dt>True if the connection to the peer has died, otherwise</dt> |
| 557 | <dd>False</dd> | ||
| 558 | </dl> | ||
| 559 | </td> | ||
| 546 | </tr> | 560 | </tr> |
| 547 | <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#bool" title="(in Python v2.7)">bool</a></td> | 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> |
| 548 | </tr> | 562 | </tr> |
| 549 | </tbody> | 563 | </tbody> |
| 550 | </table> | 564 | </table> |
| @@ -564,11 +578,11 @@ False</td> | |||
| 564 | <col class="field-name" /> | 578 | <col class="field-name" /> |
| 565 | <col class="field-body" /> | 579 | <col class="field-body" /> |
| 566 | <tbody valign="top"> | 580 | <tbody valign="top"> |
| 567 | <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>) – The eMQP socket to send the message to</td> | 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>) – The eMQP socket to send the message to</td> |
| 568 | </tr> | 582 | </tr> |
| 569 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> | 583 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> |
| 570 | </tr> | 584 | </tr> |
| 571 | <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> | 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> |
| 572 | </tr> | 586 | </tr> |
| 573 | </tbody> | 587 | </tbody> |
| 574 | </table> | 588 | </table> |
| @@ -622,7 +636,7 @@ on it’s own</p> | |||
| 622 | <tbody valign="top"> | 636 | <tbody valign="top"> |
| 623 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 637 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 624 | <li><strong>message</strong> – message to send to something</li> | 638 | <li><strong>message</strong> – message to send to something</li> |
| 625 | <li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – protocol version. it’s good practice, but | 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>) – protocol version. it’s good practice, but |
| 626 | you may explicitly specify None to skip adding the version</li> | 640 | you may explicitly specify None to skip adding the version</li> |
| 627 | </ul> | 641 | </ul> |
| 628 | </td> | 642 | </td> |
| @@ -644,10 +658,10 @@ like this</p> | |||
| 644 | <col class="field-body" /> | 658 | <col class="field-body" /> |
| 645 | <tbody valign="top"> | 659 | <tbody valign="top"> |
| 646 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 660 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 647 | <li><strong>message</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) – Raw message to send.</li> | 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>) – Raw message to send.</li> |
| 648 | <li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – protocol version. it’s good practice but | 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>) – protocol version. it’s good practice but |
| 649 | you may explicitly specify None to skip adding the version</li> | 663 | you may explicitly specify None to skip adding the version</li> |
| 650 | <li><strong>_recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) – When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must | 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>) – When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must |
| 651 | specify the the recipient id of the remote socket</li> | 665 | specify the the recipient id of the remote socket</li> |
| 652 | </ul> | 666 | </ul> |
| 653 | </td> | 667 | </td> |
diff --git a/utils/devices.html b/utils/devices.html index c377682..fbdd974 100644..100755 --- a/utils/devices.html +++ b/utils/devices.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="../genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="../search.html"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="messages – Message Utilities" href="messages.html"/> | 38 | <link rel="next" title="messages – Message Utilities" href="messages.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.7.1 | 67 | 0.3-rc8 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -94,7 +97,7 @@ | |||
| 94 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 95 | <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"> | 98 | <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"> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 97 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message Utilities</a></li> | 101 | <li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – 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> – Settings Utilities</a></li> | 102 | <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -141,7 +144,7 @@ | |||
| 141 | <li class="wy-breadcrumbs-aside"> | 144 | <li class="wy-breadcrumbs-aside"> |
| 142 | 145 | ||
| 143 | 146 | ||
| 144 | <a href="../_sources/utils/devices.txt" rel="nofollow"> View page source</a> | 147 | <a href="../_sources/utils/devices.rst.txt" rel="nofollow"> View page source</a> |
| 145 | 148 | ||
| 146 | 149 | ||
| 147 | </li> | 150 | </li> |
| @@ -162,7 +165,7 @@ causes errors when setting the IDENTITY of the ZMQ socket.</p> | |||
| 162 | <col class="field-name" /> | 165 | <col class="field-name" /> |
| 163 | <col class="field-body" /> | 166 | <col class="field-body" /> |
| 164 | <tbody valign="top"> | 167 | <tbody valign="top"> |
| 165 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Prefix the id with this string.</td> | 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>) – Prefix the id with this string.</td> |
| 166 | </tr> | 169 | </tr> |
| 167 | </tbody> | 170 | </tbody> |
| 168 | </table> | 171 | </table> |
diff --git a/utils/index.html b/utils/index.html index 8214412..501bb09 100644..100755 --- a/utils/index.html +++ b/utils/index.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="../genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="../search.html"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="../api.html"/> | 37 | <link rel="up" title="API Documentation" href="../api.html"/> |
| 35 | <link rel="next" title="classes – Utility Classes" href="classes.html"/> | 38 | <link rel="next" title="classes – Utility Classes" href="classes.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.7.1 | 67 | 0.3-rc8 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -92,7 +95,7 @@ | |||
| 92 | <li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 93 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 96 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 94 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 97 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 95 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul> | 98 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – 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> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message Utilities</a></li> | 101 | <li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -139,7 +142,7 @@ | |||
| 139 | <li class="wy-breadcrumbs-aside"> | 142 | <li class="wy-breadcrumbs-aside"> |
| 140 | 143 | ||
| 141 | 144 | ||
| 142 | <a href="../_sources/utils/index.txt" rel="nofollow"> View page source</a> | 145 | <a href="../_sources/utils/index.rst.txt" rel="nofollow"> View page source</a> |
| 143 | 146 | ||
| 144 | 147 | ||
| 145 | </li> | 148 | </li> |
| @@ -171,7 +174,7 @@ like creating message more simple.</p> | |||
| 171 | <tbody valign="top"> | 174 | <tbody valign="top"> |
| 172 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td> | 175 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">some random characters of a specified length</td> |
| 173 | </tr> | 176 | </tr> |
| 174 | <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> | 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> |
| 175 | </tr> | 178 | </tr> |
| 176 | </tbody> | 179 | </tbody> |
| 177 | </table> | 180 | </table> |
| @@ -185,19 +188,12 @@ like creating message more simple.</p> | |||
| 185 | <col class="field-name" /> | 188 | <col class="field-name" /> |
| 186 | <col class="field-body" /> | 189 | <col class="field-body" /> |
| 187 | <tbody valign="top"> | 190 | <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>) – any value of interest</td> | 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>) – any value of interest</td> |
| 189 | </tr> | 192 | </tr> |
| 190 | </tbody> | 193 | </tbody> |
| 191 | </table> | 194 | </table> |
| 192 | </dd></dl> | 195 | </dd></dl> |
| 193 | 196 | ||
| 194 | <dl class="function"> | ||
| 195 | <dt id="eventmq.utils.zero_index_cmp"> | ||
| 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> | ||
| 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 | ||
| 198 | when sorting the values in <code class="xref py py-attr docutils literal"><span class="pre">router.Router.queues</span></code>.</p> | ||
| 199 | </dd></dl> | ||
| 200 | |||
| 201 | </div> | 197 | </div> |
| 202 | 198 | ||
| 203 | 199 | ||
diff --git a/utils/messages.html b/utils/messages.html index 65731a1..e703dbe 100644..100755 --- a/utils/messages.html +++ b/utils/messages.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="../genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="../search.html"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="settings – Settings Utilities" href="settings.html"/> | 38 | <link rel="next" title="settings – Settings Utilities" href="settings.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.7.1 | 67 | 0.3-rc8 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -95,7 +98,7 @@ | |||
| 95 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> | 98 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – 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> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> |
| 98 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> | 101 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">messages</span></code> – 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> – Settings Utilities</a></li> | 102 | <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 101 | </ul> | 104 | </ul> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -141,7 +144,7 @@ | |||
| 141 | <li class="wy-breadcrumbs-aside"> | 144 | <li class="wy-breadcrumbs-aside"> |
| 142 | 145 | ||
| 143 | 146 | ||
| 144 | <a href="../_sources/utils/messages.txt" rel="nofollow"> View page source</a> | 147 | <a href="../_sources/utils/messages.rst.txt" rel="nofollow"> View page source</a> |
| 145 | 148 | ||
| 146 | 149 | ||
| 147 | </li> | 150 | </li> |
| @@ -163,8 +166,8 @@ | |||
| 163 | <tbody valign="top"> | 166 | <tbody valign="top"> |
| 164 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 167 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 165 | <li><strong>socket</strong> – socket to send the message with</li> | 168 | <li><strong>socket</strong> – 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>) – the id of the connected device to reply to</li> | 169 | <li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – 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>) – The message to send. The first frame should be an | 170 | <li><strong>payload</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) – The message to send. The first frame should be an |
| 168 | empty string</li> | 171 | empty string</li> |
| 169 | </ul> | 172 | </ul> |
| 170 | </td> | 173 | </td> |
| @@ -182,7 +185,7 @@ be prefixed with <cite>prefix</cite>.</p> | |||
| 182 | <col class="field-name" /> | 185 | <col class="field-name" /> |
| 183 | <col class="field-body" /> | 186 | <col class="field-body" /> |
| 184 | <tbody valign="top"> | 187 | <tbody valign="top"> |
| 185 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Value to prefix on to the random part of the id. Useful | 188 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Value to prefix on to the random part of the id. Useful |
| 186 | for prefixing some meta data to use for things</td> | 189 | for prefixing some meta data to use for things</td> |
| 187 | </tr> | 190 | </tr> |
| 188 | </tbody> | 191 | </tbody> |
| @@ -245,7 +248,7 @@ parts.</p> | |||
| 245 | <tbody valign="top"> | 248 | <tbody valign="top"> |
| 246 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> | 249 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Message id for this message</td> |
| 247 | </tr> | 250 | </tr> |
| 248 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td> | 251 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td> |
| 249 | </tr> | 252 | </tr> |
| 250 | </tbody> | 253 | </tbody> |
| 251 | </table> | 254 | </table> |
| @@ -260,22 +263,20 @@ used by a <code class="xref py py-attr docutils literal"><span class="pre">zmq.R | |||
| 260 | <col class="field-name" /> | 263 | <col class="field-name" /> |
| 261 | <col class="field-body" /> | 264 | <col class="field-body" /> |
| 262 | <tbody valign="top"> | 265 | <tbody valign="top"> |
| 263 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 266 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 264 | <li><strong>socket</strong> – socket to send the message with</li> | 267 | <li><strong>socket</strong> – socket to send the message with</li> |
| 265 | <li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the id of the connected device to reply to</li> | 268 | <li><strong>recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the id of the connected device to reply to</li> |
| 266 | <li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the eMQP command to send</li> | 269 | <li><strong>command</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – the eMQP command to send</li> |
| 267 | <li><strong>message</strong> – a msg tuple to send</li> | 270 | <li><strong>message</strong> – a msg tuple to send</li> |
| 268 | </ul> | 271 | </ul> |
| 269 | </td> | 272 | </td> |
| 270 | </tr> | 273 | </tr> |
| 271 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Message id for this message</p> | ||
| 272 | </td> | ||
| 273 | </tr> | ||
| 274 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p> | ||
| 275 | </td> | ||
| 276 | </tr> | ||
| 277 | </tbody> | 274 | </tbody> |
| 278 | </table> | 275 | </table> |
| 276 | <dl class="docutils"> | ||
| 277 | <dt>Returns</dt> | ||
| 278 | <dd>str: Message id for this message</dd> | ||
| 279 | </dl> | ||
| 279 | </dd></dl> | 280 | </dd></dl> |
| 280 | 281 | ||
| 281 | </div> | 282 | </div> |
diff --git a/utils/settings.html b/utils/settings.html index fe62e9d..0341fa8 100644..100755 --- a/utils/settings.html +++ b/utils/settings.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="../genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="../search.html"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="timeutils – Time Utilites" href="timeutils.html"/> | 38 | <link rel="next" title="timeutils – Time Utilites" href="timeutils.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.7.1 | 67 | 0.3-rc8 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -96,7 +99,7 @@ | |||
| 96 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 99 | <li class="toctree-l3"><a class="reference internal" href="classes.html"><code class="docutils literal"><span class="pre">classes</span></code> – 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> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message Utilities</a></li> | 101 | <li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> |
| 99 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> | 102 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 101 | </ul> | 104 | </ul> |
| 102 | </li> | 105 | </li> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -141,7 +144,7 @@ | |||
| 141 | <li class="wy-breadcrumbs-aside"> | 144 | <li class="wy-breadcrumbs-aside"> |
| 142 | 145 | ||
| 143 | 146 | ||
| 144 | <a href="../_sources/utils/settings.txt" rel="nofollow"> View page source</a> | 147 | <a href="../_sources/utils/settings.rst.txt" rel="nofollow"> View page source</a> |
| 145 | 148 | ||
| 146 | 149 | ||
| 147 | </li> | 150 | </li> |
| @@ -161,7 +164,7 @@ | |||
| 161 | <col class="field-name" /> | 164 | <col class="field-name" /> |
| 162 | <col class="field-body" /> | 165 | <col class="field-body" /> |
| 163 | <tbody valign="top"> | 166 | <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>) – Name of the INI section to import</td> | 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>) – Name of the INI section to import</td> |
| 165 | </tr> | 168 | </tr> |
| 166 | </tbody> | 169 | </tbody> |
| 167 | </table> | 170 | </table> |
diff --git a/utils/timeutils.html b/utils/timeutils.html index 6cebb34..357f8ec 100644..100755 --- a/utils/timeutils.html +++ b/utils/timeutils.html | |||
| @@ -30,6 +30,9 @@ | |||
| 30 | 30 | ||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="index" title="Index" | ||
| 34 | href="../genindex.html"/> | ||
| 35 | <link rel="search" title="Search" href="../search.html"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils – Utilities" href="index.html"/> | 37 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/> | 38 | <link rel="next" title="Contributing to EventMQ" href="../contributing.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.7.1 | 67 | 0.3-rc8 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -97,7 +100,7 @@ | |||
| 97 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device Utilities</a></li> | 100 | <li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> – Device 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> – Message Utilities</a></li> | 101 | <li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – 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> – Settings Utilities</a></li> | 102 | <li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> – Settings Utilities</a></li> |
| 100 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> | 103 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 101 | </ul> | 104 | </ul> |
| 102 | </li> | 105 | </li> |
| 103 | </ul> | 106 | </ul> |
| @@ -125,7 +128,7 @@ | |||
| 125 | <div class="rst-content"> | 128 | <div class="rst-content"> |
| 126 | 129 | ||
| 127 | 130 | ||
| 128 | 131 | ||
| 129 | 132 | ||
| 130 | 133 | ||
| 131 | 134 | ||
| @@ -141,7 +144,7 @@ | |||
| 141 | <li class="wy-breadcrumbs-aside"> | 144 | <li class="wy-breadcrumbs-aside"> |
| 142 | 145 | ||
| 143 | 146 | ||
| 144 | <a href="../_sources/utils/timeutils.txt" rel="nofollow"> View page source</a> | 147 | <a href="../_sources/utils/timeutils.rst.txt" rel="nofollow"> View page source</a> |
| 145 | 148 | ||
| 146 | 149 | ||
| 147 | </li> | 150 | </li> |
| @@ -178,8 +181,8 @@ next(interval) # 600</p> | |||
| 178 | <col class="field-body" /> | 181 | <col class="field-body" /> |
| 179 | <tbody valign="top"> | 182 | <tbody valign="top"> |
| 180 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 183 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 181 | <li><strong>(numeric) - the timestamp to begin with. usually gotten</strong> (<em>start_value</em>) – 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> | 184 | <li><strong>start_value</strong> (<em>numeric</em>) – 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> |
| 182 | <li><strong>(int) - the number of seconds between intervals</strong> (<em>interval_secs</em>) – </li> | 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>) – </li> |
| 183 | </ul> | 186 | </ul> |
| 184 | </td> | 187 | </td> |
| 185 | </tr> | 188 | </tr> |