updates for docs

1 files changed, 170 insertions, 34 deletions

diff --git a/protocol.html b/protocol.html
index 1aff716..221bae0 100644
--- a/protocol.html
+++ b/protocol.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>EventMQ Protocol Specification &mdash; EventMQ 0 documentation</title>
+  <title>Goals &mdash; EventMQ 0 documentation</title>
   
 
   
@@ -84,20 +84,18 @@
                 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="">EventMQ Protocol Specification</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#goals">Goals</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#license">License</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#language">Language</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#architecture">Architecture</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#topology">Topology</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#router-addressing">ROUTER Addressing</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#global-frames">Global Frames</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#emqp-client">eMQP / Client</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>
-</ul>
-</li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Goals</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#language">Language</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#architecture">Architecture</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#topology">Topology</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#router-addressing">ROUTER Addressing</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#global-frames">Global Frames</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#emqp-client">eMQP / Client</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#emqp-scheduler">eMQP / Scheduler</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#emqp-worker">eMQP / Worker</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#heartbeating">Heartbeating</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#request-headers">REQUEST Headers</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference external" href="https://github.com/enderlabs/eventmq">Source Code</a></li>
@@ -136,7 +134,7 @@
       
           <li><a href="contributing.html">Contributing to EventMQ</a> &raquo;</li>
       
-    <li>EventMQ Protocol Specification</li>
+    <li>Goals</li>
       <li class="wy-breadcrumbs-aside">
         
           
@@ -150,11 +148,12 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
             
-  <div class="section" id="eventmq-protocol-specification">
-<h1>EventMQ Protocol Specification<a class="headerlink" href="#eventmq-protocol-specification" title="Permalink to this headline">¶</a></h1>
-<p><em>The status of this document is alpha and subject to heavy change</em></p>
+  <p>/<strong>**************************e
+EventMQ Protocol Specification
+****************************</strong>
+<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>
+<h1>Goals<a class="headerlink" href="#goals" title="Permalink to this headline">¶</a></h1>
 <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 goals are to:</p>
 <blockquote>
@@ -167,32 +166,32 @@
 </div></blockquote>
 </div>
 <div class="section" id="license">
-<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
+<h1>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h1>
 <p>This Specification is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
 <p>This Specification is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.</p>
 </div>
 <div class="section" id="language">
-<h2>Language<a class="headerlink" href="#language" title="Permalink to this headline">¶</a></h2>
+<h1>Language<a class="headerlink" href="#language" title="Permalink to this headline">¶</a></h1>
 <p>The key words &#8220;MUST&#8221;, &#8220;MUST NOT&#8221;, &#8220;REQUIRED&#8221;, &#8220;SHALL&#8221;, &#8220;SHALL NOT&#8221;, &#8220;SHOULD&#8221;, &#8220;SHOULD NOT&#8221;, &#8220;RECOMMENDED&#8221;, &#8220;MAY&#8221;, and &#8220;OPTIONAL&#8221; in this document are to be interpreted as described in RFC 2119[[1](<a class="reference external" href="http://tools.ietf.org/html/rfc2119">http://tools.ietf.org/html/rfc2119</a>)].</p>
 </div>
 <div class="section" id="architecture">
-<h2>Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h2>
+<h1>Architecture<a class="headerlink" href="#architecture" title="Permalink to this headline">¶</a></h1>
 <p>insert pretty picture here</p>
 <div class="section" id="topology">
-<h3>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">¶</a></h3>
+<h2>Topology<a class="headerlink" href="#topology" title="Permalink to this headline">¶</a></h2>
 <p>eMQP connects a set of client applications (e.g. web servers), a broker, and a pool of workers. Clients connect to the broker as well as the workers.</p>
 <p>&#8216;Clients&#8217; is defined as application issuing requests and &#8216;workers&#8217; as applications that process these requests. (Workers consist of a <cite>JobManager</cite> and a pool of <cite>Worker</cite> resources where the job executes.)</p>
 <p>The EventMQ broker handles a set of named queues. The broker SHOULD serve clients on a fair request and MAY deliver requests to workers on any basis, including 0MQ&#8217;s built-in round robin or least-recently used.</p>
 </div>
 <div class="section" id="router-addressing">
