aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjason2015-11-20 11:42:18 -0700
committerjason2015-11-20 11:42:18 -0700
commitd4d1fe943380d087de3f0a54965d8dbb647b629c (patch)
treee3fa19815b5ee09fb09da0d38c7c156dbd8ea633
parentc972be300c5d182ad2a229cabb3150b365acad6b (diff)
downloadeventmq-d4d1fe943380d087de3f0a54965d8dbb647b629c.tar.gz
eventmq-d4d1fe943380d087de3f0a54965d8dbb647b629c.zip
updates
-rw-r--r--_sources/exceptions.txt1
-rw-r--r--_sources/protocol.txt30
-rw-r--r--contributing.html4
-rw-r--r--exceptions.html6
-rw-r--r--genindex.html10
-rw-r--r--objects.invbin589 -> 582 bytes
-rw-r--r--protocol.html89
-rw-r--r--receiver.html2
-rw-r--r--router.html12
-rw-r--r--searchindex.js2
-rw-r--r--utils.html8
11 files changed, 144 insertions, 20 deletions
diff --git a/_sources/exceptions.txt b/_sources/exceptions.txt
index 17a1cf9..04f9c5a 100644
--- a/_sources/exceptions.txt
+++ b/_sources/exceptions.txt
@@ -1,3 +1,2 @@
1.. automodule:: eventmq.exceptions 1.. automodule:: eventmq.exceptions
2 :members: 2 :members:
3 :special-members:
diff --git a/_sources/protocol.txt b/_sources/protocol.txt
index d9bd9e1..e4d5b7f 100644
--- a/_sources/protocol.txt
+++ b/_sources/protocol.txt
@@ -48,7 +48,7 @@ This extra frame is not shown in the specifications below.
48 48
49eMQP / Client 49eMQP / Client
50------------- 50-------------
51A **REQUEST** command consists of 7-frame multipart message, formatted as follows. 51A **REQUEST** command consists of a 7-frame multipart message, formatted as follows.
52 52
53====== ============== =========== 53====== ============== ===========
54FRAME Value Description 54FRAME Value Description
@@ -62,6 +62,20 @@ FRAME Value Description
626 _MSG_ The message to send 626 _MSG_ The message to send
63====== ============== =========== 63====== ============== ===========
64 64
65A **PUBLISH** command consists of a 7-frame multipart messag, formatted as follows.
66
67====== ============== ===========
68FRAME Value Description
69====== ============== ===========
700 _EMPTY_ leave empty
711 eMQP/1.0 Protocol version
722 PUBLISH command
733 _MSGID_ A unique id for the msg
744 _TOPIC_NAME_ the name of the queue the worker belongs to
755 _HEADERS_ dictionary of headers. can be an empty set
766 _MSG_ The message to send
77====== ============== ===========
78
65eMQP / Worker 79eMQP / Worker
66------------- 80-------------
67An **INFORM** command consists of a 5-frame multipart message, formatted as follows. 81An **INFORM** command consists of a 5-frame multipart message, formatted as follows.
@@ -128,3 +142,17 @@ Heartbeating
128 * Both worker and broker MUST send heartbeats at regular and agreed-upon intervals. 142 * Both worker and broker MUST send heartbeats at regular and agreed-upon intervals.
129 * If the worker detects that the broker disconnected it SHOULD restart the conversation. 143 * If the worker detects that the broker disconnected it SHOULD restart the conversation.
130 * If the broker detects that a worker has disconnected it should stop sending it a message of any type. 144 * If the broker detects that a worker has disconnected it should stop sending it a message of any type.
145
146Request Headers
147---------------
148Headers 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.
149
150Below is a table which defines and describes the headers.
151
152=============== ======= ======= ======= ===========
153Header REQUEST PUBLISH Default Description
154=============== ======= ======= ======= ===========
155reply-requested X False Once the job is finished, send a reply back with information from the job. If there is no information reply with a True value.
156retry-count:# X 0 Retry a failed job this many times before accepting defeat.
157guarentee X False Ensure the job completes by letting someone else worry about a success reply.
158=============== ======= ======= ======= ===========
diff --git a/contributing.html b/contributing.html
index e9cae5d..64899c6 100644
--- a/contributing.html
+++ b/contributing.html
@@ -32,7 +32,7 @@
32 32
33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
34 <link rel="next" title="EventMQ Protocol Specification" href="protocol.html"/> 34 <link rel="next" title="EventMQ Protocol Specification" href="protocol.html"/>
35 <link rel="prev" title="senderSender" href="sender.html"/> 35 <link rel="prev" title="exceptionsExceptions" href="exceptions.html"/>
36 36
37 37
38 <script src="_static/js/modernizr.min.js"></script> 38 <script src="_static/js/modernizr.min.js"></script>
@@ -150,7 +150,7 @@
150 <a href="protocol.html" class="btn btn-neutral float-right" title="EventMQ Protocol Specification" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 150 <a href="protocol.html" class="btn btn-neutral float-right" title="EventMQ Protocol Specification" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
151 151
152 152
153 <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 153 <a href="exceptions.html" class="btn btn-neutral" title="exceptions – Exceptions" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
154 154
155 </div> 155 </div>
156 156
diff --git a/exceptions.html b/exceptions.html
index cd2c165..aa5d33e 100644
--- a/exceptions.html
+++ b/exceptions.html
@@ -147,12 +147,6 @@ be subclasses of <a class="reference internal" href="#eventmq.exceptions.EventMQ
147<dt id="eventmq.exceptions.EventMQError"> 147<dt id="eventmq.exceptions.EventMQError">
148<em class="property">exception </em><code class="descclassname">eventmq.exceptions.</code><code class="descname">EventMQError</code><a class="headerlink" href="#eventmq.exceptions.EventMQError" title="Permalink to this definition">¶</a></dt> 148<em class="property">exception </em><code class="descclassname">eventmq.exceptions.</code><code class="descname">EventMQError</code><a class="headerlink" href="#eventmq.exceptions.EventMQError" title="Permalink to this definition">¶</a></dt>
149<dd><p>All exceptions raised by EventMQ inherit from this base exception</p> 149<dd><p>All exceptions raised by EventMQ inherit from this base exception</p>
150<dl class="attribute">
151<dt id="eventmq.exceptions.EventMQError.__weakref__">
152<code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.exceptions.EventMQError.__weakref__" title="Permalink to this definition">¶</a></dt>
153<dd><p>list of weak references to the object (if defined)</p>
154</dd></dl>
155
156</dd></dl> 150</dd></dl>
157 151
158<dl class="exception"> 152<dl class="exception">
diff --git a/genindex.html b/genindex.html
index 6e742cf..e8758cc 100644
--- a/genindex.html
+++ b/genindex.html
@@ -165,15 +165,11 @@
165 </dl></td> 165 </dl></td>
166 <td style="width: 33%" valign="top"><dl> 166 <td style="width: 33%" valign="top"><dl>
167 167
168 <dt><a href="exceptions.html#eventmq.exceptions.EventMQError.__weakref__">__weakref__ (eventmq.exceptions.EventMQError attribute)</a> 168 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.__weakref__">__weakref__ (eventmq.jobmanager.JobManager attribute)</a>
169 </dt> 169 </dt>
170 170
171 <dd><dl> 171 <dd><dl>
172 172
173 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.__weakref__">(eventmq.jobmanager.JobManager attribute)</a>
174 </dt>
175
176
177 <dt><a href="receiver.html#eventmq.receiver.Receiver.__weakref__">(eventmq.receiver.Receiver attribute)</a> 173 <dt><a href="receiver.html#eventmq.receiver.Receiver.__weakref__">(eventmq.receiver.Receiver attribute)</a>
178 </dt> 174 </dt>
179 175
@@ -317,6 +313,10 @@
317<table style="width: 100%" class="indextable genindextable"><tr> 313<table style="width: 100%" class="indextable genindextable"><tr>
318 <td style="width: 33%" valign="top"><dl> 314 <td style="width: 33%" valign="top"><dl>
319 315
316 <dt><a href="router.html#eventmq.router.Router.on_inform">on_inform() (eventmq.router.Router method)</a>
317 </dt>
318
319
320 <dt><a href="router.html#eventmq.router.Router.on_receive_reply">on_receive_reply() (eventmq.router.Router method)</a> 320 <dt><a href="router.html#eventmq.router.Router.on_receive_reply">on_receive_reply() (eventmq.router.Router method)</a>
321 </dt> 321 </dt>
322 322
diff --git a/objects.inv b/objects.inv
index 17ca09c..3e7aa03 100644
--- a/objects.inv
+++ b/objects.inv
Binary files differ
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
diff --git a/receiver.html b/receiver.html
index 038c890..48e0cb1 100644
--- a/receiver.html
+++ b/receiver.html
@@ -88,6 +88,8 @@
88<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 88<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
89<li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 89<li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
90<li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 90<li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
91<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
92<li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
91</ul> 93</ul>
92</li> 94</li>
93<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li> 95<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
diff --git a/router.html b/router.html
index d8c7fe1..c785743 100644
--- a/router.html
+++ b/router.html
@@ -84,10 +84,12 @@
84 84
85 <ul class="current"> 85 <ul class="current">
86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> 86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
87<li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
87<li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 88<li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
88<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 89<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
89<li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 90<li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
90<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li> 91<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
92<li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
91</ul> 93</ul>
92</li> 94</li>
93<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li> 95<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
@@ -152,11 +154,21 @@
152</dd></dl> 154</dd></dl>
153 155
154<dl class="method"> 156<dl class="method">
157<dt id="eventmq.router.Router.on_inform">
158<code class="descname">on_inform</code><span class="sig-paren">(</span><em>sender</em>, <em>msg_id</em>, <em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_inform" title="Permalink to this definition">¶</a></dt>
159<dd><p>Handles a new worker coming online</p>
160</dd></dl>
161
162<dl class="method">
155<dt id="eventmq.router.Router.on_receive_reply"> 163<dt id="eventmq.router.Router.on_receive_reply">
156<code class="descname">on_receive_reply</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_receive_reply" title="Permalink to this definition">¶</a></dt> 164<code class="descname">on_receive_reply</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_receive_reply" title="Permalink to this definition">¶</a></dt>
157<dd><p>This method is called when a message comes in from the worker socket. 165<dd><p>This method is called when a message comes in from the worker socket.
158It then calls <cite>on_command</cite>. If <cite>on_command</cite> isn&#8217;t found, then a warning 166It then calls <cite>on_command</cite>. If <cite>on_command</cite> isn&#8217;t found, then a warning
159is created.</p> 167is created.</p>
168<dl class="docutils">
169<dt>def on_inform(msg):</dt>
170<dd>pass</dd>
171</dl>
160</dd></dl> 172</dd></dl>
161 173
162<dl class="method"> 174<dl class="method">
diff --git a/searchindex.js b/searchindex.js
index 568632a..83ca10c 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
Search.setIndex({envversion:46,filenames:["api","contributing","exceptions","index","jobmanager","protocol","receiver","router","sender","utils"],objects:{"eventmq.exceptions":{EventMQError:[2,5,1,""],InvalidMessageError:[2,5,1,""],MessageError:[2,5,1,""]},"eventmq.exceptions.EventMQError":{"__weakref__":[2,1,1,""]},"eventmq.jobmanager":{JobManager:[4,3,1,""]},"eventmq.jobmanager.JobManager":{"__init__":[4,2,1,""],"__weakref__":[4,1,1,""],send_inform:[4,2,1,""],send_message:[4,2,1,""],start:[4,2,1,""]},"eventmq.receiver":{Receiver:[6,3,1,""]},"eventmq.receiver.Receiver":{"__init__":[6,2,1,""],"__weakref__":[6,1,1,""],connect:[6,2,1,""],listen:[6,2,1,""],name:[6,1,1,""],ready:[6,1,1,""],zcontext:[6,1,1,""],zsocket:[6,1,1,""]},"eventmq.router":{Router:[7,3,1,""]},"eventmq.router.Router":{"__weakref__":[7,1,1,""],on_receive_reply:[7,2,1,""],on_receive_request:[7,2,1,""],start:[7,2,1,""]},"eventmq.sender":{Sender:[8,3,1,""]},"eventmq.sender.Sender":{"__init__":[8,2,1,""],"__weakref__":[8,1,1,""],connect:[8,2,1,""],listen:[8,2,1,""],name:[8,1,1,""],ready:[8,1,1,""],recv:[8,2,1,""],recv_multipart:[8,2,1,""],send:[8,2,1,""],send_multipart:[8,2,1,""],zsocket:[8,1,1,""]},"eventmq.utils":{generate_msgid:[9,4,1,""],parse_message:[9,4,1,""]},eventmq:{exceptions:[2,0,0,"-"],jobmanager:[4,0,0,"-"],receiver:[6,0,0,"-"],router:[7,0,0,"-"],sender:[8,0,0,"-"],utils:[9,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","function","Python function"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:class","4":"py:function","5":"py:exception"},terms:{"0mq":[5,8],"__init__":[4,6,8],"__weakref__":[2,4,6,7,8],"_empty_":5,"_headers_":5,"_msg_":5,"_msgid_":5,"_queue_name_":5,"abstract":5,"case":5,"class":[4,6,7,8,9],"default":[4,6,8],"function":[6,7],"public":5,"return":[4,6,8,9],"true":[6,8],"while":5,about:4,accept:5,act:5,actual:4,addr:[4,6,8],address:[],after:5,agre:5,all:[2,4,5,6,8],allow:5,alpha:5,and_data:9,ani:5,api:[],applic:5,architectur:[],arg:[4,6,7,8],automat:8,avail:[6,8],backend_addr:7,base:2,basi:5,befor:5,begin:[4,7],belong:5,below:5,between:5,bool:[6,8],both:5,broker:5,build:8,built:5,bulid:6,call:[6,7],callabl:6,can:5,chang:5,check:[6,8],client:[],come:7,command:[4,5,9],compon:5,connction:[6,8],connect:[4,5,6,7,8],consist:5,contain:[5,9],content:[],context:[6,8],convers:5,convienc:8,creat:[6,7,8,9],csv:5,current:[6,8],deal:9,dealer:8,debug:5,defin:[2,4,5,6,7,8],deliv:5,describ:5,descript:5,detail:5,detect:5,determin:5,dialog:5,dictionari:5,directli:8,disconnect:5,distribut:5,either:5,empti:5,emqp:[],encount:2,end:8,ensur:4,even:5,eventloop:[4,6,7,8],eventmqerror:2,except:[0,5,6,8],execut:5,explicitli:8,expos:4,extra:5,fair:5,fals:[6,8],first:5,fit:5,follow:5,format:[5,9],found:7,foundat:5,frame:[4,5,8],free:5,from:[2,5,7],frontend_addr:7,gener:[4,5,6,8,9],generate_msgid:9,gnu:5,goal:[],good:8,hand:9,handl:5,have:9,header:5,heartbeat:[],heavi:5,here:5,hope:5,html:5,http:5,ident:[5,8],ietf:5,implement:5,impli:5,includ:5,incom:4,index:3,inform:[4,5],inherit:2,insert:[5,8],instanc:4,interpret:5,interv:5,invalidmessageerror:2,isn:7,issu:5,job:[],jobmanag:[],kei:5,kwarg:[4,6,7,8],languag:[],later:5,least:5,leav:5,licens:[],like:[8,9],list:[2,4,6,7,8],listen:[4,6,7,8],look:8,mai:[5,8],main:4,make:9,malform:2,manag:[],manual:5,master:5,merchant:5,messag:[2,4,5,6,7,8,9],message_bodi:9,message_id:9,messageerror:2,method:[6,7],mode:6,modifi:5,modul:[3,9],more:[5,9],msg:[4,5,7],multipart:[5,8],must:5,name:[4,5,6,7,8],none:[6,8],note:[4,6,8],object:[2,4,6,7,8],on_command:7,on_receive_repli:7,on_receive_request:7,on_recv:6,onli:[6,8],option:[4,5,6,8],org:5,orient:5,origin:5,other:5,otherwis:[4,6,8],page:3,param:4,paramet:[4,6,7,8,9],pars:9,parse_messag:9,part:[5,9],particular:[5,8],pass:[5,6],peer:5,pictur:5,poll:[6,8],pool:5,portion:4,practic:8,prepend:5,pretti:5,problem:2,process:5,properti:[6,8],protocol:[],protocol_vers:8,provid:7,pub:5,publish:5,purpos:5,queue:[5,7],rais:[2,4,6,8],raw:8,raw_messag:[],readi:[5,6,8],receiv:[],recent:5,reciev:6,recommend:5,recv:8,recv_multipart:8,redistribut:5,refer:[2,4,6,7,8],regular:5,reliabl:5,remov:5,rep:6,repli:5,req:8,request:[4,5,7],requir:[5,6],resourc:[4,5],respond:5,respons:[4,6,8],restart:5,rfc2119:5,rfc:5,robin:5,round:5,rout:[5,7],router:[],run:4,search:3,see:5,self:4,send:[4,5,8],send_inform:4,send_messag:4,send_multipart:8,send_raw:[],sender:[],sender_id:9,sent:8,seper:5,serv:5,server:[4,5],servic:5,set:[5,6,8],shall:5,should:[2,5,6,8],shown:5,simpl:[7,9],singl:5,skip:[6,8],skip_zmqstream:[6,8],socket:[5,6,7,8],softwar:5,some:8,someth:8,spawn:4,specif:[],specifi:[5,8],start:[4,6,7,8],statu:5,stop:5,str:[4,6,7,8],string:[4,6,7,8],structur:2,sub:5,subclass:2,subject:5,subset:5,task:4,tcp:[4,7],term:5,them:6,thi:[2,4,5,6,7,8,9],thing:[4,9],through:5,time:5,tool:5,topic:[],topolog:[],tornado:[4,7],trace:5,tupl:[4,8,9],type:[5,6,8],typeerror:6,under:5,uniqu:[4,5,9],univers:9,unless:[4,6,8],unus:6,upon:5,uuid:[4,6,8],valid:5,valu:5,version:[5,8],via:[6,8],warn:7,warranti:5,weak:[2,4,6,7,8],web:5,well:5,when:[2,5,6,7,8],where:5,wish:9,without:5,word:5,worker:[],wrap:[6,8],you:[5,8,9],your:[5,8],zcontext:[6,8],zeromq:5,zmq:[5,6,8],zmqstream:[6,8],zsocket:[6,8]},titles:["API Documentation","Contributing to EventMQ","<code class=\"docutils literal\"><span class=\"pre\">exceptions</span></code> &#8211; Exceptions","EventMQ Documentation","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> &#8211; Job Manager","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> &#8211; Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> &#8211; Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> &#8211; Sender","<code class=\"docutils literal\"><span class=\"pre\">utils</span></code> &#8211; Utilities"],titleterms:{address:5,api:0,architectur:5,client:5,contribut:1,document:[0,3],emqp:5,eventmq:[1,3,5],except:2,goal:5,heartbeat:5,indic:3,job:4,jobmanag:4,languag:5,licens:5,manag:4,protocol:5,receiv:6,router:[5,7],sender:8,specif:5,tabl:3,topolog:5,util:9,welcom:[],worker:5}}) \ No newline at end of file Search.setIndex({envversion:46,filenames:["api","contributing","exceptions","index","jobmanager","protocol","receiver","router","sender","utils"],objects:{"eventmq.exceptions":{EventMQError:[2,5,1,""],InvalidMessageError:[2,5,1,""],MessageError:[2,5,1,""]},"eventmq.jobmanager":{JobManager:[4,4,1,""]},"eventmq.jobmanager.JobManager":{"__init__":[4,2,1,""],"__weakref__":[4,1,1,""],send_inform:[4,2,1,""],send_message:[4,2,1,""],start:[4,2,1,""]},"eventmq.receiver":{Receiver:[6,4,1,""]},"eventmq.receiver.Receiver":{"__init__":[6,2,1,""],"__weakref__":[6,1,1,""],connect:[6,2,1,""],listen:[6,2,1,""],name:[6,1,1,""],ready:[6,1,1,""],zcontext:[6,1,1,""],zsocket:[6,1,1,""]},"eventmq.router":{Router:[7,4,1,""]},"eventmq.router.Router":{"__weakref__":[7,1,1,""],on_inform:[7,2,1,""],on_receive_reply:[7,2,1,""],on_receive_request:[7,2,1,""],start:[7,2,1,""]},"eventmq.sender":{Sender:[8,4,1,""]},"eventmq.sender.Sender":{"__init__":[8,2,1,""],"__weakref__":[8,1,1,""],connect:[8,2,1,""],listen:[8,2,1,""],name:[8,1,1,""],ready:[8,1,1,""],recv:[8,2,1,""],recv_multipart:[8,2,1,""],send:[8,2,1,""],send_multipart:[8,2,1,""],zsocket:[8,1,1,""]},"eventmq.utils":{generate_msgid:[9,3,1,""],parse_message:[9,3,1,""]},eventmq:{exceptions:[2,0,0,"-"],jobmanager:[4,0,0,"-"],receiver:[6,0,0,"-"],router:[7,0,0,"-"],sender:[8,0,0,"-"],utils:[9,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","function","Python function"],"4":["py","class","Python class"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:function","4":"py:class","5":"py:exception"},terms:{"0mq":[5,8],"__init__":[4,6,8],"__weakref__":[4,6,7,8],"_empty_":5,"_headers_":5,"_msg_":5,"_msgid_":5,"_queue_name_":5,"_topic_name_":5,"abstract":5,"case":5,"class":[4,6,7,8,9],"default":[4,5,6,8],"function":[6,7],"new":7,"public":5,"return":[4,6,8,9],"true":[5,6,8],"while":5,about:[4,5],accept:5,act:5,actual:4,addr:[4,6,8],address:[],after:5,agre:5,all:[2,4,5,6,8],allow:5,alpha:5,and_data:9,ani:5,api:[],applic:5,architectur:[],arg:[4,6,7,8],automat:8,avail:[6,8],back:5,backend_addr:7,base:2,basi:5,befor:5,begin:[4,7],belong:5,below:5,between:5,bool:[6,8],both:5,broker:5,build:8,built:5,bulid:6,call:[6,7],callabl:6,can:5,chang:5,check:[6,8],client:[],come:7,comma:5,command:[4,5,9],complet:5,compon:5,connction:[6,8],connect:[4,5,6,7,8],consist:5,contain:[5,9],content:[],context:[6,8],convers:5,convienc:8,count:5,creat:[6,7,8,9],csv:5,current:[6,8],deal:9,dealer:8,debug:5,def:7,defeat:5,defin:[4,5,6,7,8],deliv:5,describ:5,descript:5,detail:5,detect:5,determin:5,dialog:5,dictionari:5,directli:8,disconnect:5,distribut:5,either:5,els:5,empti:5,emqp:[],encount:2,end:8,ensur:[4,5],even:5,eventloop:[4,6,7,8],eventmqerror:2,except:8,execut:5,explicitli:8,expos:4,extra:5,fail:5,fair:5,fals:[5,6,8],field:5,finish:5,first:5,fit:5,follow:5,format:[5,9],found:7,foundat:5,frame:[4,5,8],free:5,from:[2,5,7],frontend_addr:7,gener:[4,5,6,8,9],generate_msgid:9,gnu:5,goal:[],good:8,guarente:5,hand:9,handl:[5,7],have:9,header:[],heartbeat:[],heavi:5,here:5,hope:5,html:5,http:5,ident:[5,8],ietf:5,implement:5,impli:5,includ:5,incom:4,index:3,inform:[4,5],inherit:2,insert:[5,8],instanc:4,interpret:5,interv:5,invalidmessageerror:2,isn:7,issu:5,job:[],jobmanag:[],kei:5,kwarg:[4,6,7,8],languag:[],later:5,least:5,leav:5,let:5,licens:[],like:[8,9],list:[4,6,7,8],listen:[4,6,7,8],look:8,mai:[5,8],main:4,make:9,malform:2,manag:[],mani:5,manual:5,master:5,merchant:5,messag:[2,4,5,6,7,8,9],message_bodi:9,message_id:9,messageerror:2,method:[6,7],mode:6,modifi:5,modul:[3,9],more:[5,9],msg:[4,5,7],msg_id:7,multipart:[5,8],must:5,name:[4,5,6,7,8],none:[6,8],note:[4,6,8],object:[4,6,7,8],on_command:7,on_inform:7,on_receive_repli:7,on_receive_request:7,on_recv:6,onc:5,onli:[6,8],onlin:7,option:[4,5,6,8],org:5,orient:5,origin:5,other:5,otherwis:[4,6,8],page:3,param:4,paramet:[4,6,7,8,9],pars:9,parse_messag:9,part:[5,9],particular:[5,8],pass:[5,6,7],peer:5,pictur:5,poll:[6,8],pool:5,portion:4,practic:8,prefix:9,prepend:5,pretti:5,problem:2,process:5,properti:[6,8],protocol:[],protocol_vers:8,provid:7,pub:5,publish:5,purpos:5,queue:[5,7],rais:[2,4,6,8],raw:8,raw_messag:[],readi:[5,6,8],receiv:[],recent:5,reciev:6,recommend:5,recv:8,recv_multipart:8,redistribut:5,refer:[4,6,7,8],regular:5,reliabl:5,remov:5,rep:6,repli:5,req:8,request:[4,7],requir:[5,6],requri:5,resourc:[4,5],respond:5,respons:[4,6,8],restart:5,retri:5,rfc2119:5,rfc:5,robin:5,round:5,rout:[5,7],router:[],run:4,search:3,see:5,self:4,send:[4,5,8],send_inform:4,send_messag:4,send_multipart:8,send_raw:[],sender:[],sender_id:9,sent:[5,8],seper:5,serv:5,server:[4,5],servic:5,set:[5,6,8],shall:5,should:[2,5,6,8],shown:5,simpl:[7,9],singl:5,skip:[6,8],skip_zmqstream:[6,8],socket:[5,6,7,8],softwar:5,some:8,someon:5,someth:8,spawn:4,specif:[],specifi:[5,8],start:[4,6,7,8],statu:5,stop:5,str:[4,6,7,8],string:[4,5,6,7,8],structur:2,sub:5,subclass:2,subject:5,subset:5,success:5,task:4,tcp:[4,7],term:5,them:6,thi:[2,4,5,6,7,8,9],thing:[4,9],through:5,time:5,tool:5,topic:[],topolog:[],tornado:[4,7],trace:5,tupl:[4,8,9],type:[5,6,8],typeerror:6,under:5,uniqu:[4,5,9],univers:9,unless:[4,6,8],unus:6,upon:5,uuid:[4,6,8],valid:5,valu:5,version:[5,8],via:[6,8],warn:7,warranti:5,weak:[4,6,7,8],web:5,well:5,when:[2,5,6,7,8],where:5,which:5,wish:9,without:5,word:5,worker:[],worri:5,wrap:[6,8],you:[5,8,9],your:[5,8],zcontext:[6,8],zeromq:5,zmq:[5,6,8],zmqstream:[6,8],zsocket:[6,8]},titles:["API Documentation","Contributing to EventMQ","<code class=\"docutils literal\"><span class=\"pre\">exceptions</span></code> &#8211; Exceptions","EventMQ Documentation","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> &#8211; Job Manager","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> &#8211; Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> &#8211; Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> &#8211; Sender","<code class=\"docutils literal\"><span class=\"pre\">utils</span></code> &#8211; Utilities"],titleterms:{address:5,api:0,architectur:5,client:5,contribut:1,document:[0,3],emqp:5,eventmq:[1,3,5],except:2,goal:5,header:5,heartbeat:5,indic:3,job:4,jobmanag:4,languag:5,licens:5,manag:4,protocol:5,receiv:6,request:5,router:[5,7],sender:8,specif:5,tabl:3,topolog:5,util:9,welcom:[],worker:5}}) \ No newline at end of file
diff --git a/utils.html b/utils.html
index f115675..409f006 100644
--- a/utils.html
+++ b/utils.html
@@ -32,7 +32,7 @@
32 32
33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
34 <link rel="up" title="API Documentation" href="api.html"/> 34 <link rel="up" title="API Documentation" href="api.html"/>
35 <link rel="next" title="&lt;no title&gt;" href="exceptions.html"/> 35 <link rel="next" title="exceptions – Exceptions" href="exceptions.html"/>
36 <link rel="prev" title="sender – Sender" href="sender.html"/> 36 <link rel="prev" title="sender – Sender" href="sender.html"/>
37 37
38 38
@@ -86,8 +86,10 @@
86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> 86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
87<li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 87<li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
88<li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 88<li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
89<li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
89<li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 90<li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
90<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li> 91<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
92<li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
91</ul> 93</ul>
92</li> 94</li>
93<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li> 95<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
@@ -143,7 +145,7 @@
143like creating message more simple.</p> 145like creating message more simple.</p>
144<dl class="function"> 146<dl class="function">
145<dt id="eventmq.utils.generate_msgid"> 147<dt id="eventmq.utils.generate_msgid">
146<code class="descclassname">eventmq.utils.</code><code class="descname">generate_msgid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.generate_msgid" title="Permalink to this definition">¶</a></dt> 148<code class="descclassname">eventmq.utils.</code><code class="descname">generate_msgid</code><span class="sig-paren">(</span><em>prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.generate_msgid" title="Permalink to this definition">¶</a></dt>
147<dd><p>Returns a (universally) unique id to be used for messages</p> 149<dd><p>Returns a (universally) unique id to be used for messages</p>
148</dd></dl> 150</dd></dl>
149 151
@@ -172,7 +174,7 @@ parts.</p>
172 174
173 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 175 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
174 176
175 <a href="exceptions.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 177 <a href="exceptions.html" class="btn btn-neutral float-right" title="exceptions – Exceptions" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
176 178
177 179
178 <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 180 <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>