aboutsummaryrefslogtreecommitdiffstats
path: root/protocol.html
diff options
context:
space:
mode:
authorjason2015-11-20 11:42:18 -0700
committerjason2015-11-20 11:42:18 -0700
commitd4d1fe943380d087de3f0a54965d8dbb647b629c (patch)
treee3fa19815b5ee09fb09da0d38c7c156dbd8ea633 /protocol.html
parentc972be300c5d182ad2a229cabb3150b365acad6b (diff)
downloadeventmq-d4d1fe943380d087de3f0a54965d8dbb647b629c.tar.gz
eventmq-d4d1fe943380d087de3f0a54965d8dbb647b629c.zip
updates
Diffstat (limited to 'protocol.html')
-rw-r--r--protocol.html89
1 files changed, 88 insertions, 1 deletions
diff --git a/protocol.html b/protocol.html
index 6f003bd..1a8ee2c 100644
--- a/protocol.html
+++ b/protocol.html
@@ -94,6 +94,7 @@
94<li class="toctree-l4"><a class="reference internal" href="#emqp-client">eMQP / Client</a></li> 94<li class="toctree-l4"><a class="reference internal" href="#emqp-client">eMQP / Client</a></li>
95<li class="toctree-l4"><a class="reference internal" href="#emqp-worker">eMQP / Worker</a></li> 95<li class="toctree-l4"><a class="reference internal" href="#emqp-worker">eMQP / Worker</a></li>
96<li class="toctree-l4"><a class="reference internal" href="#heartbeating">Heartbeating</a></li> 96<li class="toctree-l4"><a class="reference internal" href="#heartbeating">Heartbeating</a></li>
97<li class="toctree-l4"><a class="reference internal" href="#request-headers">Request Headers</a></li>
97</ul> 98</ul>
98</li> 99</li>
99</ul> 100</ul>
@@ -189,7 +190,7 @@
189</div> 190</div>
190<div class="section" id="emqp-client"> 191<div class="section" id="emqp-client">
191<h3>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h3> 192<h3>eMQP / Client<a class="headerlink" href="#emqp-client" title="Permalink to this headline">¶</a></h3>
192<p>A <strong>REQUEST</strong> command consists of 7-frame multipart message, formatted as follows.</p> 193<p>A <strong>REQUEST</strong> command consists of a 7-frame multipart message, formatted as follows.</p>
193<table border="1" class="docutils"> 194<table border="1" class="docutils">
194<colgroup> 195<colgroup>
195<col width="10%" /> 196<col width="10%" />
@@ -233,6 +234,50 @@
233</tr> 234</tr>
234</tbody> 235</tbody>
235</table> 236</table>
237<p>A <strong>PUBLISH</strong> command consists of a 7-frame multipart messag, formatted as follows.</p>
238<table border="1" class="docutils">
239<colgroup>
240<col width="10%" />
241<col width="22%" />
242<col width="68%" />
243</colgroup>
244<thead valign="bottom">
245<tr class="row-odd"><th class="head">FRAME</th>
246<th class="head">Value</th>
247<th class="head">Description</th>
248</tr>
249</thead>
250<tbody valign="top">
251<tr class="row-even"><td>0</td>
252<td>_EMPTY_</td>
253<td>leave empty</td>
254</tr>
255<tr class="row-odd"><td>1</td>
256<td>eMQP/1.0</td>
257<td>Protocol version</td>
258</tr>
259<tr class="row-even"><td>2</td>
260<td>PUBLISH</td>
261<td>command</td>
262</tr>
263<tr class="row-odd"><td>3</td>
264<td>_MSGID_</td>
265<td>A unique id for the msg</td>
266</tr>
267<tr class="row-even"><td>4</td>
268<td>_TOPIC_NAME_</td>
269<td>the name of the queue the worker belongs to</td>
270</tr>
271<tr class="row-odd"><td>5</td>
272<td>_HEADERS_</td>
273<td>dictionary of headers. can be an empty set</td>
274</tr>
275<tr class="row-even"><td>6</td>
276<td>_MSG_</td>
277<td>The message to send</td>
278</tr>
279</tbody>
280</table>
236</div> 281</div>
237<div class="section" id="emqp-worker"> 282<div class="section" id="emqp-worker">
238<h3>eMQP / Worker<a class="headerlink" href="#emqp-worker" title="Permalink to this headline">¶</a></h3> 283<h3>eMQP / Worker<a class="headerlink" href="#emqp-worker" title="Permalink to this headline">¶</a></h3>
@@ -417,6 +462,48 @@
417</ul> 462</ul>
418</div></blockquote> 463</div></blockquote>
419</div> 464</div>
465<div class="section" id="request-headers">
466<h3>Request Headers<a class="headerlink" href="#request-headers" title="Permalink to this headline">¶</a></h3>
467<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>
468<p>Below is a table which defines and describes the headers.</p>
469<table border="1" class="docutils">
470<colgroup>
471<col width="9%" />
472<col width="4%" />
473<col width="4%" />
474<col width="4%" />
475<col width="78%" />
476</colgroup>
477<thead valign="bottom">
478<tr class="row-odd"><th class="head">Header</th>
479<th class="head">REQUEST</th>
480<th class="head">PUBLISH</th>
481<th class="head">Default</th>
482<th class="head">Description</th>
483</tr>
484</thead>
485<tbody valign="top">
486<tr class="row-even"><td>reply-requested</td>
487<td>X</td>
488<td>&nbsp;</td>
489<td>False</td>
490<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>
491</tr>
492<tr class="row-odd"><td>retry-count:#</td>
493<td>X</td>
494<td>&nbsp;</td>
495<td>0</td>
496<td>Retry a failed job this many times before accepting defeat.</td>
497</tr>
498<tr class="row-even"><td>guarentee</td>
499<td>X</td>
500<td>&nbsp;</td>
501<td>False</td>
502<td>Ensure the job completes by letting someone else worry about a success reply.</td>
503</tr>
504</tbody>
505</table>
506</div>
420</div> 507</div>
421</div> 508</div>
422 509