docs updates

1 files changed, 169 insertions, 106 deletions

diff --git a/protocol.html b/protocol.html
index 274f8d1..828731e 100644
--- a/protocol.html
+++ b/protocol.html
@@ -60,7 +60,7 @@
             
             
               <div class="version">
-                0.2.1
+                0.2.6.2
               </div>
             
           
@@ -97,9 +97,10 @@
 <li class="toctree-l4"><a class="reference internal" href="#emqp-scheduler">eMQP / Scheduler</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#emqp-worker">eMQP / Worker</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#heartbeating">Heartbeating</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#request-headers">REQUEST Headers</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#headers">Headers</a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="#disconnect-and-kbai">DISCONNECT and KBAI</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq">Source Code</a></li>
@@ -157,12 +158,12 @@
 <p><em>The status of this document is alpha and subject to heavy change</em></p>
 <div class="section" id="goals">
 <h2>Goals<a class="headerlink" href="#goals" title="Permalink to this headline">¶</a></h2>
-<p>The EventMQ Protocol (eMQP) defines a reliable service-oriented request-reply and pub-sub dialog between a set of clients, a broker, and a set of workers. This goal is to</p>
+<p>The EventMQ Protocol (eMQP) defines a reliable service-oriented request-reply and pub-sub dialog between a set of clients, a broker, and a set of workers.</p>
 <p>The goals are to:</p>
 <blockquote>
 <div><ul class="simple">
 <li>Specify a protocol to follow when implementing a component to EventMQ.</li>
-<li>Allow requests to be routed to workers by an abstracted service name.</li>
+<li>Allow requests to be routed to workers by an abstracted service name (named queues).</li>
 <li>Detect disconnected peers through heartbeating.</li>
 <li>Allow for message tracing and debugging.</li>
 </ul>
@@ -231,15 +232,12 @@
 </tr>
 </tbody>
 </table>
-</div>
-<div class="section" id="emqp-client">
-<h3>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h3>
-<p>A <strong>REQUEST</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
+<p>A <strong>REPLY</strong> frame consists of a 5-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="8%" />
-<col width="20%" />
-<col width="72%" />
+<col width="13%" />
+<col width="31%" />
+<col width="56%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -257,7 +255,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>REQUEST</td>
+<td>REPLY</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -265,25 +263,17 @@
 <td>A unique id for the msg</td>
 </tr>
 <tr class="row-even"><td>4</td>
-<td>_QUEUE_NAME_</td>
-<td>the name of the queue the request should be sent to</td>
-</tr>
-<tr class="row-odd"><td>5</td>
-<td>_HEADERS_</td>
-<td>dictionary of headers. can be an empty set</td>
-</tr>
-<tr class="row-even"><td>6</td>
 <td>_MSG_</td>
-<td>The message to send</td>
+<td>The reply to respond with</td>
 </tr>
 </tbody>
 </table>
-<p>A <strong>PUBLISH</strong> command consists of a 7-frame multipart messag, formatted as follows.</p>
+<p>A <strong>HEARTBEAT</strong> frame consists of a</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="7%" />
-<col width="17%" />
-<col width="75%" />
+<col width="14%" />
+<col width="33%" />
+<col width="53%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -301,7 +291,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>PUBLISH</td>
+<td>HEARTBEAT</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -309,25 +299,17 @@
 <td>A unique id for the msg</td>
 </tr>
 <tr class="row-even"><td>4</td>
-<td>_TOPIC_NAME_</td>
-<td>the name of the topic this message should be published across</td>
-</tr>
-<tr class="row-odd"><td>5</td>
-<td>_HEADERS_</td>
-<td>csv list of headers</td>
-</tr>
-<tr class="row-even"><td>6</td>
-<td>_MSG_</td>
-<td>The message to send</td>
+<td>_UNIX_TS_</td>
+<td>A unix timestamp</td>
 </tr>
 </tbody>
 </table>
-<p>A <strong>SCHEDULE</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
+<p>A <strong>DISCONNECT</strong> frame consists of</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="10%" />
-<col width="23%" />
-<col width="67%" />
+<col width="14%" />
+<col width="33%" />
+<col width="53%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -345,28 +327,51 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>SCHEDULE</td>
+<td>DISCONNECT</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
 <td>_MSGID_</td>
 <td>A unique id for the msg</td>
 </tr>
