diff options
| author | jason | 2015-12-29 22:41:35 -0700 |
|---|---|---|
| committer | jason | 2016-01-04 18:08:09 -0700 |
| commit | cf6ad6ca37512fca27a9376decf64bf8fb78549f (patch) | |
| tree | e593c60c5413462f74cb8659182ad19aa086c934 /docs | |
| parent | 9f3dca999368473d3bb084b82661e07efee2736c (diff) | |
| download | eventmq-cf6ad6ca37512fca27a9376decf64bf8fb78549f.tar.gz eventmq-cf6ad6ca37512fca27a9376decf64bf8fb78549f.zip | |
Work on the scheduler
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/protocol.rst | 36 |
1 files changed, 34 insertions, 2 deletions
diff --git a/docs/protocol.rst b/docs/protocol.rst index e468b06..a0ab6be 100644 --- a/docs/protocol.rst +++ b/docs/protocol.rst | |||
| @@ -90,6 +90,34 @@ FRAME Value Description | |||
| 90 | 6 _MSG_ The message to send | 90 | 6 _MSG_ The message to send |
| 91 | ====== ============== =========== | 91 | ====== ============== =========== |
| 92 | 92 | ||
| 93 | A **SCHEDULE** command consists of a 7-frame multipart message, formatted as follows. | ||
| 94 | |||
| 95 | ====== ============== =========== | ||
| 96 | FRAME Value Description | ||
| 97 | ====== ============== =========== | ||
| 98 | 0 _EMPTY_ leave empty | ||
| 99 | 1 eMQP/1.0 Protocol version | ||
| 100 | 2 SCHEDULE command | ||
| 101 | 3 _MSGID_ A unique id for the msg | ||
| 102 | 4 _QUEUE_NAME_ csv seperated names of queue the worker belongs to | ||
| 103 | 5 _MSG_ The message to send | ||
| 104 | ====== ============== =========== | ||
| 105 | |||
| 106 | eMQP / Scheduler | ||
| 107 | ---------------- | ||
| 108 | An **INFORM** command consists of a 6-frame multipart message, formatted as follows. | ||
| 109 | |||
| 110 | ====== ============== =========== | ||
| 111 | FRAME Value Description | ||
| 112 | ====== ============== =========== | ||
| 113 | 0 _EMPTY_ leave empty | ||
| 114 | 1 eMQP/1.0 Protocol version | ||
| 115 | 2 INFORM command | ||
| 116 | 3 _MSGID_ A unique id for the msg | ||
| 117 | 4 _QUEUE_NAME_ csv seperated names of queue the worker belongs to | ||
| 118 | 5 scheduler type of peer connecting | ||
| 119 | ====== ============== =========== | ||
| 120 | |||
| 93 | eMQP / Worker | 121 | eMQP / Worker |
| 94 | ------------- | 122 | ------------- |
| 95 | An **INFORM** command consists of a 5-frame multipart message, formatted as follows. | 123 | An **INFORM** command consists of a 5-frame multipart message, formatted as follows. |
| @@ -102,6 +130,7 @@ FRAME Value Description | |||
| 102 | 2 INFORM command | 130 | 2 INFORM command |
| 103 | 3 _MSGID_ A unique id for the msg | 131 | 3 _MSGID_ A unique id for the msg |
| 104 | 4 _QUEUE_NAME_ csv seperated names of queue the worker belongs to | 132 | 4 _QUEUE_NAME_ csv seperated names of queue the worker belongs to |
| 133 | 5 worker type of peer connecting | ||
| 105 | ====== ============== =========== | 134 | ====== ============== =========== |
| 106 | 135 | ||
| 107 | A **READY** frame consists of a 4-frame multipart message, formatted as follows. | 136 | A **READY** frame consists of a 4-frame multipart message, formatted as follows. |
| @@ -154,11 +183,14 @@ Heartbeating | |||
| 154 | ------------ | 183 | ------------ |
| 155 | * HEARTBEAT commands are valid at any time after an INFORM command | 184 | * HEARTBEAT commands are valid at any time after an INFORM command |
| 156 | * Any command except DISCONNECT act as a heartbeat. Peers SHOULD NOT send HEARTBEAT commands while sending other commands. | 185 | * Any command except DISCONNECT act as a heartbeat. Peers SHOULD NOT send HEARTBEAT commands while sending other commands. |
| 157 | * Both worker and broker MUST send heartbeats at regular and agreed-upon intervals. | 186 | * Worker and broker MUST send heartbeats at regular and agreed-upon intervals. |
| 187 | * Scheduler and broker MUST send heartbeats at regular and agreed-upon intervals. | ||
| 158 | * If the worker detects that the broker disconnected it SHOULD restart the conversation. | 188 | * If the worker detects that the broker disconnected it SHOULD restart the conversation. |
| 159 | * If the broker detects that a worker has disconnected it should stop sending it a message of any type. | 189 | * If the broker detects that a worker has disconnected it should stop sending it a message of any type. |
| 190 | * If the scheduler detects that the broker disconnects it SHOULD restart the conversation. | ||
| 191 | * If the broker detects that a scheduler has disconnected it should ??????????. | ||
| 160 | 192 | ||
| 161 | Request Headers | 193 | REQUEST Headers |
| 162 | --------------- | 194 | --------------- |
| 163 | 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. | 195 | 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. |
| 164 | 196 | ||