Stub of emq-cli

- starts emq-cli and implements status for the router

1 files changed, 62 insertions, 39 deletions

diff --git a/docs/protocol.rst b/docs/protocol.rst
index bf400cc..44544d6 100644
--- a/docs/protocol.rst
+++ b/docs/protocol.rst
@@ -5,12 +5,12 @@ EventMQ Protocol Specification
 
 Goals
 =====
-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
+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.
 
 The goals are to:
 
  * Specify a protocol to follow when implementing a component to EventMQ.
- * Allow requests to be routed to workers by an abstracted service name.
+ * Allow requests to be routed to workers by an abstracted service name (named queues).
  * Detect disconnected peers through heartbeating.
  * Allow for message tracing and debugging.
 
@@ -60,6 +60,52 @@ FRAME  Value          Description
 4      _MSGID_        The message id of the message this ACK is acknowledging
 ====== ============== ===========
 
+A **REPLY** frame consists of a 5-frame multipart message, formatted as follows.
+
+====== ============== ===========
+FRAME  Value          Description
+====== ============== ===========
+0      _EMPTY_        leave empty
+1      eMQP/1.0       Protocol version
+2      REPLY          command
+3      _MSGID_        A unique id for the msg
+4      _MSG_          The reply to respond with
+====== ============== ===========
+
+A **HEARTBEAT** frame consists of a
+
+====== ============== ===========
+FRAME  Value          Description
+====== ============== ===========
+0      _EMPTY_        leave empty
+1      eMQP/1.0       Protocol version
+2      HEARTBEAT      command
+3      _MSGID_        A unique id for the msg
+4      _UNIX_TS_      A unix timestamp
+====== ============== ===========
+
+A **DISCONNECT** frame consists of
+
+====== ============== ===========
+FRAME  Value          Description
+====== ============== ===========
+0      _EMPTY_        leave empty
+1      eMQP/1.0       Protocol version
+2      DISCONNECT     command
+3      _MSGID_        A unique id for the msg
+====== ============== ===========
+
+A **KBAI** frame consists of
+
+====== ============== ===========
+FRAME  Value          Description
+====== ============== ===========
+0      _EMPTY_        leave empty
+1      eMQP/1.0       Protocol version
+2      KBAI           command
+3      _MSGID_        A unique id for the msg
+====== ============== ===========
+
 eMQP / Client
 -------------
 A **REQUEST** command consists of a 7-frame multipart message, formatted as follows.
@@ -159,44 +205,9 @@ FRAME  Value          Description
 3      _MSGID_        A unique id for the msg
 ====== ============== ===========
 
-A **REPLY** frame consists of a 5-frame multipart message, formatted as follows.
-
-====== ============== ===========
-FRAME  Value          Description
-====== ============== ===========
-0      _EMPTY_        leave empty
-1      eMQP/1.0       Protocol version
-2      REPLY          command
-3      _MSGID_        A unique id for the msg
-4      _MSG_          The reply to respond with
-====== ============== ===========
-
-A **HEARTBEAT** frame consists of a
-
-====== ============== ===========
-FRAME  Value          Description
-====== ============== ===========
-0      _EMPTY_        leave empty
-1      eMQP/1.0       Protocol version
-2      HEARTBEAT      command
-3      _MSGID_        A unique id for the msg
-4      _UNIX_TS_      A unix timestamp
-====== ============== ===========
-
-A **DISCONNECT** frame consists of
-
-====== ============== ===========
-FRAME  Value          Description
-====== ============== ===========
-0      _EMPTY_        leave empty
-1      eMQP/1.0       Protocol version
-2      DISCONNECT     command
-3      _MSGID_        A unique id for the msg
-====== ============== ===========
-
 Heartbeating
 ------------
- * HEARTBEAT commands are valid at any time after an INFORM command
+ * HEARTBEAT commands are valid at any time after an INFORM command.
  * Any command except DISCONNECT act as a heartbeat. Peers SHOULD NOT send HEARTBEAT commands while sending other commands.
  * Worker and broker MUST send heartbeats at regular and agreed-upon intervals.
  * Scheduler and broker MUST send heartbeats at regular and agreed-upon intervals.
@@ -206,10 +217,11 @@ Heartbeating
 
 Headers
 ---------------
-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.
+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.
 
 Below is a table which defines and describes the headers.
 
+
 ================= ======= ======= ======== ======= ===========
 Header            REQUEST PUBLISH SCHEDULE Default Description
 ================= ======= ======= ======== ======= ===========
@@ -218,3 +230,14 @@ retry-count:#     X                        0       Retry a failed job this many
 guarantee         X                        False   Ensure the job completes by letting someone else worry about a success reply.
 nohaste                           X        False   When scheduling a job, set this to True if you don't want the job to run immediately as it's scheduled.  Instead, it will run for the first time when the interval has elapsed.
 ================= ======= ======= ======== ======= ===========
+
+DISCONNECT and KBAI
+===================
+When a component receives a DISCONNECT command it:
+ * MUST send a KBAI command to all connected components.
+ * MUST stop sending and receiving any messages
+ * MUST allow any pending messages or jobs to complete.
+
+When a component receives a KBAI command it:
+ * MUST stop sending any messages to the disconnecting component.
+ * SHOULD Clean up references to the disconnecting component.