-<tr class="row-even"><td>4</td>
-<td>_QUEUE_NAME_</td>
-<td>name of queue that the job should run in</td>
+</tbody>
+</table>
+<p>A <strong>KBAI</strong> frame consists of</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="14%" />
+<col width="33%" />
+<col width="53%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">FRAME</th>
+<th class="head">Value</th>
+<th class="head">Description</th>
 </tr>
-<tr class="row-odd"><td>5</td>
-<td>_HEADERS_</td>
-<td>csv list of headers for this message</td>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>0</td>
+<td>_EMPTY_</td>
+<td>leave empty</td>
 </tr>
-<tr class="row-even"><td>6</td>
-<td>_MSG_</td>
-<td>The message to send</td>
+<tr class="row-odd"><td>1</td>
+<td>eMQP/1.0</td>
+<td>Protocol version</td>
+</tr>
+<tr class="row-even"><td>2</td>
+<td>KBAI</td>
+<td>command</td>
+</tr>
+<tr class="row-odd"><td>3</td>
+<td>_MSGID_</td>
+<td>A unique id for the msg</td>
 </tr>
 </tbody>
 </table>
-<p>An <strong>UNSCHEDULE</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
+</div>
+<div class="section" id="emqp-client">
+<h3>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h3>
+<p>A <strong>REQUEST</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
 <col width="8%" />
@@ -389,7 +394,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>UNSCHEDULE</td>
+<td>REQUEST</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -398,11 +403,11 @@
 </tr>
 <tr class="row-even"><td>4</td>
 <td>_QUEUE_NAME_</td>
-<td>ignored for this command, broadcasted to all queues</td>
+<td>the name of the queue the request should be sent to</td>
 </tr>
 <tr class="row-odd"><td>5</td>
 <td>_HEADERS_</td>
-<td>csv list of headers for this message</td>
+<td>dictionary of headers. can be an empty set</td>
 </tr>
 <tr class="row-even"><td>6</td>
 <td>_MSG_</td>
@@ -410,15 +415,12 @@
 </tr>
 </tbody>
 </table>
-</div>
-<div class="section" id="emqp-scheduler">
-<h3>eMQP / Scheduler<a class="headerlink" href="#emqp-scheduler" title="Permalink to this headline">¶</a></h3>
-<p>An <strong>INFORM</strong> command consists of a 6-frame multipart message, formatted as follows.</p>
+<p>A <strong>PUBLISH</strong> command consists of a 7-frame multipart messag, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="13%" />
-<col width="29%" />
-<col width="58%" />
+<col width="7%" />
+<col width="17%" />
+<col width="75%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -436,7 +438,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>INFORM</td>
+<td>PUBLISH</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -444,24 +446,25 @@
 <td>A unique id for the msg</td>
 </tr>
 <tr class="row-even"><td>4</td>
-<td>&nbsp;</td>
-<td>Queues. Unused for scheduler</td>
+<td>_TOPIC_NAME_</td>
+<td>the name of the topic this message should be published across</td>
 </tr>
 <tr class="row-odd"><td>5</td>
-<td>scheduler</td>
-<td>type of peer connecting</td>
+<td>_HEADERS_</td>
+<td>csv list of headers</td>
+</tr>
+<tr class="row-even"><td>6</td>
+<td>_MSG_</td>
+<td>The message to send</td>
 </tr>
 </tbody>
 </table>
-</div>
-<div class="section" id="emqp-worker">
-<h3>eMQP / Worker<a class="headerlink" href="#emqp-worker" title="Permalink to this headline">¶</a></h3>
-<p>An <strong>INFORM</strong> command consists of a 5-frame multipart message, formatted as follows.</p>
+<p>A <strong>SCHEDULE</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="5%" />
-<col width="13%" />
-<col width="82%" />
+<col width="10%" />
+<col width="23%" />
+<col width="67%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -479,7 +482,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>INFORM</td>
+<td>SCHEDULE</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -487,21 +490,25 @@
 <td>A unique id for the msg</td>
 </tr>
 <tr class="row-even"><td>4</td>
