aboutsummaryrefslogtreecommitdiffstats
path: root/_sources/protocol.txt
diff options
context:
space:
mode:
Diffstat (limited to '_sources/protocol.txt')
-rw-r--r--_sources/protocol.txt57
1 files changed, 52 insertions, 5 deletions
diff --git a/_sources/protocol.txt b/_sources/protocol.txt
index e468b06..ddbcfcc 100644
--- a/_sources/protocol.txt
+++ b/_sources/protocol.txt
@@ -1,4 +1,4 @@
1****************************** 1/****************************e
2EventMQ Protocol Specification 2EventMQ Protocol Specification
3****************************** 3******************************
4*The status of this document is alpha and subject to heavy change* 4*The status of this document is alpha and subject to heavy change*
@@ -86,10 +86,53 @@ FRAME Value Description
862 PUBLISH command 862 PUBLISH command
873 _MSGID_ A unique id for the msg 873 _MSGID_ A unique id for the msg
884 _TOPIC_NAME_ the name of the queue the worker belongs to 884 _TOPIC_NAME_ the name of the queue the worker belongs to
895 _HEADERS_ dictionary of headers. can be an empty set 895 _HEADERS_ csv list of headers
906 _MSG_ The message to send 906 _MSG_ The message to send
91====== ============== =========== 91====== ============== ===========
92 92
93A **SCHEDULE** command consists of a 7-frame multipart message, formatted as follows.
94
95====== ============== ===========
96FRAME Value Description
97====== ============== ===========
980 _EMPTY_ leave empty
991 eMQP/1.0 Protocol version
1002 SCHEDULE command
1013 _MSGID_ A unique id for the msg
1024 _TOPIC_NAME_ name of queue that the job should run in
1035 _HEADERS_ csv list of headers for this message
1046 _MSG_ The message to send
105====== ============== ===========
106
107An **UNSCHEDULE** command consists of a 7-frame multipart message, formatted as follows.
108
109====== ============== ===========
110FRAME Value Description
111====== ============== ===========
1120 _EMPTY_ leave empty
1131 eMQP/1.0 Protocol version
1142 UNSCHEDULE command
1153 _MSGID_ A unique id for the msg
1164 _TOPIC_NAME_ ignored for this command, broadcasted to all queues
1175 _HEADERS_ csv list of headers for this message
1186 _MSG_ The message to send
119====== ============== ===========
120
121eMQP / Scheduler
122----------------
123An **INFORM** command consists of a 6-frame multipart message, formatted as follows.
124
125====== ============== ===========
126FRAME Value Description
127====== ============== ===========
1280 _EMPTY_ leave empty
1291 eMQP/1.0 Protocol version
1302 INFORM command
1313 _MSGID_ A unique id for the msg
1324 _QUEUE_NAME_ csv seperated names of queue the worker belongs to
1335 scheduler type of peer connecting
134====== ============== ===========
135
93eMQP / Worker 136eMQP / Worker
94------------- 137-------------
95An **INFORM** command consists of a 5-frame multipart message, formatted as follows. 138An **INFORM** command consists of a 5-frame multipart message, formatted as follows.
@@ -102,6 +145,7 @@ FRAME Value Description
1022 INFORM command 1452 INFORM command
1033 _MSGID_ A unique id for the msg 1463 _MSGID_ A unique id for the msg
1044 _QUEUE_NAME_ csv seperated names of queue the worker belongs to 1474 _QUEUE_NAME_ csv seperated names of queue the worker belongs to
1485 worker type of peer connecting
105====== ============== =========== 149====== ============== ===========
106 150
107A **READY** frame consists of a 4-frame multipart message, formatted as follows. 151A **READY** frame consists of a 4-frame multipart message, formatted as follows.
@@ -154,13 +198,16 @@ Heartbeating
154------------ 198------------
155 * HEARTBEAT commands are valid at any time after an INFORM command 199 * 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. 200 * 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. 201 * Worker and broker MUST send heartbeats at regular and agreed-upon intervals.
202 * 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. 203 * 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. 204 * If the broker detects that a worker has disconnected it should stop sending it a message of any type.
205 * If the scheduler detects that the broker disconnects it SHOULD restart the conversation.
206 * If the broker detects that a scheduler has disconnected it should ??????????.
160 207
161Request Headers 208REQUEST Headers
162--------------- 209---------------
163Headers 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. 210Headers 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.
164 211
165Below is a table which defines and describes the headers. 212Below is a table which defines and describes the headers.
166 213