aboutsummaryrefslogtreecommitdiffstats
path: root/router.html
diff options
context:
space:
mode:
Diffstat (limited to 'router.html')
-rw-r--r--router.html37
1 files changed, 35 insertions, 2 deletions
diff --git a/router.html b/router.html
index 86fe30d..ca90e13 100644
--- a/router.html
+++ b/router.html
@@ -61,7 +61,7 @@
61 61
62 62
63 <div class="version"> 63 <div class="version">
64 0.2.1 64 0.2.6.2
65 </div> 65 </div>
66 66
67 67
@@ -226,6 +226,30 @@ self.queues</li>
226</dd></dl> 226</dd></dl>
227 227
228<dl class="method"> 228<dl class="method">
229<dt id="eventmq.router.Router.get_status">
230<code class="descname">get_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.get_status" title="Permalink to this definition">¶</a></dt>
231<dd><dl class="docutils">
232<dt>Return</dt>
233<dd>(str) Serialized information about the current state of the router.</dd>
234</dl>
235</dd></dl>
236
237<dl class="attribute">
238<dt id="eventmq.router.Router.job_latencies">
239<code class="descname">job_latencies</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.router.Router.job_latencies" title="Permalink to this definition">¶</a></dt>
240<dd><p>Latency tracking dictionary
241Key: msgid of message each REQUEST received and forwarded to a worker
242Value: (timestamp, queue_name)</p>
243</dd></dl>
244
245<dl class="method">
246<dt id="eventmq.router.Router.on_disconnect">
247<code class="descname">on_disconnect</code><span class="sig-paren">(</span><em>msgid</em>, <em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_disconnect" title="Permalink to this definition">¶</a></dt>
248<dd><p>Prepare router for disconnecting by removing schedulers, clearing
249worker queue (if needed), and removing workers.</p>
250</dd></dl>
251
252<dl class="method">
229<dt id="eventmq.router.Router.on_heartbeat"> 253<dt id="eventmq.router.Router.on_heartbeat">
230<code class="descname">on_heartbeat</code><span class="sig-paren">(</span><em>sender</em>, <em>msgid</em>, <em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_heartbeat" title="Permalink to this definition">¶</a></dt> 254<code class="descname">on_heartbeat</code><span class="sig-paren">(</span><em>sender</em>, <em>msgid</em>, <em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_heartbeat" title="Permalink to this definition">¶</a></dt>
231<dd><p>a placeholder for a no-op command. The actual &#8216;logic&#8217; for HEARTBEAT is 255<dd><p>a placeholder for a no-op command. The actual &#8216;logic&#8217; for HEARTBEAT is
@@ -260,6 +284,13 @@ and announces itself.</p>
260</dd></dl> 284</dd></dl>
261 285
262<dl class="method"> 286<dl class="method">
287<dt id="eventmq.router.Router.on_reply">
288<code class="descname">on_reply</code><span class="sig-paren">(</span><em>sender</em>, <em>msgid</em>, <em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_reply" title="Permalink to this definition">¶</a></dt>
289<dd><p>Handles an REPLY message. Replies are sent by the worker for latanecy
290measurements</p>
291</dd></dl>
292
293<dl class="method">
263<dt id="eventmq.router.Router.on_request"> 294<dt id="eventmq.router.Router.on_request">
264<code class="descname">on_request</code><span class="sig-paren">(</span><em>sender</em>, <em>msgid</em>, <em>msg</em>, <em>depth=1</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_request" title="Permalink to this definition">¶</a></dt> 295<code class="descname">on_request</code><span class="sig-paren">(</span><em>sender</em>, <em>msgid</em>, <em>msg</em>, <em>depth=1</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_request" title="Permalink to this definition">¶</a></dt>
265<dd><p>Process a client REQUEST frame</p> 296<dd><p>Process a client REQUEST frame</p>
@@ -465,7 +496,7 @@ process receives a SIGHUP from the system.</p>
465 496
466<dl class="method"> 497<dl class="method">
467<dt id="eventmq.router.Router.start"> 498<dt id="eventmq.router.Router.start">
468<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> 499<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>, <em>administrative_addr='tcp://127.0.0.1:47293'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.start" title="Permalink to this definition">¶</a></dt>
469<dd><p>Begin listening for connections on the provided connection strings</p> 500<dd><p>Begin listening for connections on the provided connection strings</p>
470<table class="docutils field-list" frame="void" rules="none"> 501<table class="docutils field-list" frame="void" rules="none">
471<col class="field-name" /> 502<col class="field-name" />
@@ -474,6 +505,8 @@ process receives a SIGHUP from the system.</p>
474<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 505<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
475<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> 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>
476<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> 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>
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
509commands on.</li>
477</ul> 510</ul>
478</td> 511</td>
479</tr> 512</tr>