-<td>_QUEUES_</td>
-<td>csv seperated arrays containing an int and a string for weight and name. e.g. [40, &#8216;email&#8217;]</td>
+<td>_QUEUE_NAME_</td>
+<td>name of queue that the job should run in</td>
 </tr>
 <tr class="row-odd"><td>5</td>
-<td>worker</td>
-<td>type of peer connecting</td>
+<td>_HEADERS_</td>
+<td>csv list of headers for this message</td>
+</tr>
+<tr class="row-even"><td>6</td>
+<td>_MSG_</td>
+<td>The message to send</td>
 </tr>
 </tbody>
 </table>
-<p>A <strong>READY</strong> frame consists of a 4-frame multipart message, formatted as follows.</p>
+<p>An <strong>UNSCHEDULE</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="14%" />
-<col width="33%" />
-<col width="53%" />
+<col width="8%" />
+<col width="20%" />
+<col width="72%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -519,21 +526,36 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>READY</td>
+<td>UNSCHEDULE</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
 <td>_MSGID_</td>
 <td>A unique id for the msg</td>
 </tr>
+<tr class="row-even"><td>4</td>
+<td>_QUEUE_NAME_</td>
+<td>ignored for this command, broadcasted to all queues</td>
+</tr>
+<tr class="row-odd"><td>5</td>
+<td>_HEADERS_</td>
+<td>csv list of headers for this message</td>
+</tr>
+<tr class="row-even"><td>6</td>
+<td>_MSG_</td>
+<td>The message to send</td>
+</tr>
 </tbody>
 </table>
-<p>A <strong>REPLY</strong> frame consists of a 5-frame multipart message, formatted as follows.</p>
+</div>
+<div class="section" id="emqp-scheduler">
+<h3>eMQP / Scheduler<a class="headerlink" href="#emqp-scheduler" title="Permalink to this headline">¶</a></h3>
+<p>An <strong>INFORM</strong> command consists of a 6-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
 <col width="13%" />
-<col width="31%" />
-<col width="56%" />
+<col width="29%" />
+<col width="58%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -551,7 +573,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>REPLY</td>
+<td>INFORM</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -559,17 +581,24 @@
 <td>A unique id for the msg</td>
 </tr>
 <tr class="row-even"><td>4</td>
-<td>_MSG_</td>
-<td>The reply to respond with</td>
+<td>&nbsp;</td>
+<td>Queues. Unused for scheduler</td>
+</tr>
+<tr class="row-odd"><td>5</td>
+<td>scheduler</td>
+<td>type of peer connecting</td>
 </tr>
 </tbody>
 </table>
-<p>A <strong>HEARTBEAT</strong> frame consists of a</p>
+</div>
+<div class="section" id="emqp-worker">
+<h3>eMQP / Worker<a class="headerlink" href="#emqp-worker" title="Permalink to this headline">¶</a></h3>
+<p>An <strong>INFORM</strong> command consists of a 5-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="14%" />
-<col width="33%" />
-<col width="53%" />
+<col width="5%" />
+<col width="13%" />
+<col width="82%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">FRAME</th>
@@ -587,7 +616,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>HEARTBEAT</td>
+<td>INFORM</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -595,12 +624,16 @@
 <td>A unique id for the msg</td>
 </tr>
 <tr class="row-even"><td>4</td>
-<td>_UNIX_TS_</td>
-<td>A unix timestamp</td>
+<td>_QUEUES_</td>
+<td>csv seperated arrays containing an int and a string for weight and name. e.g. [40, &#8216;email&#8217;]</td>
+</tr>
+<tr class="row-odd"><td>5</td>
+<td>worker</td>
+<td>type of peer connecting</td>
 </tr>
 </tbody>
 </table>
-<p>A <strong>DISCONNECT</strong> frame consists of</p>
+<p>A <strong>READY</strong> frame consists of a 4-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
 <col width="14%" />
@@ -623,7 +656,7 @@
 <td>Protocol version</td>
 </tr>
 <tr class="row-even"><td>2</td>
-<td>DISCONNECT</td>
+<td>READY</td>
 <td>command</td>
 </tr>
 <tr class="row-odd"><td>3</td>
@@ -637,7 +670,7 @@
 <h3>Heartbeating<a class="headerlink" href="#heartbeating" title="Permalink to this headline">¶</a></h3>
 <blockquote>
 <div><ul class="simple">
-<li>HEARTBEAT commands are valid at any time after an INFORM command</li>
+<li>HEARTBEAT commands are valid at any time after an INFORM command.</li>
 <li>Any command except DISCONNECT act as a heartbeat. Peers SHOULD NOT send HEARTBEAT commands while sending other commands.</li>
 <li>Worker and broker MUST send heartbeats at regular and agreed-upon intervals.</li>
 <li>Scheduler and broker MUST send heartbeats at regular and agreed-upon intervals.</li>
@@ -647,22 +680,24 @@
 </ul>
 </div></blockquote>
 </div>
-<div class="section" id="request-headers">
-<h3>REQUEST Headers<a class="headerlink" href="#request-headers" title="Permalink to this headline">¶</a></h3>
-<p>Headers MUST be 0 to many comma seperated values inserted into the header field. If there are no headers required, send an empty string MUST be sent where headers are required.</p>
+<div class="section" id="headers">
+<h3>Headers<a class="headerlink" href="#headers" title="Permalink to this headline">¶</a></h3>
+<p>Headers MUST be 0 to many comma seperated values inserted into the header field. If there are no headers required, an empty string MUST be sent where headers are required.</p>
 <p>Below is a table which defines and describes the headers.</p>
 <table border="1" class="docutils">
 <colgroup>
-<col width="9%" />
-<col width="4%" />
-<col width="4%" />
+<col width="8%" />
+<col width="3%" />
+<col width="3%" />
 <col width="4%" />
-<col width="78%" />
+<col width="3%" />
+<col width="79%" />
 </colgroup>
 <thead valign="bottom">
 <tr class="row-odd"><th class="head">Header</th>
 <th class="head">REQUEST</th>
 <th class="head">PUBLISH</th>
+<th class="head">SCHEDULE</th>
 <th class="head">Default</th>
 <th class="head">Description</th>
 </tr>
@@ -671,25 +706,53 @@
 <tr class="row-even"><td>reply-requested</td>
 <td>X</td>
 <td>&nbsp;</td>
+<td>&nbsp;</td>
 <td>False</td>
 <td>Once the job is finished, send a reply back with information from the job. If there is no information reply with a True value.</td>
 </tr>
 <tr class="row-odd"><td>retry-count:#</td>
 <td>X</td>
 <td>&nbsp;</td>
+<td>&nbsp;</td>
 <td>0</td>
 <td>Retry a failed job this many times before accepting defeat.</td>
 </tr>
 <tr class="row-even"><td>guarantee</td>
 <td>X</td>
 <td>&nbsp;</td>
+<td>&nbsp;</td>
 <td>False</td>
 <td>Ensure the job completes by letting someone else worry about a success reply.</td>
 </tr>
+<tr class="row-odd"><td>nohaste</td>
+<td>&nbsp;</td>
+<td>&nbsp;</td>
+<td>X</td>
+<td>False</td>
+<td>When scheduling a job, set this to True if you don&#8217;t want the job to run immediately as it&#8217;s scheduled.  Instead, it will run for the first time when the interval has elapsed.</td>
+</tr>
 </tbody>
 </table>
 </div>
 </div>
+<div class="section" id="disconnect-and-kbai">
+<h2>DISCONNECT and KBAI<a class="headerlink" href="#disconnect-and-kbai" title="Permalink to this headline">¶</a></h2>
+<dl class="docutils">
+<dt>When a component receives a DISCONNECT command it:</dt>
+<dd><ul class="first last simple">
+<li>MUST send a KBAI command to all connected components.</li>
+<li>MUST stop sending and receiving any messages</li>
+<li>MUST allow any pending messages or jobs to complete.</li>
+</ul>
+</dd>
+<dt>When a component receives a KBAI command it:</dt>
+<dd><ul class="first last simple">
+<li>MUST stop sending any messages to the disconnecting component.</li>
+<li>SHOULD Clean up references to the disconnecting component.</li>
+</ul>
+</dd>
+</dl>
+</div>
 </div>