diff options
Diffstat (limited to 'utils/classes.html')
| -rw-r--r-- | utils/classes.html | 54 |
1 files changed, 39 insertions, 15 deletions
diff --git a/utils/classes.html b/utils/classes.html index 7a43ac8..a18e66e 100644 --- a/utils/classes.html +++ b/utils/classes.html | |||
| @@ -31,9 +31,9 @@ | |||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 34 | <link rel="up" title="utils - Utilities" href="index.html"/> | 34 | <link rel="up" title="utils – Utilities" href="index.html"/> |
| 35 | <link rel="next" title="messages – Message Utilities" href="messages.html"/> | 35 | <link rel="next" title="devices – Device Utilities" href="devices.html"/> |
| 36 | <link rel="prev" title="utils - Utilities" href="index.html"/> | 36 | <link rel="prev" title="utils – Utilities" href="index.html"/> |
| 37 | 37 | ||
| 38 | 38 | ||
| 39 | <script src="../_static/js/modernizr.min.js"></script> | 39 | <script src="../_static/js/modernizr.min.js"></script> |
| @@ -61,7 +61,7 @@ | |||
| 61 | 61 | ||
| 62 | 62 | ||
| 63 | <div class="version"> | 63 | <div class="version"> |
| 64 | 0 | 64 | 0.2.1 |
| 65 | </div> | 65 | </div> |
| 66 | 66 | ||
| 67 | 67 | ||
| @@ -83,6 +83,7 @@ | |||
| 83 | 83 | ||
| 84 | 84 | ||
| 85 | <ul class="current"> | 85 | <ul class="current"> |
| 86 | <li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li> | ||
| 86 | <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> | 87 | <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> |
| 87 | <li class="toctree-l2"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> | 88 | <li class="toctree-l2"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> |
| 88 | <li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | 89 | <li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> |
| @@ -91,11 +92,12 @@ | |||
| 91 | <li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 92 | <li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 92 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 93 | <li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 93 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| 94 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> - Utilities</a><ul class="current"> | 95 | <li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> |
| 95 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 96 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> – 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> | ||
| 96 | <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> | 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> |
| 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> | ||
| 97 | <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> | 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> |
| 98 | <li class="toctree-l3"><a class="reference internal" href="index.html#id1"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a></li> | ||
| 99 | </ul> | 101 | </ul> |
| 100 | </li> | 102 | </li> |
| 101 | </ul> | 103 | </ul> |
| @@ -133,7 +135,7 @@ | |||
| 133 | 135 | ||
| 134 | <li><a href="../api.html">API Documentation</a> »</li> | 136 | <li><a href="../api.html">API Documentation</a> »</li> |
| 135 | 137 | ||
| 136 | <li><a href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> - Utilities</a> »</li> | 138 | <li><a href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a> »</li> |
| 137 | 139 | ||
| 138 | <li><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</li> | 140 | <li><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</li> |
| 139 | <li class="wy-breadcrumbs-aside"> | 141 | <li class="wy-breadcrumbs-aside"> |
| @@ -224,27 +226,45 @@ as the first arguments.</p> | |||
| 224 | 226 | ||
| 225 | <dl class="method"> | 227 | <dl class="method"> |
| 226 | <dt id="eventmq.utils.classes.EMQPService.send_inform"> | 228 | <dt id="eventmq.utils.classes.EMQPService.send_inform"> |
| 227 | <code class="descname">send_inform</code><span class="sig-paren">(</span><em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.send_inform" title="Permalink to this definition">¶</a></dt> | 229 | <code class="descname">send_inform</code><span class="sig-paren">(</span><em>queues=()</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.send_inform" title="Permalink to this definition">¶</a></dt> |
| 228 | <dd><p>Queues an INFORM command to <cite>self.outgoing</cite>.</p> | 230 | <dd><p>Notify the router that this job manager is online and and ready for |
| 231 | work. This includes a list of queues the router should forward messages | ||
| 232 | for.</p> | ||
| 229 | <table class="docutils field-list" frame="void" rules="none"> | 233 | <table class="docutils field-list" frame="void" rules="none"> |
| 230 | <col class="field-name" /> | 234 | <col class="field-name" /> |
| 231 | <col class="field-body" /> | 235 | <col class="field-body" /> |
| 232 | <tbody valign="top"> | 236 | <tbody valign="top"> |
| 233 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 237 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 234 | <li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Either ‘worker’ or ‘scheduler’</li> | 238 | <li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Either ‘worker’ or ‘scheduler’</li> |
| 235 | <li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – <ul> | 239 | <li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – <ul> |
| 236 | <li>For ‘worker’ type, the queues the worker is listening on</li> | 240 | <li>For ‘worker’ type, the queues the worker is listening on and |
| 241 | their weights.<dl class="docutils"> | ||
| 242 | <dt>Example:</dt> | ||
| 243 | <dd>([10, ‘default’], [15, ‘push_notifications’])</dd> | ||
| 244 | </dl> | ||
| 245 | </li> | ||
| 237 | <li>Ignored for ‘scheduler’ type</li> | 246 | <li>Ignored for ‘scheduler’ type</li> |
| 238 | </ul> | 247 | </ul> |
| 239 | </li> | 248 | </li> |
| 240 | </ul> | 249 | </ul> |
| 241 | </td> | 250 | </td> |
| 242 | </tr> | 251 | </tr> |
| 243 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> – When <cite>type_</cite> does not match a specified type</p> | 252 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> – When <cite>type_</cite> does not match a specified type</p> |
| 253 | </td> | ||
| 254 | </tr> | ||
| 255 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> | ||
| 256 | </td> | ||
| 257 | </tr> | ||
| 258 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p> | ||
| 244 | </td> | 259 | </td> |
| 245 | </tr> | 260 | </tr> |
| 246 | </tbody> | 261 | </tbody> |
| 247 | </table> | 262 | </table> |
| 263 | <div class="admonition note"> | ||
| 264 | <p class="first admonition-title">Note</p> | ||
| 265 | <p class="last">Passing a single string for queues is supported for backward | ||
| 266 | compatibility and not recommended for new apps.</p> | ||
| 267 | </div> | ||
| 248 | </dd></dl> | 268 | </dd></dl> |
| 249 | 269 | ||
| 250 | <dl class="method"> | 270 | <dl class="method"> |
| @@ -515,6 +535,10 @@ False</td> | |||
| 515 | <tbody valign="top"> | 535 | <tbody valign="top"> |
| 516 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) – The eMQP socket to send the message to</td> | 536 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) – The eMQP socket to send the message to</td> |
| 517 | </tr> | 537 | </tr> |
| 538 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> | ||
| 539 | </tr> | ||
| 540 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td> | ||
| 541 | </tr> | ||
| 518 | </tbody> | 542 | </tbody> |
| 519 | </table> | 543 | </table> |
| 520 | </dd></dl> | 544 | </dd></dl> |
| @@ -612,10 +636,10 @@ specify the the recipient id of the remote socket</li> | |||
| 612 | 636 | ||
| 613 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | 637 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| 614 | 638 | ||
| 615 | <a href="messages.html" class="btn btn-neutral float-right" title="messages – Message Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> | 639 | <a href="devices.html" class="btn btn-neutral float-right" title="devices – Device Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> |
| 616 | 640 | ||
| 617 | 641 | ||
| 618 | <a href="index.html" class="btn btn-neutral" title="utils - Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> | 642 | <a href="index.html" class="btn btn-neutral" title="utils – Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| 619 | 643 | ||
| 620 | </div> | 644 | </div> |
| 621 | 645 | ||
| @@ -624,7 +648,7 @@ specify the the recipient id of the remote socket</li> | |||
| 624 | 648 | ||
| 625 | <div role="contentinfo"> | 649 | <div role="contentinfo"> |
| 626 | <p> | 650 | <p> |
| 627 | © Copyright 2015, eventboard.io. | 651 | © Copyright 2016, eventboard.io. |
| 628 | 652 | ||
| 629 | </p> | 653 | </p> |
| 630 | </div> | 654 | </div> |