aboutsummaryrefslogtreecommitdiffstats
path: root/router.html
diff options
context:
space:
mode:
Diffstat (limited to 'router.html')
-rw-r--r--router.html37
1 files changed, 20 insertions, 17 deletions
diff --git a/router.html b/router.html
index ca90e13..1d2bb42 100644
--- a/router.html
+++ b/router.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="sender – Sender" href="sender.html"/> 38 <link rel="next" title="sender – Sender" href="sender.html"/>
@@ -61,7 +64,7 @@
61 64
62 65
63 <div class="version"> 66 <div class="version">
64 0.2.6.2 67 0.2.6.3
65 </div> 68 </div>
66 69
67 70
@@ -90,7 +93,7 @@
90<li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 93<li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
91<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 94<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
92<li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 95<li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
93<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 96<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">router</span></code> &#8211; 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> &#8211; 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> &#8211; Sender</a></li>
95<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li> 98<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
96</ul> 99</ul>
@@ -118,7 +121,7 @@
118 <div class="rst-content"> 121 <div class="rst-content">
119 122
120 123
121 124
122 125
123 126
124 127
@@ -157,7 +160,7 @@
157<col class="field-name" /> 160<col class="field-name" />
158<col class="field-body" /> 161<col class="field-body" />
159<tbody valign="top"> 162<tbody valign="top">
160<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>scheduler_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique id of the scheduler to add</td> 163<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>scheduler_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; unique id of the scheduler to add</td>
161</tr> 164</tr>
162</tbody> 165</tbody>
163</table> 166</table>
@@ -172,7 +175,7 @@
172<col class="field-body" /> 175<col class="field-body" />
173<tbody valign="top"> 176<tbody valign="top">
174<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 177<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
175<li><strong>worker_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique id of the worker to add</li> 178<li><strong>worker_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; unique id of the worker to add</li>
176<li><strong>queues</strong> &#8211; queue or queues this worker should be a member of</li> 179<li><strong>queues</strong> &#8211; queue or queues this worker should be a member of</li>
177</ul> 180</ul>
178</td> 181</td>
@@ -204,7 +207,7 @@ queue.</p>
204<col class="field-name" /> 207<col class="field-name" />
205<col class="field-body" /> 208<col class="field-body" />
206<tbody valign="top"> 209<tbody valign="top">
207<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>queue_name</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the queue</p> 210<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>queue_name</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 queue</p>
208</td> 211</td>
209</tr> 212</tr>
210<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple"> 213<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple">
@@ -273,8 +276,8 @@ and announces itself.</p>
273<col class="field-body" /> 276<col class="field-body" />
274<tbody valign="top"> 277<tbody valign="top">
275<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 278<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
276<li><strong>sender</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The id of the sender</li> 279<li><strong>sender</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 sender</li>
277<li><strong>msgid</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Unique identifier for this message</li> 280<li><strong>msgid</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; Unique identifier for this message</li>
278<li><strong>msg</strong> &#8211; The actual message that was sent</li> 281<li><strong>msg</strong> &#8211; The actual message that was sent</li>
279</ul> 282</ul>
280</td> 283</td>
@@ -302,7 +305,7 @@ measurements</p>
302<li><strong>sender</strong> &#8211; </li> 305<li><strong>sender</strong> &#8211; </li>
303<li><strong>msgid</strong> &#8211; </li> 306<li><strong>msgid</strong> &#8211; </li>
304<li><strong>msgid</strong> &#8211; </li> 307<li><strong>msgid</strong> &#8211; </li>
305<li><strong>depth</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; The recusion depth in retrying when PeerGoneAwayError 308<li><strong>depth</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; The recusion depth in retrying when PeerGoneAwayError
306is raised.</li> 309is raised.</li>
307</ul> 310</ul>
308</td> 311</td>
@@ -319,7 +322,7 @@ is raised.</li>
319<col class="field-name" /> 322<col class="field-name" />
320<col class="field-body" /> 323<col class="field-body" />
321<tbody valign="top"> 324<tbody valign="top">
322<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>unprioritized_iterable</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; Any list, tuple, etc where the 325<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>unprioritized_iterable</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; Any list, tuple, etc where the
3230-index key is an integer to use as priority. Largest numbers 3260-index key is an integer to use as priority. Largest numbers
324come first.</td> 327come first.</td>
325</tr> 328</tr>
@@ -434,8 +437,8 @@ Contains dictionaries:</p>
434<col class="field-body" /> 437<col class="field-body" />
435<tbody valign="top"> 438<tbody valign="top">
436<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 439<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
437<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket to use for this ack</li> 440<li><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 socket to use for this ack</li>
438<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The recipient id for the ack</li> 441<li><strong>recipient</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 recipient id for the ack</li>
439<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li> 442<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li>
440</ul> 443</ul>
441</td> 444</td>
@@ -460,8 +463,8 @@ needed when building messages</p>
460<col class="field-body" /> 463<col class="field-body" />
461<tbody valign="top"> 464<tbody valign="top">
462<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 465<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
463<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; the socket to send the heartbeat with</li> 466<li><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 socket to send the heartbeat with</li>
464<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Worker I</li> 467<li><strong>recipient</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; Worker I</li>
465</ul> 468</ul>
466</td> 469</td>
467</tr> 470</tr>
@@ -503,9 +506,9 @@ process receives a SIGHUP from the system.</p>
503<col class="field-body" /> 506<col class="field-body" />
504<tbody valign="top"> 507<tbody valign="top">
505<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 508<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
506<li><strong>frontend_addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for requests</li> 509<li><strong>frontend_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 listen for requests</li>
507<li><strong>backend_addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for workers</li> 510<li><strong>backend_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 listen for workers</li>
508<li><strong>administrative_addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to listen for emq-cli 511<li><strong>administrative_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 listen for emq-cli
509commands on.</li> 512commands on.</li>
510</ul> 513</ul>
511</td> 514</td>