-<h3>ROUTER Addressing<a class="headerlink" href="#router-addressing" title="Permalink to this headline">¶</a></h3>
+<h2>ROUTER Addressing<a class="headerlink" href="#router-addressing" title="Permalink to this headline">¶</a></h2>
 <p>In the case of request-reply, the broker MUST use a ROUTER socket to accept requests from both clients and workers. The broker MAY use a seperate socket implementing a subset of eMQP, or MAY use a single socket implementing all of eMQP.</p>
 <p>From the 0MQ manual[[2](<a class="reference external" href="http://api.zeromq.org/master:zmq-socket">http://api.zeromq.org/master:zmq-socket</a>)]
 &gt; When receiving messages a ROUTER socket shall prepend a message part containing the identity of the originating peer to the message before passing it to the application. When sending messages a ROUTER socket shall remove the first part of the message and use it to determine the identity of the peer the message shall be routed to.</p>
 <p>This extra frame is not shown in the specifications below.</p>
 </div>
 <div class="section" id="global-frames">
-<h3>Global Frames<a class="headerlink" href="#global-frames" title="Permalink to this headline">¶</a></h3>
+<h2>Global Frames<a class="headerlink" href="#global-frames" title="Permalink to this headline">¶</a></h2>
 <p>An <strong>ACK</strong> command consists of a 4-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -231,7 +230,7 @@
 </table>
 </div>
 <div class="section" id="emqp-client">
-<h3>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h3>
+<h2>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h2>
 <p>A <strong>REQUEST</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -312,7 +311,7 @@
 </tr>
 <tr class="row-odd"><td>5</td>
 <td>_HEADERS_</td>
-<td>dictionary of headers. can be an empty set</td>
+<td>csv list of headers</td>
 </tr>
 <tr class="row-even"><td>6</td>
 <td>_MSG_</td>
@@ -320,9 +319,140 @@
 </tr>
 </tbody>
 </table>
+<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="10%" />
+<col width="23%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">FRAME</th>
+<th class="head">Value</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>0</td>
+<td>_EMPTY_</td>
+<td>leave empty</td>
+</tr>
+<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>SCHEDULE</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>_TOPIC_NAME_</td>
+<td>name of queue that the job should run in</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>An <strong>UNSCHEDULE</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="8%" />
+<col width="20%" />
+<col width="72%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">FRAME</th>
+<th class="head">Value</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>0</td>
+<td>_EMPTY_</td>
+<td>leave empty</td>
+</tr>
+<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>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>_TOPIC_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>
+</div>
+<div class="section" id="emqp-scheduler">
+<h2>eMQP / Scheduler<a class="headerlink" href="#emqp-scheduler" title="Permalink to this headline">¶</a></h2>
+<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="9%" />
+<col width="20%" />
+<col width="71%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">FRAME</th>
+<th class="head">Value</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>0</td>
+<td>_EMPTY_</td>
+<td>leave empty</td>
+</tr>
+<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>INFORM</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>csv seperated names of queue the worker belongs to</td>
+</tr>
+<tr class="row-odd"><td>5</td>
+<td>scheduler</td>
+<td>type of peer connecting</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>
+<h2>eMQP / Worker<a class="headerlink" href="#emqp-worker" title="Permalink to this headline">¶</a></h2>
 <p>An <strong>INFORM</strong> command consists of a 5-frame multipart message, formatted as follows.</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -357,6 +487,10 @@
 <td>_QUEUE_NAME_</td>
 <td>csv seperated names of queue the worker belongs to</td>
 </tr>
+<tr class="row-odd"><td>5</td>
+<td>worker</td>
+<td>type of peer connecting</td>
+</tr>
 </tbody>
 </table>
 <p>A <strong>READY</strong> frame consists of a 4-frame multipart message, formatted as follows.</p>
@@ -497,20 +631,23 @@
 </table>
 </div>
 <div class="section" id="heartbeating">
-<h3>Heartbeating<a class="headerlink" href="#heartbeating" title="Permalink to this headline">¶</a></h3>
+<h2>Heartbeating<a class="headerlink" href="#heartbeating" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><ul class="simple">
 <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>Both worker and broker MUST send heartbeats at regular and agreed-upon intervals.</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>
 <li>If the worker detects that the broker disconnected it SHOULD restart the conversation.</li>
 <li>If the broker detects that a worker has disconnected it should stop sending it a message of any type.</li>
+<li>If the scheduler detects that the broker disconnects it SHOULD restart the conversation.</li>
+<li>If the broker detects that a scheduler has disconnected it should ??????????.</li>
 </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 requried, send an empty string MUST be sent where headers are required.</p>
+<h2>REQUEST Headers<a class="headerlink" href="#request-headers" title="Permalink to this headline">¶</a></h2>
+<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>
 <p>Below is a table which defines and describes the headers.</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -551,7 +688,6 @@
 </table>
 </div>
 </div>
-</div>
 
 
            </div>