aboutsummaryrefslogtreecommitdiffstats
path: root/router.html
diff options
context:
space:
mode:
Diffstat (limited to 'router.html')
-rw-r--r--router.html72
1 files changed, 7 insertions, 65 deletions
diff --git a/router.html b/router.html
index 0604f89..5166889 100644
--- a/router.html
+++ b/router.html
@@ -149,20 +149,6 @@
149<em class="property">class </em><code class="descclassname">eventmq.router.</code><code class="descname">Router</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router" title="Permalink to this definition">¶</a></dt> 149<em class="property">class </em><code class="descclassname">eventmq.router.</code><code class="descname">Router</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router" title="Permalink to this definition">¶</a></dt>
150<dd><p>A simple router of messages</p> 150<dd><p>A simple router of messages</p>
151<dl class="method"> 151<dl class="method">
152<dt id="eventmq.router.Router.add_scheduler">
153<code class="descname">add_scheduler</code><span class="sig-paren">(</span><em>scheduler_id</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.add_scheduler" title="Permalink to this definition">¶</a></dt>
154<dd><p>Adds a scheduler to the queue to receive SCHEDULE commands</p>
155<table class="docutils field-list" frame="void" rules="none">
156<col class="field-name" />
157<col class="field-body" />
158<tbody valign="top">
159<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>
160</tr>
161</tbody>
162</table>
163</dd></dl>
164
165<dl class="method">
166<dt id="eventmq.router.Router.add_worker"> 152<dt id="eventmq.router.Router.add_worker">
167<code class="descname">add_worker</code><span class="sig-paren">(</span><em>worker_id</em>, <em>queues=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.add_worker" title="Permalink to this definition">¶</a></dt> 153<code class="descname">add_worker</code><span class="sig-paren">(</span><em>worker_id</em>, <em>queues=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.add_worker" title="Permalink to this definition">¶</a></dt>
168<dd><p>Adds a worker to worker queues</p> 154<dd><p>Adds a worker to worker queues</p>
@@ -171,7 +157,7 @@
171<col class="field-body" /> 157<col class="field-body" />
172<tbody valign="top"> 158<tbody valign="top">
173<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 159<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
174<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> 160<li><strong>worker_id</strong> &#8211; unique id of the worker to add</li>
175<li><strong>queues</strong> &#8211; queue or queues this worker should be a member of</li> 161<li><strong>queues</strong> &#8211; queue or queues this worker should be a member of</li>
176</ul> 162</ul>
177</td> 163</td>
@@ -181,13 +167,6 @@
181</dd></dl> 167</dd></dl>
182 168
183<dl class="method"> 169<dl class="method">
184<dt id="eventmq.router.Router.clean_up_dead_schedulers">
185<code class="descname">clean_up_dead_schedulers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.clean_up_dead_schedulers" title="Permalink to this definition">¶</a></dt>
186<dd><p>Loops through the list of schedulers and remove any schedulers who
187the router hasn&#8217;t received a heartbeat in HEARTBEAT_TIMEOUT</p>
188</dd></dl>
189
190<dl class="method">
191<dt id="eventmq.router.Router.clean_up_dead_workers"> 170<dt id="eventmq.router.Router.clean_up_dead_workers">
192<code class="descname">clean_up_dead_workers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.clean_up_dead_workers" title="Permalink to this definition">¶</a></dt> 171<code class="descname">clean_up_dead_workers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.clean_up_dead_workers" title="Permalink to this definition">¶</a></dt>
193<dd><p>Loops through the worker queues and removes any workers who haven&#8217;t 172<dd><p>Loops through the worker queues and removes any workers who haven&#8217;t
@@ -231,7 +210,10 @@ and announces itself.</p>
231<dl class="method"> 210<dl class="method">
232<dt id="eventmq.router.Router.on_receive_request"> 211<dt id="eventmq.router.Router.on_receive_request">
233<code class="descname">on_receive_request</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_receive_request" title="Permalink to this definition">¶</a></dt> 212<code class="descname">on_receive_request</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_receive_request" title="Permalink to this definition">¶</a></dt>
234<dd><table class="docutils field-list" frame="void" rules="none"> 213<dd><p>This function is called when a message comes in from the client socket.
214It then calls <cite>on_command</cite>. If <cite>on_command</cite> isn&#8217;t found, then a
215warning is created.</p>
216<table class="docutils field-list" frame="void" rules="none">
235<col class="field-name" /> 217<col class="field-name" />
236<col class="field-body" /> 218<col class="field-body" />
237<tbody valign="top"> 219<tbody valign="top">
@@ -274,12 +256,6 @@ worker slot, so you may see duplicate addresses.</p>
274<p>{&#8216;default&#8217;: [&#8216;w1&#8217;, &#8216;w2&#8217;, &#8216;w1&#8217;, &#8216;w4&#8217;]}</p> 256<p>{&#8216;default&#8217;: [&#8216;w1&#8217;, &#8216;w2&#8217;, &#8216;w1&#8217;, &#8216;w4&#8217;]}</p>
275</dd></dl> 257</dd></dl>
276 258
277<dl class="attribute">
278<dt id="eventmq.router.Router.received_disconnect">
279<code class="descname">received_disconnect</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.router.Router.received_disconnect" title="Permalink to this definition">¶</a></dt>
280<dd><p>Set to True when the router should die.</p>
281</dd></dl>
282
283<dl class="method"> 259<dl class="method">
284<dt id="eventmq.router.Router.requeue_worker"> 260<dt id="eventmq.router.Router.requeue_worker">
285<code class="descname">requeue_worker</code><span class="sig-paren">(</span><em>worker_id</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.requeue_worker" title="Permalink to this definition">¶</a></dt> 261<code class="descname">requeue_worker</code><span class="sig-paren">(</span><em>worker_id</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.requeue_worker" title="Permalink to this definition">¶</a></dt>
@@ -291,39 +267,11 @@ worker slot, so you may see duplicate addresses.</p>
291</dd></dl> 267</dd></dl>
292 268
293<dl class="method"> 269<dl class="method">
294<dt id="eventmq.router.Router.reset_heartbeat_counters">
295<code class="descname">reset_heartbeat_counters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.reset_heartbeat_counters" title="Permalink to this definition">¶</a></dt>
296<dd><p>Reset all the counters for heartbeats back to 0</p>
297</dd></dl>
298
299<dl class="method">
300<dt id="eventmq.router.Router.router_main"> 270<dt id="eventmq.router.Router.router_main">
301<code class="descname">router_main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.router_main" title="Permalink to this definition">¶</a></dt> 271<code class="descname">router_main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.router_main" title="Permalink to this definition">¶</a></dt>
302<dd><p>Kick off router with logging and settings import</p> 272<dd><p>Kick off router with logging and settings import</p>
303</dd></dl> 273</dd></dl>
304 274
305<dl class="attribute">
306<dt id="eventmq.router.Router.scheduler_queue">
307<code class="descname">scheduler_queue</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.router.Router.scheduler_queue" title="Permalink to this definition">¶</a></dt>
308<dd><p><em>Queue for schedulers to use</em></p>
309</dd></dl>
310
311<dl class="attribute">
312<dt id="eventmq.router.Router.schedulers">
313<code class="descname">schedulers</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.router.Router.schedulers" title="Permalink to this definition">¶</a></dt>
314<dd><p>Scheduler clients. Clients are able to send SCHEDULE commands that
315need to be routed to a scheduler, which will keep track of time and
316run the job.
317Contains dictionaries:</p>
318<blockquote>
319<div><dl class="docutils">
320<dt>self.schedulers[&lt;scheduler_zmq_id&gt;] = {</dt>
321<dd>&#8216;hb&#8217;: &lt;last_recv_heartbeat&gt;,</dd>
322</dl>
323<p>}</p>
324</div></blockquote>
325</dd></dl>
326
327<dl class="method"> 275<dl class="method">
328<dt id="eventmq.router.Router.send_ack"> 276<dt id="eventmq.router.Router.send_ack">
329<code class="descname">send_ack</code><span class="sig-paren">(</span><em>socket</em>, <em>recipient</em>, <em>msgid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.send_ack" title="Permalink to this definition">¶</a></dt> 277<code class="descname">send_ack</code><span class="sig-paren">(</span><em>socket</em>, <em>recipient</em>, <em>msgid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.send_ack" title="Permalink to this definition">¶</a></dt>
@@ -363,20 +311,14 @@ needed when building messages</p>
363</dd></dl> 311</dd></dl>
364 312
365<dl class="method"> 313<dl class="method">
366<dt id="eventmq.router.Router.send_schedulers_heartbeats">
367<code class="descname">send_schedulers_heartbeats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.send_schedulers_heartbeats" title="Permalink to this definition">¶</a></dt>
368<dd><p>Send HEARTBEATs to all registered schedulers</p>
369</dd></dl>
370
371<dl class="method">
372<dt id="eventmq.router.Router.send_workers_heartbeats"> 314<dt id="eventmq.router.Router.send_workers_heartbeats">
373<code class="descname">send_workers_heartbeats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.send_workers_heartbeats" title="Permalink to this definition">¶</a></dt> 315<code class="descname">send_workers_heartbeats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.send_workers_heartbeats" title="Permalink to this definition">¶</a></dt>
374<dd><p>Send HEARTBEATs to all registered workers.</p> 316<dd><p>Send heartbeats to all registered workers.</p>
375</dd></dl> 317</dd></dl>
376 318
377<dl class="method"> 319<dl class="method">
378<dt id="eventmq.router.Router.start"> 320<dt id="eventmq.router.Router.start">
379<code class="descname">start</code><span class="sig-paren">(</span><em>frontend_addr='tcp://127.0.0.1:47291'</em>, <em>backend_addr='tcp://127.0.0.1:47290'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.start" title="Permalink to this definition">¶</a></dt> 321<code class="descname">start</code><span class="sig-paren">(</span><em>frontend_addr='tcp://127.0.0.1:47290'</em>, <em>backend_addr='tcp://127.0.0.1:47291'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.start" title="Permalink to this definition">¶</a></dt>
380<dd><p>Begin listening for connections on the provided connection strings</p> 322<dd><p>Begin listening for connections on the provided connection strings</p>
381<table class="docutils field-list" frame="void" rules="none"> 323<table class="docutils field-list" frame="void" rules="none">
382<col class="field-name" /> 324<col class="field-name" />