1 files changed, 63 insertions, 12 deletions

diff --git a/router.html b/router.html
index a98b4c3..1cacb79 100644
--- a/router.html
+++ b/router.html
@@ -149,7 +149,7 @@
 <dd><p>A simple router of messages</p>
 <dl class="method">
 <dt id="eventmq.router.Router.add_worker">
-<code class="descname">add_worker</code><span class="sig-paren">(</span><em>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>
+<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>
 <dd><p>Adds a worker to worker queues</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -175,15 +175,35 @@ responded in HEARTBEAT_TIMEOUT</p>
 <dl class="method">
 <dt id="eventmq.router.Router.on_heartbeat">
 <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>
-<dd><p>a placeholder for a noop command. The actual &#8216;logic&#8217; for HEARTBEAT is
-in <code class="xref py py-meth docutils literal"><span class="pre">self.process_worker_message()</span></code> because any message from a worker
-counts as a HEARTBEAT</p>
+<dd><p>a placeholder for a no-op command. The actual &#8216;logic&#8217; for HEARTBEAT is
+in <code class="xref py py-meth docutils literal"><span class="pre">self.process_worker_message()</span></code> because any message from a
+worker counts as a HEARTBEAT</p>
 </dd></dl>
 
 <dl class="method">
 <dt id="eventmq.router.Router.on_inform">
 <code class="descname">on_inform</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_inform" title="Permalink to this definition">¶</a></dt>
-<dd><p>Handles an INFORM message. Usually when new worker coming online</p>
+<dd><p>Handles an INFORM message. This happens when new worker coming online
+and announces itself.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eventmq.router.Router.on_ready">
+<code class="descname">on_ready</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_ready" title="Permalink to this definition">¶</a></dt>
+<dd><p>A worker that we should already know about is ready for another job</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<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>
+<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>
+<li><strong>msg</strong> &#8211; The actual message that was sent</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
@@ -192,24 +212,55 @@ counts as a HEARTBEAT</p>
 <dd><p>This function is called when a message comes in from the client socket.
 It then calls <cite>on_command</cite>. If <cite>on_command</cite> isn&#8217;t found, then a
 warning is created.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> &#8211; The untouched message from zmq</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="eventmq.router.Router.process_worker_message">
 <code class="descname">process_worker_message</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.process_worker_message" title="Permalink to this definition">¶</a></dt>
 <dd><p>This method is called when a message comes in from the worker socket.
-It then calls <cite>on_command</cite>. If <cite>on_command</cite> isn&#8217;t found, then a warning
-is created.</p>
-<dl class="docutils">
-<dt>def on_inform(msg):</dt>
-<dd>pass</dd>
-</dl>
+It then calls <cite>on_COMMAND.lower()</cite>. If <cite>on_command</cite> isn&#8217;t found, then
+a warning is created.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> &#8211; The untouched message from zmq</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="eventmq.router.Router.requeue_worker">
+<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>
+<dd><p>Add a worker back to the queue pool</p>
 </dd></dl>
 
 <dl class="method">
 <dt id="eventmq.router.Router.send_ack">
 <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>
 <dd><p>Sends an ACK response</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<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>
+<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>
+<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
@@ -234,7 +285,7 @@ needed when building messages</p>
 <dl class="method">
 <dt id="eventmq.router.Router.send_workers_heartbeats">
 <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>
-<dd><p>Send heartbeats to the registered workers.</p>
+<dd><p>Send heartbeats to all registered workers.</p>
 </dd></dl>
 
 <dl class="method">